Yandex Cloud Marketplace License Manager for SaaS, REST: Lock.Get
Returns the specified subscription lock.
HTTP request
GET https://marketplace.api.cloud.yandex.net/marketplace/license-manager/saas/v1/locks/{lockId}
Path parameters
|
Field |
Description |
|
lockId |
string Required field. ID of the subscription lock. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"instanceId": "string",
"resourceId": "string",
"startTime": "string",
"endTime": "string",
"createdAt": "string",
"updatedAt": "string",
"state": "string",
"templateId": "string",
"externalInstance": {
"name": "string",
"properties": "object",
// Includes only one of the fields `subscription`, `license`
"subscription": {
"subscriptionId": "string",
"licenseId": "string",
"activationKey": "string"
},
"license": {
"licenseId": "string",
"payload": "string"
}
// end of the list of possible fields
},
"instanceProlongation": "boolean"
}
|
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 text format. The range of possible values is from 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 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Update timestamp. String in RFC3339 text format. The range of possible values is from 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. |
|
externalInstance |
External subscription instance (optional), for usage convenience propagated |
|
instanceProlongation |
boolean Indicates whether the subscription lock can be automatically prolonged/renewed. |
ExternalInstance
ExternalInstance attachment to external service subscription.
|
Field |
Description |
|
name |
string Optional external subscription name. |
|
properties |
object (map<string, string>) Mapping of vendor defined properties in key, value format. |
|
subscription |
Includes only one of the fields |
|
license |
Includes only one of the fields |
ExternalSubscription
|
Field |
Description |
|
subscriptionId |
string External subscription id. |
|
licenseId |
string Optional: paired license id for external subscription. |
|
activationKey |
string Optional: default activation key for external subscription. |
ExternalLicense
|
Field |
Description |
|
licenseId |
string External license bound to subscription instance. |
|
payload |
string (bytes) License (vendor specific) payload. |