Yandex Cloud Marketplace License Manager, REST: Instance.Get
Returns the specified subscription instance.
To get the list of all available subscription instances, make a List request.
HTTP request
GET https://marketplace.api.cloud.yandex.net/marketplace/license-manager/v1/instances/{instanceId}
Path parameters
Field |
Description |
instanceId |
string Required field. ID of the subscription instance. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"cloudId": "string",
"folderId": "string",
"templateId": "string",
"templateVersionId": "string",
"description": "string",
"startTime": "string",
"endTime": "string",
"createdAt": "string",
"updatedAt": "string",
"state": "string",
"locks": [
{
"id": "string",
"instanceId": "string",
"resourceId": "string",
"startTime": "string",
"endTime": "string",
"createdAt": "string",
"updatedAt": "string",
"state": "string",
"templateId": "string"
}
],
"licenseTemplate": {
"id": "string",
"versionId": "string",
"name": "string",
"publisherId": "string",
"productId": "string",
"tariffId": "string",
"licenseSkuId": "string",
"period": "string",
"createdAt": "string",
"updatedAt": "string",
"state": "string"
}
}
Field |
Description |
id |
string ID of the subscription instance. |
cloudId |
string ID of the cloud that the subscription instance belongs to. |
folderId |
string ID of the folder that the subscription instance belongs to. |
templateId |
string ID of the subscription template that was used to create subscription instance. |
templateVersionId |
string ID of the version of subscription template. |
description |
string Description of the subscription instance. |
startTime |
string (date-time) Timestamp of the start of the subscription. 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. 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 state.
|
locks[] |
List of subscription locks. |
licenseTemplate |
Subscription template. |
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. |
Template
Field |
Description |
id |
string ID of the subscription template. |
versionId |
string Version of the subscription template. |
name |
string Name of the subscription template. |
publisherId |
string ID of publisher. |
productId |
string ID of product. |
tariffId |
string ID of tariff. |
licenseSkuId |
string ID of subscription SKU. |
period |
string Subscription period. |
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 template state.
|