Yandex Cloud Marketplace Product Instance Management API, REST: ProductInstance.Get
Returns the specified product instance.
HTTP request
GET https://marketplace.api.cloud.yandex.net/marketplace/pim/saas/v1/instances/{productInstanceId}
Path parameters
|
Field |
Description |
|
productInstanceId |
string Required field. ID of the product instance to return. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"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
}
|
Field |
Description |
|
id |
string ID of the product instance. |
|
resourceId |
string ID of the resource. |
|
resourceType |
enum (ResourceType) Type of the resource.
|
|
resourceMetadata |
object (map<string, string>) Metadata of the resource; Reserved for future use. |
|
state |
enum (State) State of the product instance.
|
|
createdAt |
string (date-time) Creation timestamp String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Update timestamp String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
saasInfo |
Includes only one of the fields 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. |