Queries information about a database account of a PolarDB cluster.
Debugging
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 |
---|---|---|---|---|
polardb:DescribeAccounts | Read |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The cluster ID. | pc-*************** |
AccountName | string | No | The name of the account. | test_acc |
PageNumber | integer | No | The page number of the page to return. Set this parameter to an integer that is larger than 0. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Valid values:
Default value: 30. | 30 |
Response parameters
Examples
Sample success responses
JSON
format
{
"PageRecordCount": 1,
"RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
"PageNumber": 1,
"Accounts": [
{
"AccountStatus": "Available",
"DatabasePrivileges": [
{
"DBName": "DBtest",
"AccountPrivilege": "ReadOnly"
}
],
"AccountDescription": "test",
"AccountPasswordValidTime": "undefined",
"AccountType": "Normal",
"AccountLockState": "UnLock",
"AccountName": "test_acc",
"AccountPassword": "Test1111"
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | The specified PageSize parameter is invalid. |
400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | The specified PageNumber parameter is invalid. |
400 | Database.ConnectError | db instance %s connect failed, please check instance status and database processlist | Failed to connect to the database cluster. Check the cluster status and database process list. |
400 | Account.QueryError | Instance %s query account error | Failed to query accounts for cluster %s. |
400 | Connect.Timeout | Service can not connect to instance temporarily. | Failed to connect to the cluster. |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-11-03 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||
| ||||||||||
2023-06-12 | The Error code has changed | see changesets | ||||||||
| ||||||||||
2023-04-24 | The Error code has changed | see changesets | ||||||||
|