DescribeIndex API Reference & RAM Authorization - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

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

gpdb:DescribeIndex

get

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

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 elements

Element	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.