Domain name for API request: cls.tencentcloudapi.com.
This API is used to get the list of machine groups.
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: DescribeMachineGroups. |
Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
Region | No | String | Common Params. This parameter is not required for this API. |
Filters.N | No | Array of Filter | machineGroupName - Filter by [Machine Group Name]. - Type: String - Required: No machineGroupId - Filter by [Machine group ID]. - Type: String - Required: No osType - Filter by [Operating System Type]. - Type: Int - Required: No tagKey - Filter by [Tag key]. - Type: String - Required: No tag:tagKey - Filter by [Tag key-value pair]. Replace tagKey with the specific Tag key.- Type: String - Required: No The maximum number of Filters per request is 10, and the maximum for Filter.Values is 5. |
Offset | No | Integer | Page offset. Default value: 0 |
Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100 |
Parameter Name | Type | Description |
---|---|---|
MachineGroups | Array of MachineGroupInfo | Machine group information list Note: This field may return "null", indicating that no valid values can be obtained. |
TotalCount | Integer | Total number of pages |
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 a list of machine groups containing specified tags.
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMachineGroups
<Common request parameters>
{
"Filters": [
{
"Key": "tagKey",
"Values": [
"k1"
]
}
],
"Offset": 0,
"Limit": 10
}
{
"Response": {
"MachineGroups": [
{
"GroupId": "4a4ee397-xxxx-466f-a04c-b3413b9db40c",
"GroupName": "cos-recharge",
"MachineGroupType": {
"Type": "label",
"Values": [
"cos-recharge"
]
},
"CreateTime": "2022-02-13 21:07:54",
"AutoUpdate": "",
"UpdateStartTime": "",
"UpdateEndTime": "",
"ServiceLogging": true,
"MetaTags": [],
"Tags": []
}
],
"TotalCount": 1,
"RequestId": "2dc17eaa-xxxx-40ea-8cdc-650aa85ccb80"
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error. |
FailedOperation | Operation failed. |
FailedOperation.TagQpsLimit | The frequency of tag service requests is limited. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameterValue | Incorrect parameter value. |
OperationDenied | Operation denied. |
OperationDenied.AccountDestroy | The account has been terminated. |
OperationDenied.AccountIsolate | The account has overdue payments. |
OperationDenied.AccountNotExists | The account does not exist. |
UnsupportedOperation | Unsupported operation. |
本页内容是否解决了您的问题?