Release Notes and Announcements

Release Notes

Announcements

Product Introduction

Overview

System Architecture

Use Cases

Key Concepts

Instance Types and Specifications

Purchase Guide

Product Pricing

Purchasing an Instance

Renewal Instructions

Overdue Payment Instructions

Refund Instructions

Getting Started

Connecting to an Instance and Writing Data

Operation Guide

CAM

Managing an Instance

Automatic Backup

System Monitoring

Database Management

Account Management

Managing a Security Group

Public Network Access

InfluxQL Compatibility

Database Management

Schema Query

Data Type

Data Query

InfluxQL Functions

Client

SDK Reference

influx CLI Client

API Documentation

History

Introduction

API Category

Making API Requests

Instance APIs

Database APIs

Data Types

Error Codes

Practical Tutorial

Recommendations for the Data Table Definition

Using the Grafana Service

Integrating the Telegraf Service

Performance White Paper

Test Environment

Testing Tool

Write Performance Test

Query Performance Test

FAQs

Glossary

CTSDB Policy

Data Privacy and Security Agreement

DescribeDatabases

PDF

Focus Mode

Font Size

Last updated: 2025-10-28 22:20:19

1. API Description

Domain name for API request: ctsdb.intl.tencentcloudapi.com.

This API is used to query the database list.

  "Database":{
    "ClusterID":"ctsdbi-rebg0ghl",
    "Name":"" //This API is used to query all databases under the instance if the parameter is not specified.
  }

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: DescribeDatabases.
Version	Yes	String	Common Params. The value used for this API: 2023-02-02.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
Database	Yes	Database	Database parameter.
PageSize	No	Integer	Pagination size.
PageNumber	No	Integer	Pagination page.

3. Output Parameters

Parameter Name	Type	Description
Databases	Array of Database	Database list.
TotalCount	Integer	Quantity.
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.

4. Example

Example1 Querying the Database List

This example shows you how to query the database list.

Input Example

POST / HTTP/1.1
Host: ctsdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<Common request parameters>

{
    "Database": {
        "ClusterID": "ctsdbi-xxxxxxx",
        "Name": "Test",
        "CoolDownInDays": 0,
        "RetentionInDays": 0,
        "Remark": "",
        "Status": 0,
        "CreatedAt": "2020-09-22T00:00:00+00:00",
        "UpdatedAt": "2020-09-22T00:00:00+00:00"
    },
    "PageSize": 10,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "Databases": [
            {
                "ClusterID": "ctsdbi-xxxxxxx",
                "Name": "testData",
                "CoolDownInDays": 0,
                "RetentionInDays": 0,
                "Remark": "test",
                "Status": 0,
                "CreatedAt": "2020-09-22T00:00:00+00:00",
                "UpdatedAt": "2020-09-22T00:00:00+00:00"
            }
        ],
        "TotalCount": 0,
        "RequestId": "requestxxxxxxxxx"
    }
}

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
AuthFailure	CAM signature/authentication error.
ResourceNotFound	The resource does not exist.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

TencentDB for CTSDB