Yandex Cloud Marketplace License Manager, gRPC: InstanceService
Written by
Updated at November 8, 2023
A set of methods for managing subscription instances.
Call | Description |
---|---|
Get | Returns the specified subscription instance. |
List | Retrieves the list of subscription instances in the specified folder. |
Calls InstanceService
Get
Returns the specified subscription instance.
To get the list of all available subscription instances, make a List request.
rpc Get (GetInstanceRequest) returns (Instance)
GetInstanceRequest
Field | Description |
---|---|
instance_id | string Required. ID of the subscription instance. |
Instance
Field | Description |
---|---|
id | string ID of the subscription instance. |
cloud_id | string ID of the cloud that the subscription instance belongs to. |
folder_id | string ID of the folder that the subscription instance belongs to. |
template_id | string ID of the subscription template that was used to create subscription instance. |
template_version_id | string ID of the version of subscription template. |
description | string Description of the subscription instance. |
start_time | google.protobuf.Timestamp Timestamp of the start of the subscription. |
end_time | google.protobuf.Timestamp Timestamp of the end of the subscription. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription state.
|
locks[] | Lock List of subscription locks. |
license_template | Template Subscription template. |
Lock
Field | Description |
---|---|
id | string ID of the subscription lock. |
instance_id | string ID of the subscription instance. |
resource_id | string ID of the resource. |
start_time | google.protobuf.Timestamp Timestamp of the start of the subscription lock. |
end_time | google.protobuf.Timestamp Timestamp of the end of the subscription lock. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription lock state.
|
template_id | string ID of the subscription template. |
Template
Field | Description |
---|---|
id | string ID of the subscription template. |
version_id | string Version of the subscription template. |
name | string Name of the subscription template. |
publisher_id | string ID of publisher. |
product_id | string ID of product. |
tariff_id | string ID of tariff. |
license_sku_id | string ID of subscription SKU. |
period | string Subscription period. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription template state.
|
List
Retrieves the list of subscription instances in the specified folder.
rpc List (ListInstancesRequest) returns (ListInstancesResponse)
ListInstancesRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder that the subscription instance belongs to. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListInstancesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListInstancesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters subscription instances listed in the response. The expression must specify:
name="my-subscription-instance" . The maximum string length in characters is 1000. |
order_by | string Sorting order for the list of subscription instances. The maximum string length in characters is 100. |
ListInstancesResponse
Field | Description |
---|---|
instances[] | Instance List of subscription instances. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListInstancesRequest.page_size, use next_page_token as the value for the ListInstancesRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Instance
Field | Description |
---|---|
id | string ID of the subscription instance. |
cloud_id | string ID of the cloud that the subscription instance belongs to. |
folder_id | string ID of the folder that the subscription instance belongs to. |
template_id | string ID of the subscription template that was used to create subscription instance. |
template_version_id | string ID of the version of subscription template. |
description | string Description of the subscription instance. |
start_time | google.protobuf.Timestamp Timestamp of the start of the subscription. |
end_time | google.protobuf.Timestamp Timestamp of the end of the subscription. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription state.
|
locks[] | Lock List of subscription locks. |
license_template | Template Subscription template. |
Lock
Field | Description |
---|---|
id | string ID of the subscription lock. |
instance_id | string ID of the subscription instance. |
resource_id | string ID of the resource. |
start_time | google.protobuf.Timestamp Timestamp of the start of the subscription lock. |
end_time | google.protobuf.Timestamp Timestamp of the end of the subscription lock. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription lock state.
|
template_id | string ID of the subscription template. |
Template
Field | Description |
---|---|
id | string ID of the subscription template. |
version_id | string Version of the subscription template. |
name | string Name of the subscription template. |
publisher_id | string ID of publisher. |
product_id | string ID of product. |
tariff_id | string ID of tariff. |
license_sku_id | string ID of subscription SKU. |
period | string Subscription period. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Update timestamp. |
state | enum State Subscription template state.
|