DescribeTairSkvDdbTableSchema - - Alibaba Cloud Documentation Center

Operation description

This operation queries the table schema and configuration information of a Tair Serverless KV table instance.
You must specify the InstanceId parameter. Set this parameter to the instance ID of the instance that you want to query.
The BackupId parameter specifies the backup set of the table to query.
The response packet includes the time-to-live (TTL) specifications and detailed table schema definition.

To invoke this operation, see the request parameters below.

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:DescribeTairSkvDdbTableSchema

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\\\\\\\\
BackupId	string	No	The ID of the backup file.	78241****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. For more information, see common parameters.	A1604E1B-6825-1577-BBDA-2A64E8D5F126
Schema	string	The table schema information in JSON format.	{"attributeDefinitions":[{"attributeType":"S","attributeName":"pk"},{"attributeType":"S","attributeName":"sk"}],"keySchema":[{"attributeName":"pk","keyType":"HASH"},{"attributeName":"sk","keyType":"RANGE"}]}
TtlSpec	string	The TTL property. The parameter settings toggle in JSON format.	{"attributeName":"Expiretime","enabled":true}

{
		"TtlSpec":"{\"attributeName\":\"Expiretime\",\"enabled\":true}",
		"RequestId":"A1604E1B-6825-1577-BBDA-2A64E8D5F126",
		"Schema":"{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}"
	}

Examples

Success response

JSON format

{
  "RequestId": "A1604E1B-6825-1577-BBDA-2A64E8D5F126",
  "Schema": "{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}",
  "TtlSpec": "{\"attributeName\":\"Expiretime\",\"enabled\":true}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.