Skip to main content

List

Retrieves the list of subscription instances in the specified folder.

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListInstancesRequest =
  cloudApi.compute.instance_service.ListInstancesRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.InstanceServiceClient);

  const result = await client.list(
    ListInstancesRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter",
      // orderBy: "orderBy"
    })
  );
  console.log(result);
})();

ListInstancesRequest​

folderId : string​

ID of the folder that the subscription instance belongs to.

pageSize : 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.

pageToken : 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".
orderBy : string​

Sorting order for the list of subscription instances.

ListInstancesResponse​

instances : Instance​

List of subscription instances.

nextPageToken : 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​

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.

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 : google.protobuf.Timestamp​

Timestamp of the start of the subscription.

endTime : google.protobuf.Timestamp​

Timestamp of the end of the subscription.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

updatedAt : google.protobuf.Timestamp​

Update timestamp.

state : State​

Subscription state.

locks : Lock​

List of subscription locks.

licenseTemplate : Template​

Subscription template.

Lock​

State​
  • STATE_UNSPECIFIED

  • UNLOCKED

    Subscription unlocked.

  • LOCKED

    Subscription locked to the resource.

  • DELETED

    Subscription lock deleted.

id : string​

ID of the subscription lock.

instanceId : string​

ID of the subscription instance.

resourceId : string​

ID of the resource.

startTime : google.protobuf.Timestamp​

Timestamp of the start of the subscription lock.

endTime : google.protobuf.Timestamp​

Timestamp of the end of the subscription lock.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

updatedAt : google.protobuf.Timestamp​

Update timestamp.

state : State​

Subscription lock state.

templateId : string​

ID of the subscription template.

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.

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 : google.protobuf.Timestamp​

Creation timestamp.

updatedAt : google.protobuf.Timestamp​

Update timestamp.

state : State​

Subscription template state.