GetInstance API Response Fields & Instance Metadata - Tablestore - Alibaba Cloud - Tablestore

Queries instance information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /v2/openapi/getinstance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	Yes	The name of the instance.	instance-test

Response elements

Element	Type	Description	Example
	object	The returned struct.
RequestId	string	The request ID, which can be used to troubleshoot issues.	757E172A-F94B-5E78-8A23-D9068E42F2E9
InstanceName	string	The name of the instance.	instance-test
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmxh4em5jncda
RegionId	string	The region ID of the instance.	cn-chengdu
SPInstanceId	string	The ID of the instance.	ots_standard_public_cn-9lb34u7u5001
AliasName	string	The instance alias.	instance-test
UserId	string	The user ID.	16542312566
Network	string	The network type of the instance. Valid values: VPC: The instance can be accessed only over the bound virtual private clouds (VPCs). VPC_CONSOLE: The instance can be accessed from the Tablestore console or over the bound VPCs. NORMAL: The instance can be accessed from networks of the custom types.	VPC
InstanceDescription	string	The description of the instance.	Description of the test instance.
InstanceSpecification	string	The type of the instance. SSD: high-performance instance HYBRID: capacity instance	SSD
PaymentType	string	The billing method. Valid values: Subscription: subscription PayAsYouGo: pay-as-you-go	Subscription
StorageType	string	The storage type. SSD: high-performance HYBRID: capacity	HYBRID
VCUQuota	integer	The VCU quota.	20
TableQuota	integer	The total number of tables in the instance.	100
InstanceStatus	string	The status of the instance. normal: The instance works as expected. forbidden: The instance is disabled. Deleting: The instance is being deleted.	normal
CreateTime	string	The time when the instance was created.	2019-12-23T07:24:33Z
Tags	array<object>	The tags of the instance.
	object	The tag of the instance.
Key	string	The tag key.	tag
Value	string	The tag value.	333
TagKey	string	(Deprecated) The tag key.	keyTestA
TagValue	string	(Deprecated) The tag value.	00004a20240452b0
NetworkTypeACL	array	The types of the network from which access is allowed. Valid values: CLASSIC: the classic network INTERNET: the Internet VPC: VPCs
	string	The type of the network from which access is allowed.	INTERNET
NetworkSourceACL	array	The sources of the network from which access is allowed. Valid value: TRUST_PROXY: console
	string	The source of the network from which access is allowed.	TRUST_PROXY
Policy	string	The instance policy.	{ "Version": "1", "Statement": [ { "Action": [ "ots:" ], "Resource": [ "acs:ots::13791xxxxxxxxxxx:instance/myinstance" ], "Principal": [ "" ], "Effect": "Allow", "Condition": { "StringEquals": { "ots:TLSVersion": [ "1.2" ] }, "IpAddress": { "acs:SourceIp": [ "192.168.0.1", "198.51.100.1" ] } } } ] }
PolicyVersion	integer	The version of the instance policy.	1
IsMultiAZ	boolean	Indicates whether zone-redundant storage (ZRS) is enabled for the instance. true: ZRS is enabled for the instance. false: Locally redundant storage (LRS) is enabled for the instance.	true
ElasticVCUUpperLimit	number	The upper limit for the VCUs of the instance.	6

Examples

Success response

JSON format

{
  "RequestId": "757E172A-F94B-5E78-8A23-D9068E42F2E9",
  "InstanceName": "instance-test",
  "ResourceGroupId": "rg-acfmxh4em5jncda",
  "RegionId": "cn-chengdu",
  "SPInstanceId": "ots_standard_public_cn-9lb34u7u5001",
  "AliasName": "instance-test",
  "UserId": "16542312566",
  "Network": "VPC",
  "InstanceDescription": "Description of the test instance.",
  "InstanceSpecification": "SSD",
  "PaymentType": "Subscription",
  "StorageType": "HYBRID",
  "VCUQuota": 20,
  "TableQuota": 100,
  "InstanceStatus": "normal",
  "CreateTime": "2019-12-23T07:24:33Z",
  "Tags": [
    {
      "Key": "tag",
      "Value": "333",
      "TagKey": "keyTestA",
      "TagValue": "00004a20240452b0"
    }
  ],
  "NetworkTypeACL": [
    "INTERNET"
  ],
  "NetworkSourceACL": [
    "TRUST_PROXY"
  ],
  "Policy": "{\n    \"Version\": \"1\",\n    \"Statement\": [\n        {\n            \"Action\": [\n                \"ots:*\"\n            ],\n            \"Resource\": [\n                \"acs:ots:*:13791xxxxxxxxxxx:instance/myinstance*\"\n            ],\n            \"Principal\": [\n                \"*\"\n            ],\n            \"Effect\": \"Allow\",\n            \"Condition\": {\n                \"StringEquals\": {\n                    \"ots:TLSVersion\": [\n                        \"1.2\"\n                    ]\n                },\n                \"IpAddress\": {\n                    \"acs:SourceIp\": [\n                        \"192.168.0.1\",\n                        \"198.51.100.1\"\n                    ]\n                }\n            }\n        }\n    ]\n}",
  "PolicyVersion": 1,
  "IsMultiAZ": true,
  "ElasticVCUUpperLimit": 6
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.