Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Yandex Cloud Marketplace License Manager, gRPC: InstanceService.List

Written by
Updated at November 26, 2024

Retrieves the list of subscription instances in the specified folder.

gRPC request

rpc List (ListInstancesRequest) returns (ListInstancesResponse)

ListInstancesRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field

Description

folder_id

string

Required field. 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.

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.

filter

string

A filter expression that filters subscription instances listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on [Instance.name] field.
  2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
  3. The value. Must be in double quotes "". Must be 3-63 characters long and match the regular expression ^[a-z][-a-z0-9]{1,61}[a-z0-9].
    Example of a filter: name="my-subscription-instance".

order_by

string

Sorting order for the list of subscription instances.

ListInstancesResponse

{
  "instances": [
    {
      "id": "string",
      "cloud_id": "string",
      "folder_id": "string",
      "template_id": "string",
      "template_version_id": "string",
      "description": "string",
      "start_time": "google.protobuf.Timestamp",
      "end_time": "google.protobuf.Timestamp",
      "created_at": "google.protobuf.Timestamp",
      "updated_at": "google.protobuf.Timestamp",
      "state": "State",
      "locks": [
        {
          "id": "string",
          "instance_id": "string",
          "resource_id": "string",
          "start_time": "google.protobuf.Timestamp",
          "end_time": "google.protobuf.Timestamp",
          "created_at": "google.protobuf.Timestamp",
          "updated_at": "google.protobuf.Timestamp",
          "state": "State",
          "template_id": "string"
        }
      ],
      "license_template": {
        "id": "string",
        "version_id": "string",
        "name": "string",
        "publisher_id": "string",
        "product_id": "string",
        "tariff_id": "string",
        "license_sku_id": "string",
        "period": "string",
        "created_at": "google.protobuf.Timestamp",
        "updated_at": "google.protobuf.Timestamp",
        "state": "State"
      }
    }
  ],
  "next_page_token": "string"
}

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.

  • STATE_UNSPECIFIED
  • PENDING: Subscription created but not active yet.
  • ACTIVE: Subscription is active.
  • CANCELLED: Subscription canceled. It is still active, but won't be automatically renewed after the end of the current period.
  • EXPIRED: Subscription expired.
  • DEPRECATED: Subscription deprecated.
  • DELETED: Subscription deleted.

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.

  • STATE_UNSPECIFIED
  • UNLOCKED: Subscription unlocked.
  • LOCKED: Subscription locked to the resource.
  • DELETED: Subscription lock deleted.

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.

  • STATE_UNSPECIFIED
  • PENDING: Subscription template created but not active yet.
  • ACTIVE: Subscription template is active.
  • DEPRECATED: Subscription template deprecated.
  • DELETED: Subscription template deleted.
Previous
Get
Next
Overview