Contact UsGet started

Yandex Cloud Marketplace License Manager for SaaS, gRPC: InstanceService.Get

Written by
Updated at November 26, 2024

Returns the specified subscription instance.

gRPC request

rpc Get (GetInstanceRequest) returns (licensemanager.v1.Instance)

GetInstanceRequest

{
  "instance_id": "string"
}

Field

Description

instance_id

string

Required field. ID of the subscription instance.

licensemanager.v1.Instance

{
  "id": "string",
  "cloud_id": "string",
  "folder_id": "string",
  "template_id": "string",
  "template_version_id": "string",
  "description": "string",
  "start_time": "google.protobuf.Timestamp",
  "end_time": "google.protobuf.Timestamp",
  "created_at": "google.protobuf.Timestamp",
  "updated_at": "google.protobuf.Timestamp",
  "state": "State",
  "locks": [
    {
      "id": "string",
      "instance_id": "string",
      "resource_id": "string",
      "start_time": "google.protobuf.Timestamp",
      "end_time": "google.protobuf.Timestamp",
      "created_at": "google.protobuf.Timestamp",
      "updated_at": "google.protobuf.Timestamp",
      "state": "State",
      "template_id": "string"
    }
  ],
  "license_template": {
    "id": "string",
    "version_id": "string",
    "name": "string",
    "publisher_id": "string",
    "product_id": "string",
    "tariff_id": "string",
    "license_sku_id": "string",
    "period": "string",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp",
    "state": "State"
  }
}

Field

Description

id

string

ID of the subscription instance.

cloud_id

string

ID of the cloud that the subscription instance belongs to.

folder_id

string

ID of the folder that the subscription instance belongs to.

template_id

string

ID of the subscription template that was used to create subscription instance.

template_version_id

string

ID of the version of subscription template.

description

string

Description of the subscription instance.

start_time

google.protobuf.Timestamp

Timestamp of the start of the subscription.

end_time

google.protobuf.Timestamp

Timestamp of the end of the subscription.

created_at

google.protobuf.Timestamp

Creation timestamp.

updated_at

google.protobuf.Timestamp

Update timestamp.

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.

license_template

Template

Subscription template.

Lock

Field

Description

id

string

ID of the subscription lock.

instance_id

string

ID of the subscription instance.

resource_id

string

ID of the resource.

start_time

google.protobuf.Timestamp

Timestamp of the start of the subscription lock.

end_time

google.protobuf.Timestamp

Timestamp of the end of the subscription lock.

created_at

google.protobuf.Timestamp

Creation timestamp.

updated_at

google.protobuf.Timestamp

Update timestamp.

state

enum State

Subscription lock state.

  • STATE_UNSPECIFIED
  • UNLOCKED: Subscription unlocked.
  • LOCKED: Subscription locked to the resource.
  • DELETED: Subscription lock deleted.

template_id

string

ID of the subscription template.

Template

Field

Description

id

string

ID of the subscription template.

version_id

string

Version of the subscription template.

name

string

Name of the subscription template.

publisher_id

string

ID of publisher.

product_id

string

ID of product.

tariff_id

string

ID of tariff.

license_sku_id

string

ID of subscription SKU.

period

string

Subscription period.

created_at

google.protobuf.Timestamp

Creation timestamp.

updated_at

google.protobuf.Timestamp

Update timestamp.

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.
Previous
Overview
Next
Overview