DescribeConfigMachineGroups

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

1. API Description

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

This API is used to get the machine group bound to a collection rule configuration.

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: DescribeConfigMachineGroups.
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.
ConfigId Yes String Collection configuration ID

3. Output Parameters

Parameter Name Type Description
MachineGroups Array of MachineGroupInfo List of machine groups bound to the collection rule configuration
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting machine group bound to collection rule configuration

Input Example

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

{
    "ConfigId": "xxxxxxxxxx"
}

Output Example

{
  "Response": {
    "MachineGroups": [
      {
        "GroupId": "xxxx-xx-xx-xx-yyyyyyyy",
        "GroupName": "testgroup",
        "MachineGroupType": {
          "Type": "ip",
          "Values": [
            "10.10.1.119"
          ]
        },
        "CreateTime": "xx"
      }
    ],
    "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.
InvalidParameterValue Incorrect parameter value.
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 The resource does not exist.
ResourceNotFound.ConfigNotExist The specified collection rule configuration does not exist.