tencent cloud

All product documents
APIs
DocumentationAPIsCloud Log ServiceMachine Group APIsCreateMachineGroup
CreateMachineGroup
Last updated: 2024-04-15 19:58:30
CreateMachineGroup
Last updated: 2024-04-15 19:58:30

1. API Description

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

This API is used to create 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 Params. The value used for this API: CreateMachineGroup.
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.
GroupName Yes String Machine group name, which must be unique
MachineGroupType Yes MachineGroupTypeInfo Type of the machine group to be created. Valid values: ip: use the IP string list in Values to create a machine group; label: use the tag string list in Values to create a machine group
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 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
DelayCleanupTime No Integer Offline cleaning time for machines in machine group
MetaTags.N No Array of MetaTagInfo Metadata information list of a machine group
OSType No Integer System type, default 0, 0: Linux, 1: Windows

3. Output Parameters

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.

4. Example

Example1 Creating a Machine Group

This example shows you how to create a machine group.

Input Example

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

{
    "GroupName": "testname",
    "MachineGroupType": {
        "Type": "ip",
        "Values": [
            "10.10.1.119"
        ]
    }
}

Output Example

{
    "Response": {
        "GroupId": "57f5808c-4a55-11eb-b378-0242ac130002",
        "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

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 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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon