Domain name for API request: cdwdoris.tencentcloudapi.com.
This API is used to get the list of clusters.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeInstances. |
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. |
SearchInstanceId | No | String | The name of the cluster ID for the search |
SearchInstanceName | No | String | The cluster name for the search |
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. |
SearchTags.N | No | Array of SearchTags | Search tag list |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total Number of Instances |
InstancesList | Array of InstanceInfo | Quantities of instances array |
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. |
This example shows you how to get all cluster list information under a certain user.
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<Common request parameters>
{
"Limit": 10,
"SearchInstanceName": "",
"SearchInstanceId": "",
"Offset": 0
}
{
"Response": {
"TotalCount": 0,
"InstancesList": [
{
"InstanceId": "abc",
"InstanceName": "abc",
"Status": "abc",
"Version": "abc",
"Region": "abc",
"Zone": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"PayMode": "abc",
"CreateTime": "abc",
"ExpireTime": "abc",
"MasterSummary": {
"Spec": "abc",
"NodeSize": 0,
"Core": 0,
"Memory": 0,
"Disk": 0,
"DiskType": "abc",
"DiskDesc": "abc",
"AttachCBSSpec": {
"DiskType": "abc",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": "abc"
},
"SubProductType": "abc",
"SpecCore": 0,
"SpecMemory": 0,
"DiskCount": 0,
"Encrypt": 0,
"MaxDiskSize": 0
},
"CoreSummary": {
"Spec": "abc",
"NodeSize": 0,
"Core": 0,
"Memory": 0,
"Disk": 0,
"DiskType": "abc",
"DiskDesc": "abc",
"AttachCBSSpec": {
"DiskType": "abc",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": "abc"
},
"SubProductType": "abc",
"SpecCore": 0,
"SpecMemory": 0,
"DiskCount": 0,
"Encrypt": 0,
"MaxDiskSize": 0
},
"HA": "abc",
"HaType": 0,
"AccessInfo": "abc",
"Id": 0,
"RegionId": 0,
"ZoneDesc": "abc",
"FlowMsg": "abc",
"StatusDesc": "abc",
"RenewFlag": true,
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"Monitor": "abc",
"HasClsTopic": true,
"ClsTopicId": "abc",
"ClsLogSetId": "abc",
"EnableXMLConfig": 0,
"RegionDesc": "abc",
"Eip": "abc",
"CosMoveFactor": 0,
"Kind": "abc",
"CosBucketName": "abc",
"CanAttachCbs": true,
"BuildVersion": "abc",
"Components": "abc"
}
],
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
本页内容是否解决了您的问题?