Связаться с намиПодключиться

Yandex Cloud Marketplace License Manager, REST: Lock.List

Статья создана
Обновлена 3 октября 2025 г.

Returns subscriptions locks for specified resource and folder.

HTTP request

GET https://marketplace.api.yandexcloud.kz/marketplace/license-manager/v1/locks

Query parameters

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

string (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.

Response

HTTP Code: 200 - OK

{
  "locks": [
    {
      "id": "string",
      "instanceId": "string",
      "resourceId": "string",
      "startTime": "string",
      "endTime": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "state": "string",
      "templateId": "string",
      "externalInstance": {
        "name": "string",
        "properties": "object",
        // Includes only one of the fields `subscription`, `license`
        "subscription": {
          "subscriptionId": "string",
          "licenseId": "string",
          "activationKey": "string"
        },
        "license": {
          "licenseId": "string",
          "payload": "string"
        }
        // end of the list of possible fields
      }
    }
  ],
  "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

string (date-time)

Timestamp of the start of the subscription lock.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

endTime

string (date-time)

Timestamp of the end of the subscription lock.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Update timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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.

externalInstance

ExternalInstance

External subscription instance (optional), for usage convenience propagated
from parent subscription instance.

ExternalInstance

ExternalInstance attachment to external service subscription.

Field

Description

name

string

Optional external subscription name.

properties

object (map<string, string>)

Mapping of vendor defined properties in key, value format.

subscription

ExternalSubscription

Includes only one of the fields subscription, license.

license

ExternalLicense

Includes only one of the fields subscription, license.

ExternalSubscription

Field

Description

subscriptionId

string

External subscription id.

licenseId

string

Optional: paired license id for external subscription.

activationKey

string

Optional: default activation key for external subscription.

ExternalLicense

Field

Description

licenseId

string

External license bound to subscription instance.

payload

string (bytes)

License (vendor specific) payload.
Предыдущая
GetByInstanceAndResource
Следующая
Create