Yandex Cloud Marketplace License Manager for SaaS, REST: Lock.Ensure
Checks if the she specified subscription is already locked to the specified resource.
If it is not locked, locks the subscription to the resource.
HTTP request
POST https://marketplace.api.cloud.yandex.net/marketplace/license-manager/saas/v1/locks/ensure
Body parameters
{
"instanceToken": "string",
"resourceId": "string"
}
Field |
Description |
instanceToken |
string Required field. Signed JWT token which contains information about subscription. |
resourceId |
string Required field. ID of the resource to which the subscription will be locked. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"lockId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"instanceId": "string",
"resourceId": "string",
"startTime": "string",
"endTime": "string",
"createdAt": "string",
"updatedAt": "string",
"state": "string",
"templateId": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
EnsureLockMetadata
Field |
Description |
lockId |
string ID of the subscription lock. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Lock
Field |
Description |
id |
string ID of the subscription lock. |
instanceId |
string ID of the subscription instance. |
resourceId |
string ID of the resource. |
startTime |
string (date-time) Timestamp of the start of the subscription lock. String in RFC3339 To work with values in this field, use the APIs described in the |
endTime |
string (date-time) Timestamp of the end of the subscription lock. String in RFC3339 To work with values in this field, use the APIs described in the |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Update timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
state |
enum (State) Subscription lock state.
|
templateId |
string ID of the subscription template. |