Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to create a machine group.
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: CreateMachineGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GroupName | Yes | String | Machine group name. Input limit: -Supports up to 255 characters and cannot be an empty string -Cannot contain character ' |
| MachineGroupType | Yes | MachineGroupTypeInfo | Create machine group type. Values are as follows: -Type: ip. Create a machine group with a string list of IPs in Values. -Type: label. Create a machine group with a string list of tags in Values. |
| Tags.N | No | Array of Tag | Tag description list. This parameter is used to bind a tag to a machine group. Up to 10 tag key-value pairs are supported, and a resource can be bound to only one tag key. |
| AutoUpdate | No | Boolean | Whether to enable machine group auto-update. Default false. |
| UpdateStartTime | No | String | Start time of upgrade. It is suggested to upgrade LogListener in the off-peak period of the business. Time format: HH:mm:ss. |
| UpdateEndTime | No | String | End time of upgrade. It is suggested to upgrade LogListener in the off-peak period of the business. Time format: HH:mm:ss. |
| ServiceLogging | No | Boolean | Whether to enable service logs, which is used to record logs generated by the Loglistener service itself. After enabling, it will create an internal logset named cls_service_logging and log topics named loglistener_status, loglistener_alarm, and loglistener_business, without incurring charges. The default value is false. |
| DelayCleanupTime | No | Integer | Offline cleanup time for machines in the machine group, in days. -This parameter is valid only when larger than 0. |
| MetaTags.N | No | Array of MetaTagInfo | Metadata information list of a machine group |
| OSType | No | Integer | System type. Values as follows: -0: Linux (default value) - 1:Windows |
| Parameter Name | Type | Description |
|---|---|---|
| GroupId | String | Machine group ID |
| 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 create a machine group.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMachineGroup
<Common request parameters>
{
"GroupName": "testname",
"MachineGroupType": {
"Type": "ip",
"Values": [
"10.10.1.119"
]
}
}
{
"Response": {
"GroupId": "57f5808c-4a55-11eb-b378-0242ac130002",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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.Timeout | Operation timed out |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.MachineGroupConflict | The same machine group already exists. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit has been reached. |
| LimitExceeded.MachineGroup | The number of machine groups exceeds the limit. |
| LimitExceeded.MachineGroupIp | The number of machine group IPs exceeds the limit. |
| LimitExceeded.MachineGroupIpLabels | The number of machine group labels exceeds the limit. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
文档反馈