DescribeAccounts

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-08-05 17:35:44

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: DescribeAccounts.
Version	Yes	String	Common parameter. The value used for this API: 2019-01-07.
Region	Yes	String	Common parameter. 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: MYSQL

3. Output Parameters

Parameter Name	Type	Description
AccountSet	Array of Account	Database account list
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying database management accounts

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeAccounts
&ClusterId=cynosdbpg-on5xw0ni
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "150918",
    "AccountSet": [
      {
        "UpdateTime": "2018-06-28 23:28:52",
        "Host": "xx",
        "CreateTime": "2018-06-28 23:28:52",
        "Description": "Default user asdf",
        "AccountName": "admin"
      }
    ]
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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 ({{1}}). Please try again later. If the problem persists, please contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.SystemError	Internal system error.
InvalidParameterValue.InstanceNotFound	The instance does not exist.
OperationDenied.ServerlessInstanceStatusDenied	For the serverless instance in this status ({{1}}), the operation is not allowed.
ResourceNotFound.ClusterNotFoundError	The cluster ({{1}}) does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Recent Pages