Yandex Cloud Marketplace License Manager for SaaS, REST: Instance.get
Returns the specified subscription instance.
HTTP request
GET https://marketplace.api.cloud.yandex.net/marketplace/license-manager/saas/v1/instances/{instanceId}
Path parameters
Parameter | Description |
---|---|
instanceId | Required. 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 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
endTime | string (date-time) Timestamp of the end of the subscription. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
state | string Subscription state.
|
locks[] | object List of subscription locks. |
locks[]. id |
string ID of the subscription lock. |
locks[]. instanceId |
string ID of the subscription instance. |
locks[]. resourceId |
string ID of the resource. |
locks[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
locks[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
locks[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
locks[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
locks[]. state |
string Subscription lock state.
|
locks[]. templateId |
string ID of the subscription template. |
licenseTemplate | object Subscription template. |
licenseTemplate. id |
string ID of the subscription template. |
licenseTemplate. versionId |
string Version of the subscription template. |
licenseTemplate. name |
string Name of the subscription template. |
licenseTemplate. publisherId |
string ID of publisher. |
licenseTemplate. productId |
string ID of product. |
licenseTemplate. tariffId |
string ID of tariff. |
licenseTemplate. licenseSkuId |
string ID of subscription SKU. |
licenseTemplate. period |
string Subscription period. |
licenseTemplate. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
licenseTemplate. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
licenseTemplate. state |
string Subscription template state.
|