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

Yandex Cloud Marketplace License Manager, REST: Instance.Get

Статья создана
Обновлена 8 августа 2025 г.

Returns the specified subscription instance.

To get the list of all available subscription instances, make a List request.

HTTP request

GET https://marketplace.api.yandexcloud.kz/marketplace/license-manager/v1/instances/{instanceId}

Path parameters

Field

Description

instanceId

string

Required field. ID of the subscription instance.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "cloudId": "string",
  "folderId": "string",
  "templateId": "string",
  "templateVersionId": "string",
  "description": "string",
  "startTime": "string",
  "endTime": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "state": "string",
  "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
      }
    }
  ],
  "licenseTemplate": {
    "id": "string",
    "versionId": "string",
    "name": "string",
    "publisherId": "string",
    "productId": "string",
    "tariffId": "string",
    "licenseSkuId": "string",
    "period": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "state": "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
  }
}

Field

Description

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

string (date-time)

Timestamp of the start of the subscription.

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.

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

licenseTemplate

Template

Subscription template.

externalInstance

ExternalInstance

External subscription instance (optional).

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.

Template

Field

Description

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

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 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.
Предыдущая
Overview
Следующая
List