All Products
Search

This Product

    Tablestore:GetInstance

    Document Center

    Tablestore:GetInstance

    Last Updated:Nov 11, 2024

    Queries instance information.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

    GET /v2/openapi/getinstance HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceNamestringYes

    The name of the instance.

    		instance-test

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned struct.

    RequestIdstring

    The request ID, which can be used to troubleshoot issues.

    		757E172A-F94B-5E78-8A23-D9068E42F2E9
    InstanceNamestring

    The name of the instance.

    		instance-test
    ResourceGroupIdstring

    The ID of the resource group to which the instance belongs.

    		rg-acfmxh4em5jncda
    RegionIdstring

    The region ID of the instance.

    		cn-chengdu
    SPInstanceIdstring

    The ID of the instance.

    		ots_standard_public_cn-9lb34u7u5001
    AliasNamestring

    The alias of the instance.

    		instance-test
    UserIdstring

    The user ID.

    		16542312566
    Networkstring

    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
    InstanceDescriptionstring

    The description of the instance.

    		Description of the test instance.
    InstanceSpecificationstring

    The type of the instance.

    • SSD: high-performance instance
    • HYBRID: capacity instance
    		SSD
    PaymentTypestring

    The billing method. Valid values:

    • Subscription: subscription
    • PayAsYouGo: pay-as-you-go
    		Subscription
    StorageTypestring

    The storage type.

    • SSD: high-performance
    • HYBRID: capacity
    		HYBRID
    VCUQuotainteger

    The VCU quota.

    		20
    TableQuotainteger

    The total number of tables in the instance.

    		100
    InstanceStatusstring

    The status of the instance.

    • normal: The instance works as expected.
    • forbidden: The instance is disabled.
    • Deleting: The instance is being deleted.
    		normal
    CreateTimestring

    The time when the instance was created.

    		2019-12-23T07:24:33Z
    Tagsarray<object>

    The tags of the instance.

    Tagsobject

    The tag of the instance.

    Keystring

    The tag key.

    		tag
    Valuestring

    The tag value.

    		333
    TagKeystring

    (Deprecated) The tag key.

    		keyTestA
    TagValuestring

    (Deprecated) The tag value.

    		00004a20240452b0
    NetworkTypeACLarray

    The types of the network from which access is allowed. Valid values:

    • CLASSIC: the classic network
    • INTERNET: the Internet
    • VPC: VPCs
    NetworkTypeACLstring

    The type of the network from which access is allowed.

    		INTERNET
    NetworkSourceACLarray

    The sources of the network from which access is allowed. Valid value:

    TRUST_PROXY: console

    NetworkSourceACLstring

    The source of the network from which access is allowed.

    		TRUST_PROXY
    Policystring

    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" ] } } } ] }
    PolicyVersionlong

    The version of the instance policy.

    		1

    Examples

    Sample success responses

    JSONformat

    {
  "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
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-04-02The response structure of the API has changedView Change Details
    2023-10-13The response structure of the API has changedView Change Details