Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to query the database account list.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ClusterId | Yes | String | Cluster ID |
| AccountNames.N | No | Array of String | Account list to filter |
| DbType | No | String | Database type. Valid values: This parameter is no longer in use. |
| Hosts.N | No | Array of String | Account list to filter |
| Limit | No | Integer | Limit amount |
| Offset | No | Integer | Offset. |
| AccountRegular | No | String | Fuzzy match a keyword (match both AccountName and AccountHost at the same time, return the union of results, and support regular expressions) |
| Parameter Name | Type | Description |
|---|---|---|
| AccountSet | Array of Account | Database account list. |
| TotalCount | Integer | Total number of accounts |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Inquire the database account list
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccounts
<Common request parameters>
{
"ClusterId": "cynosdbysql-on5xw0ni"
}{
"Response": {
"AccountSet": [
{
"AccountName": "tom",
"Description": "AccountDescription",
"CreateTime": "2020-09-22 00:00:00",
"UpdateTime": "2020-09-22 00:00:00",
"Host": "%",
"MaxUserConnections": 0
}
],
"TotalCount": 0,
"RequestId": "e4f4f48a-51b1-45be-a9e3-09f0d1412659"
}
}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 | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| OperationDenied.ServerlessInstanceStatusDenied | Operation not allowed in the current status of the serverless instance. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
피드백