DescribeTairSkvDdbTable - - Alibaba Cloud Documentation Center

Queries all Tair Serverless KV table instances in a specified workspace.

Operation description

When calling this operation, you must specify the InstanceId parameter.
The response includes basic information about each table, such as the table ID, name, bandwidth, and maximum number of connections.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeTairSkvDdbTable

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance to query.	tt-bp1zxszhcgatnx\\\\

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which is used to locate logs and troubleshoot issues.	2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4
Tables	object
Table	array<object>	The array of Table objects.
	array<object>	The table object.
Bandwidth	integer	The bandwidth.	96
Connections	integer	The maximum number of connections.	1000
GlobalSecondaryIndexList	object
GlobalSecondaryIndex	array<object>	The list of all GSI IDs under the table.
	object	The GSI object.
GsiId	string	The GSI instance ID, which is globally unique.	tt-gsi-xxxxxxxxx
IndexName	string	The index name.	indexKey1
TableId	string	The table ID, which is globally unique.	tt-2zelkttksbyc12x6c
TableName	string	The table name, which is unique within the workspace.	table1

Examples

Success response

JSON format

{
  "RequestId": "2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4",
  "Tables": {
    "Table": [
      {
        "Bandwidth": 96,
        "Connections": 1000,
        "GlobalSecondaryIndexList": {
          "GlobalSecondaryIndex": [
            {
              "GsiId": "tt-gsi-xxxxxxxxx",
              "IndexName": "indexKey1"
            }
          ]
        },
        "TableId": "tt-2zelkttksbyc12x6c",
        "TableName": "table1"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.