Yandex Cloud Marketplace Product Instance Management API, gRPC: ProductInstanceService.Claim

Written by

Yandex Cloud

Updated at July 1, 2026

View in Markdown

gRPC request
ClaimProductInstanceRequest
SaasInfo
operation.Operation

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

gRPC request

rpc Claim (ClaimProductInstanceRequest) returns (operation.Operation)

ClaimProductInstanceRequest

{
  "token": "string",
  "resource_id": "string",
  "resource_info": {
    "id": "string",
    "data": "map<string, string>"
  }
}

Field	Description
token	string Required field. Signed JWT token which contains information about product instance and subscription. The maximum string length in characters is 1000.
resource_id	string ID of the resource to which the product instance will be claimed.
resource_info	SaasInfo Additional information about the resource.

SaasInfo

Field

Description

string

ID of the SaaS resource.

data

object (map<string, string>)

Additional data about the SaaS resource.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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	google.rpc.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	google.protobuf.Any 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.

Yandex Cloud Marketplace Product Instance Management API, gRPC: ProductInstanceService.Claim

gRPC requestgRPC request

ClaimProductInstanceRequestClaimProductInstanceRequest

SaasInfoSaasInfo

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

ClaimProductInstanceRequest

SaasInfo

operation.Operation