tencent cloud



Last updated: 2023-06-26 15:13:08

1. API Description

Domain name for API request: dcdb.tencentcloudapi.com.

This API is used to query the list of accounts of a specified TencentDB instance.

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 Params. The value used for this API: DescribeAccounts.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of dcdbt-ow728lmc.

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID, which is passed through from the input parameters.
Users Array of DBAccount Instance user list.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 None

Input Example

Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccounts
<Common request parameters>

    "InstanceId": "dcdbt-21dfpcv1"

Output Example

    "Response": {
        "InstanceId": "dcdbt-21dfpcv1",
        "RequestId": "5556e867-3f06-4bc8-8f3e-45112d9ce799",
        "Users": [
                "CreateTime": "2022-03-24 15:46:18",
                "DelayThresh": 0,
                "Description": "",
                "Host": "%",
                "ReadOnly": 0,
                "UpdateTime": "2022-03-24 15:46:18",
                "UserName": "gdx"
                "CreateTime": "2022-03-24 15:46:18",
                "DelayThresh": 0,
                "Description": "",
                "Host": "%",
                "ReadOnly": 0,
                "UpdateTime": "2022-03-24 15:46:18",
                "UserName": "h1"

5. Developer Resources


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

Command Line Interface

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
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetUserListFailed Failed to get the list of accounts.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been dropped.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support