GetInstance - 获取实例信息_表格存储(Tablestore)-阿里云帮助中心

获取实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /v2/openapi/getinstance HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceName	string	是	实例名称。	instance-test

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID，可用于排查和定位问题。	757E172A-F94B-5E78-8A23-D9068E42F2E9
InstanceName	string	实例名称。	instance-test
ResourceGroupId	string	资源组 ID。	rg-acfmxh4em5jncda
RegionId	string	实例的地域 ID。	cn-chengdu
SPInstanceId	string	实例 ID。	ots_standard_public_cn-9lb34u7u5001
AliasName	string	实例别名。	测试实例的别名。
UserId	string	用户 ID。	16542312566
Network	string	网络类型，取值范围如下： VPC：限定绑定 VPC 访问。 VPC_CONSOLE：限定控制台或 VPC 访问。 NORMAL：自定义。	VPC
InstanceDescription	string	实例描述。	测试实例的描述信息。
InstanceSpecification	string	实例规格。 SSD：高性能。 HYBRID：容量型。	SSD
PaymentType	string	付费方式。 Subscription：包年包月。 PayAsYouGo：按量付费。	Subscription
StorageType	string	存储类型。 SSD：高性能。 HYBRID：容量型。	HYBRID
VCUQuota	integer	VCU 配额。	20
TableQuota	integer	实例下的表总数。	100
InstanceStatus	string	实例状态。 normal：正常。 forbidden：禁用。 deleting：释放中。	normal
CreateTime	string	创建时间。	2019-12-23T07:24:33Z
Tags	array<object>	实例的标签集合。
Tags	object	实例的标签。
Key	string	标签键。	tag
Value	string	标签值。	333
TagKey	string	（已废弃）标签键。	keyTestA
TagValue	string	（已废弃）标签值。	00004a20240452b0
NetworkTypeACL	array	实例允许的网络类型列表。 CLASSIC：经典网。 INTERNET：公网。 VPC：VPC 网络。
NetworkTypeACL	string	实例允许的网络类型。	INTERNET
NetworkSourceACL	array	实例允许的网络来源列表。 TRUST_PROXY：控制台。
NetworkSourceACL	string	实例允许的网络来源。	TRUST_PROXY
Policy	string	实例访问控制策略。	{ "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	long	实例访问控制策略的版本。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "757E172A-F94B-5E78-8A23-D9068E42F2E9",
  "InstanceName": "instance-test",
  "ResourceGroupId": "rg-acfmxh4em5jncda",
  "RegionId": "cn-chengdu",
  "SPInstanceId": "ots_standard_public_cn-9lb34u7u5001",
  "AliasName": "测试实例的别名。",
  "UserId": "16542312566",
  "Network": "VPC",
  "InstanceDescription": "测试实例的描述信息。",
  "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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-02	OpenAPI 返回结构发生变更	查看变更详情
2023-10-13	OpenAPI 返回结构发生变更	查看变更详情