Contact UsGet started

Yandex Cloud Marketplace License Manager, gRPC: LockService.List

Written by
Updated at October 28, 2024

Returns subscriptions locks for specified resource and folder.

gRPC request

rpc List (ListLocksRequest) returns (ListLocksResponse)

ListLocksRequest

{
  "resourceId": "string",
  "folderId": "string",
  "pageSize": "int64",
  "pageToken": "string",
  "filter": "string",
  "orderBy": "string"
}

Field

Description

resourceId

string

Required field. ID of the resource that the subscription locks belong to.

folderId

string

Required field. 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.nextPageToken
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.nextPageToken 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": [
    {
      "id": "string",
      "instanceId": "string",
      "resourceId": "string",
      "startTime": "google.protobuf.Timestamp",
      "endTime": "google.protobuf.Timestamp",
      "createdAt": "google.protobuf.Timestamp",
      "updatedAt": "google.protobuf.Timestamp",
      "state": "State",
      "templateId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

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.pageSize, use next_page_token as the value
for the ListLocksRequest.pageToken parameter in the next list request.

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

Lock

Field

Description

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

enum State

Subscription lock state.

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

templateId

string

ID of the subscription template.
Previous
GetByInstanceAndResource
Next
Create