DescribeAccounts - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about database accounts for an AnalyticDB for PostgreSQL instance.

Operation description

This operation is called to query the information of the privileged account in an AnalyticDB for PostgreSQL instance, such as its state, description, and the instance.

Limit

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.

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:
- The required resource types are displayed in bold characters.
- 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:DescribeAccounts	get	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance 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-bp***************
AccountName	string	No	The name of the database account.	testuser
AccountType	string	No	The type of the database account that you want to query. Valid values: Super, Normal, and All. Default value: Super. If you set this parameter to Super, the information about the privileged account is returned. If you set this parameter to Normal, the information about all standard accounts is returned. If you set this parameter to All, the information about all database accounts is returned.	Super

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7565770E-7C45-462D-BA4A-8A5396F2CAD1
Accounts	array<object>	The queried database accounts.
DBInstanceAccount	object
AccountStatus	string	The state of the account. 0: The account is being created. 1: The account is in use. 3: The account is being deleted.	1
AccountDescription	string	The description of the account.	testuser
DBInstanceId	string	The ID of the instance.	gp-bp***************
AccountName	string	The name of the account.	testuser
AccountType	string	The type of the database account. Valid values: Super and Normal. Super indicates a privileged account and Normal indicates a standard account.	Super

Examples

Sample success responses

JSONformat

{
  "RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
  "Accounts": {
    "DBInstanceAccount": [
      {
        "AccountStatus": "1",
        "AccountDescription": "testuser",
        "DBInstanceId": "gp-bp***************",
        "AccountName": "testuser",
        "AccountType": "Super\n"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details