Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to query database management accounts.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeAccounts. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ClusterId | Yes | String | Cluster ID |
AccountNames.N | No | Array of String | List of accounts to be filtered |
DbType | No | String | Database type. Valid values: This parameter has been disused. |
Hosts.N | No | Array of String | List of accounts to be filtered |
Limit | No | Integer | Maximum entries returned per page |
Offset | No | Integer | Offset |
AccountRegular | No | String | Keywords for fuzzy search (match AccountName and AccountHost at the same time), which supports regex. The union results will be returned. |
Parameter Name | Type | Description |
---|---|---|
AccountSet | Array of Account | Database account list Note: This field may return null, indicating that no valid values can be obtained. |
TotalCount | Integer | Total number of accounts |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query a database management account.
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccounts
<Common request parameters>
{
"ClusterId": "cynosdbysql-on5xw0ni"
}
{
"Response": {
"AccountSet": [
{
"AccountName": "abc",
"Description": "abc",
"CreateTime": "2020-09-22 00:00:00",
"UpdateTime": "2020-09-22 00:00:00",
"Host": "abc",
"MaxUserConnections": 0
}
],
"TotalCount": 0,
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.DatabaseAccessError | Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
InternalError.DbOperationFailed | Failed to query the database. |
InternalError.SystemError | Internal system error. |
InvalidParameterValue.InstanceNotFound | The instance does not exist. |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
OperationDenied.ServerlessInstanceStatusDenied | For the serverless instance in this status, the operation is not allowed. |
ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?