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

Yandex Cloud Marketplace Product Instance Management API, REST: ProductInstance.Claim

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

Claims a product instance - activates it and optionally locks to subscription

HTTP request

POST https://marketplace.api.yandexcloud.kz/marketplace/pim/saas/v1/instances/claim

Body parameters

{
  "token": "string",
  "resourceId": "string",
  "resourceInfo": {
    "id": "string",
    "data": "object"
  }
}

Field

Description

token

string

Required field. Signed JWT token which contains information about product instance and subscription.

resourceId

string

ID of the resource to which the product instance will be claimed.

resourceInfo

SaasInfo

Additional information about the resource.

SaasInfo

Field

Description

id

string

ID of the SaaS resource.

data

object (map<string, string>)

Additional data about the SaaS resource.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "productId": "string",
    "productInstanceId": "string",
    "licenseInstanceId": "string",
    "lockId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "resourceId": "string",
    "resourceType": "string",
    "resourceMetadata": "object",
    "state": "string",
    "createdAt": "string",
    "updatedAt": "string",
    // Includes only one of the fields `saasInfo`
    "saasInfo": {
      "id": "string",
      "data": "object"
    }
    // end of the list of possible fields
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

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

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

ClaimProductInstanceMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

ProductInstance

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

ClaimProductInstanceMetadata

Field

Description

productId

string

ID of the product to which the product instance belongs.

productInstanceId

string

ID of the product instance.

licenseInstanceId

string

ID of the subscription.

lockId

string

ID of the subscription lock.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ProductInstance

Field

Description

id

string

ID of the product instance.

resourceId

string

ID of the resource.

resourceType

enum (ResourceType)

Type of the resource.

  • RESOURCE_TYPE_UNSPECIFIED
  • SAAS: SaaS resource.
  • K8S: Kubernetes resource.
  • COMPUTE: Compute resource.
  • CLOUD_APPS: Cloud Apps resource.

resourceMetadata

object (map<string, string>)

Metadata of the resource; Reserved for future use.

state

enum (State)

State of the product instance.

  • STATE_UNSPECIFIED
  • ACTIVATED: Product instance is activated.
  • DEACTIVATED: Product instance is deactivated.
  • PENDING_ACTIVATION: Product instance is pending activation.
  • DEPRECATED: Product instance is deprecated.
  • DELETED: Product instance is deleted.

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

saasInfo

SaasInfo

Includes only one of the fields saasInfo.

Additional information about the resource.

SaasInfo

Field

Description

id

string

ID of the SaaS resource.

data

object (map<string, string>)

Additional data about the SaaS resource.
Предыдущая
Get
Следующая
Overview