ModifyMachineGroup

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-11-30 16:26:37

Download PDF

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to modify a machine group.

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 parameter. The value used for this API: ModifyMachineGroup.
Version	Yes	String	Common parameter. The value used for this API: 2020-10-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
GroupId	Yes	String	Machine group ID
GroupName	No	String	Machine group name
MachineGroupType	No	MachineGroupTypeInfo	Machine group type
Tags.N	No	Array of Tag	Tag list
AutoUpdate	No	Boolean	Whether to enable automatic update for the machine group
UpdateStartTime	No	String	Update start time. We recommend you update LogListener during off-peak hours.
UpdateEndTime	No	String	Update end time. We recommend you update LogListener during off-peak hours.
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.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying machine group

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMachineGroup
<Common request parameters>

{
    "GroupId": "57f5808c-4a55-11eb-b378-0242ac130002",
    "GroupName": "testgroup"
}

Output Example

{
  "Response": {
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.
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.MachineGroupLabels	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.

Recent Pages