Domain name for API request: cls.intl.tencentcloudapi.com.
Modify machine group.
Note: Modifying the interface will directly overwrite historical data and change it to valid input parameters this time. Please be cautious when calling this API.
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: ModifyMachineGroup. |
| 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. |
| GroupId | Yes | String | Machine group Id -Obtain the machine group Id through Get Machine Group List. |
| GroupName | No | String | machine group name Input limit: -Cannot be an empty string -Cannot contain character ' |
| MachineGroupType | No | MachineGroupTypeInfo | Machine group type. Type: ip; Values contains the string list of IP machines. Type: label. Values contains the string list of tag machine groups. |
| Tags.N | No | Array of Tag | Tag list |
| AutoUpdate | No | Boolean | Whether to enable automatic update for the machine group |
| 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 the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset cls_service_logging and the loglistener_status, loglistener_alarm, and loglistener_business log topics will be created, which will not incur fees. |
| DelayCleanupTime | No | Integer | Periodic offline cleanup time for machines in a machine group. Unit: day |
| MetaTags.N | No | Array of MetaTagInfo | Metadata information list of a machine group |
| Parameter Name | Type | Description |
|---|---|---|
| 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 modify a machine group.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMachineGroup
<Common request parameters>
{
"GroupId": "57f5808c-4a55-11eb-b378-0242ac130002",
"GroupName": "testgroup"
}
{
"Response": {
"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.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. |
| ResourceNotFound.MachineGroupNotExist | The machine group does not exist. |
文档反馈