List

Returns subscriptions locks for specified resource and folder.

TypeScript

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

const ListLocksRequest =
  cloudApi.marketplace.licensemanager_lock_service.ListLocksRequest;

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

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.marketplace.licensemanager.v1.lock_service_pb2 import ListLocksRequest
from yandex.cloud.marketplace.licensemanager.saas.v1.lock_service_pb2_grpc import LockServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(LockServiceStub)
response = service.List(
    ListLocksRequest(
        resource_id="resourceId",
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter",
        # order_by = "orderBy"
    )
)
print(response)

ListLocksRequest

resourceId : string

ID of the resource that the subscription locks belong to.

folderId : string

ID of the folder that the subscription locks belong 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 ListLocksResponse.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 ListLocksResponse.next_page_token returned by a previous list request.

filter : string

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

The expression must specify:

1. The field name. Currently you can use filtering only on Lock.product_id 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: product_id="my-product-id".

orderBy : string

Sorting order for the list of subscription locks.

ListLocksResponse

locks : Lock

List of subscription locks.

nextPageToken : string

Token for getting the next page of the list. If the number of results is greater than the specified ListLocksRequest.page_size, use next_page_token as the value for the ListLocksRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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.

---