Yandex Cloud Marketplace License Manager, REST: Instance.list
Retrieves the list of subscription instances in the specified folder.
HTTP request
GET https://marketplace.api.cloud.yandex.net/marketplace/license-manager/v1/instances
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder that the subscription instance belongs to. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters subscription instances listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
orderBy | Sorting order for the list of subscription instances. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"instances": [
{
"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"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
instances[] | object List of subscription instances. |
instances[]. id |
string ID of the subscription instance. |
instances[]. cloudId |
string ID of the cloud that the subscription instance belongs to. |
instances[]. folderId |
string ID of the folder that the subscription instance belongs to. |
instances[]. templateId |
string ID of the subscription template that was used to create subscription instance. |
instances[]. templateVersionId |
string ID of the version of subscription template. |
instances[]. description |
string Description of the subscription instance. |
instances[]. 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). |
instances[]. 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). |
instances[]. 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). |
instances[]. 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). |
instances[]. state |
string Subscription state.
|
instances[]. locks[] |
object List of subscription locks. |
instances[]. locks[]. id |
string ID of the subscription lock. |
instances[]. locks[]. instanceId |
string ID of the subscription instance. |
instances[]. locks[]. resourceId |
string ID of the resource. |
instances[]. 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). |
instances[]. 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). |
instances[]. 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). |
instances[]. 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). |
instances[]. locks[]. state |
string Subscription lock state.
|
instances[]. locks[]. templateId |
string ID of the subscription template. |
instances[]. licenseTemplate |
object Subscription template. |
instances[]. licenseTemplate. id |
string ID of the subscription template. |
instances[]. licenseTemplate. versionId |
string Version of the subscription template. |
instances[]. licenseTemplate. name |
string Name of the subscription template. |
instances[]. licenseTemplate. publisherId |
string ID of publisher. |
instances[]. licenseTemplate. productId |
string ID of product. |
instances[]. licenseTemplate. tariffId |
string ID of tariff. |
instances[]. licenseTemplate. licenseSkuId |
string ID of subscription SKU. |
instances[]. licenseTemplate. period |
string Subscription period. |
instances[]. 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). |
instances[]. 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). |
instances[]. licenseTemplate. state |
string Subscription template state.
|
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |