Get

Returns the specified subscription instance.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetInstanceRequest = cloudApi.compute.instance_service.GetInstanceRequest;
const InstanceView = cloudApi.compute.instance_service.InstanceView;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.InstanceServiceClient);

  const result = await client.get(
    GetInstanceRequest.fromPartial({
      instanceId: "instanceId",
      // view: InstanceView.FULL
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.instance_service_pb2 import GetInstanceRequest
from yandex.cloud.compute.v1.instance_service_pb2_grpc import InstanceServiceStub
from yandex.cloud.compute.v1.instance_service_pb2 import InstanceView

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(InstanceServiceStub)
response = service.Get(
    GetInstanceRequest(
        instance_id="instanceId",
        # view = InstanceView.FULL
    )
)
print(response)

GetInstanceRequest

instanceId : string

ID of the subscription instance.

Instance

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.

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 : google.protobuf.Timestamp

Timestamp of the start of the subscription.

endTime : google.protobuf.Timestamp

Timestamp of the end of the subscription.

createdAt : google.protobuf.Timestamp

Creation timestamp.

updatedAt : google.protobuf.Timestamp

Update timestamp.

state : State

Subscription state.

locks : Lock

List of subscription locks.

licenseTemplate : Template

Subscription template.

Lock

State

• STATE_UNSPECIFIED

• UNLOCKED

  Subscription unlocked.

• LOCKED

  Subscription locked to the resource.

• DELETED

  Subscription lock deleted.

id : string

ID of the subscription lock.

instanceId : string

ID of the subscription instance.

resourceId : string

ID of the resource.

startTime : google.protobuf.Timestamp

Timestamp of the start of the subscription lock.

endTime : google.protobuf.Timestamp

Timestamp of the end of the subscription lock.

createdAt : google.protobuf.Timestamp

Creation timestamp.

updatedAt : google.protobuf.Timestamp

Update timestamp.

state : State

Subscription lock state.

templateId : string

ID of the subscription template.

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.

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 : google.protobuf.Timestamp

Creation timestamp.

updatedAt : google.protobuf.Timestamp

Update timestamp.

state : State

Subscription template state.

---