- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Development Guide
- Design of Data Table
- Importing Data
- Import Overview
- Import Methods
- Synchronizing Data with JDBC
- Synchronizing Data Through External Tables
- Real-time or Batch Writing of MySQL Data
- Importing Data from Kafka
- Importing with DataX
- Importing Doris from Logstash
- Data Transformation, Column Mapping and Filtering
- Importing Strict Mode
- Importing Data in JSON Format
- Exporting Data
- Basic Feature
- Query Optimization
- Ecological Expansion Feature
- API Documentation
- Product Policy
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Development Guide
- Design of Data Table
- Importing Data
- Import Overview
- Import Methods
- Synchronizing Data with JDBC
- Synchronizing Data Through External Tables
- Real-time or Batch Writing of MySQL Data
- Importing Data from Kafka
- Importing with DataX
- Importing Doris from Logstash
- Data Transformation, Column Mapping and Filtering
- Importing Strict Mode
- Importing Data in JSON Format
- Exporting Data
- Basic Feature
- Query Optimization
- Ecological Expansion Feature
- API Documentation
- Product Policy
1. API Description
Domain name for API request: cdwdoris.tencentcloudapi.com.
This API is used to get the list of cluster node information.
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: DescribeInstanceNodes. |
| 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 |
| NodeRole | No | String | Cluster role type, defaulted as "data node". |
| Offset | No | Integer | Pagination parameters. The first page is 0, and the second page is 10. |
| Limit | No | Integer | Pagination parameters. The pagination step length is 10 by default. |
| DisplayPolicy | No | String | Display policy, and all items are displayed when All is selected. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| InstanceNodesList | Array of InstanceNode | Total number of instance nodes Note: This field may return null, indicating that no valid values can be obtained. |
| 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 List of Cluster Node Information
This example shows you how to get a list of cluster node information.
Input Example
https://cdwdoris.tencentcloudapi.com/?Action=DescribeInstanceNodes
&InstanceId=cdwch-12345678
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 0,
"InstanceNodesList": [
{
"Ip": "abc",
"Spec": "abc",
"Core": 0,
"Memory": 0,
"DiskType": "abc",
"DiskSize": 0,
"Role": "abc",
"Status": "abc",
"Rip": "abc",
"FeRole": "abc",
"UUID": "abc"
}
],
"RequestId": "abc"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.
Yes
No
Was this page helpful?