Call DescribeAccounts to query database accounts - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

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.

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

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7565770E-7C45-462D-BA4A-8A5396F2CAD1
Accounts	object
DBInstanceAccount	array<object>	The queried database accounts.
	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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.