DescribeAccounts - AnalyticDB for PostgreSQL - 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7565770E-7C45-462D-BA4A-8A5396F2CAD1
Accounts	array<object>	The name of the database account.
	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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history