tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeClusterDetailDatabases

最后更新时间：2023-08-23 14:22:58

1. API Description

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

This API is used to query the database list.

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: DescribeClusterDetailDatabases.
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
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
DbName No String Database name

3. Output Parameters

Parameter Name Type Description
DbInfos Array of DbInfo Database information Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer The total count
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the database list

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>cynosdbpg-xxxxxxx",    "Limit": "20",    "DbName": "test",    "Offset": "0"}

Output Example

{
    "Response": {
        "DbInfos": [
            {
                "Status": "running",
                "UserHostPrivileges": [],
                "UpdateTime": "0001-01-01T00:00:00Z",
                "Description": "",
                "DbId": 0,
                "CharacterSet": "",
                "ClusterId": "",
                "DbName": "mysql",
                "Uin": "",
                "AppId": 0,
                "CollateRule": "",
                "CreateTime": "0001-01-01T00:00:00Z"
            }
        ],
        "TotalCount": 1,
        "RequestId": "6e094b68-0a37-11ec-97e7-525400542aa6"
    }
}

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

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.
InvalidParameterValue.AccountNotExistError The instance doesn’t have an account.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.InstanceStatusLimitError The instance is not running.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款