DescribeIndex - AnalyticDB - Alibaba Cloud Documentation Center

Retrieves the information about an index.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeIndex	get	*Collection `acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	No	The cluster ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
WorkspaceId	string	No	The ID of the workspace that consists of multiple AnalyticDB for PostgreSQL instances. This parameter and DBInstanceId cannot both be empty. If both parameters are specified, this value takes precedence. Valid values: ip l2 cosine	gp-ws-*****
Namespace	string	Yes	The namespace name. Note You can call the ListNamespaces operation to query a list of namespaces.	mynamespace
NamespacePassword	string	Yes	The password of the namespace. Note The value of this parameter is specified when you call the CreateNamespace operation.	testpassword
Collection	string	Yes	The name of the collection. Note You can call the ListCollections operation to query a list of collections.	testcollection
IndexName	string	Yes	The name of the index.	testindex

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	Indicates whether the request was successful. Valid values: false: The operation fails. true: The operation is successful.	success
Namespace	string	The namespace.	mynamespace
Collection	string	The name of the collection.	testcollection
IndexName	string	The name of the index.	testindex
IndexDef	string	The definition of the index.	CREATE INDEX testindex ON mynamespace. testcollection

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Namespace": "mynamespace",
  "Collection": "testcollection",
  "IndexName": "testindex",
  "IndexDef": "CREATE INDEX testindex ON mynamespace. testcollection"
}

Error codes

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