tencent cloud



Last updated: 2023-03-29 17:52:51

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 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

    3. Output Parameters

    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.

    4. Example

    Example1 Querying database management accounts

    Input Example

    POST / HTTP/1.1
    Host: cynosdb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeSubAccounts
    <Common request parameters>
        "ClusterId": "cynosdbysql-on5xw0ni"

    Output Example

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

    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
    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.
    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