tencent cloud

Tencent Cloud TCHouse-D

Product Introduction
Overview
Concepts
Cluster Architecture
Strengths
Scenarios
Purchase Guide
Billing Overview
Renewal Instructions
Overdue Policy
Refund Instructions
Configuration Adjustment Billing Instructions
Getting Started
Using Tencent Cloud TCHouse-D Through the Console
Using Tencent Cloud TCHouse-D Through a Client
Operation Guide
Cluster Operation
Monitoring and Alarm Configuration
Account Privilege Management
Data Management
Query Management
Modify Configurations
Node Management
Log Analysis
SQL Studio
Enabling Resource Isolation
Development Guide
Design of Data Table
Importing Data
Exporting Data
Basic Feature
Query Optimization
Ecological Expansion Feature
API Documentation
History
Introduction
API Category
Making API Requests
Cluster Operation APIs
Database and Table APIs
Cluster Information Viewing APIs
Hot-Cold Data Layering APIs
Database and Operation Audit APIs
User and Permission APIs
Resource Group Management APIs
Data Types
Error Codes
Cloud Ecosystem
Granting CAM Policies to Sub-accounts
Query Acceleration for Tencent Cloud DLC
Practical Tutorial
Basic Feature Usage
Advanced Features Usage
Resource Specification Selection and Optimization Suggestions
Naming Specifications and Limits to the Database and Data Table
Table Design and Data Import
Query Optimization
Suggested Usage to Avoid
Accessing TCHouse-D via JDBC over the Public Network
Performance Testing
TPC-H Performance Testing
SSB Performance Testing
TPC-DS Performance Testing
FAQs
Common Operational Issues
Common Errors
Contact Us
Glossary
Product Policy
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
ドキュメントTencent Cloud TCHouse-DAPI DocumentationCluster Information Viewing APIsDescribeClusterConfigs

DescribeClusterConfigs

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-30 21:32:30

1. API Description

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

This API is used to get the contents of the latest configuration files (config.xml, metrika.xml, and user.xml) of the cluster and display them to the user.

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: DescribeClusterConfigs.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Cluster instance ID
ConfigType No Integer 0 indicates public cloud query, and 1 Qinge query. Qinge query shows all that needs to be displayed.
FileName No String Search for files with fuzzy keywords
ClusterConfigType No Integer 0 indicates cluster dimension and 1 node dimension
IPAddress No String eth0's IP address

3. Output Parameters

Parameter Name Type Description
ClusterConfList Array of ClusterConfigsInfoFromEMR Return information about the instance's configuration file.
BuildVersion String Return the current kernel version. If it does not exist, a null character string is returned.
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 Getting Cluster Configuration File Content

This example shows you how to obtain the cluster configuration file content when modifying it in XML format.

Input Example

https://cdwdoris.intl.tencentcloudapi.com/
?Action=DescribeClusterConfigs
&InstanceId=cdwch-xxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "ClusterConfList": [
            {
                "NeedRestart": 1,
                "OriParam": "ss=sc",
                "KeyConf": "ss=sc",
                "FileConf": "ss=sc",
                "FileName": "test"
            }
        ],
        "RequestId": "xx-aa"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

前の記事へ: UpdateDatabase次の記事へ: DescribeAreaRegion

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック