tencent cloud

APIs

DocumentaçãoAPIsCloud Log ServiceMachine Group APIsDescribeMachines

DescribeMachines

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-10 15:01:28

1. API Description

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

This API is used to get the status of a machine under the specified 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: DescribeMachines.
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 to query.

-Obtain the machine group ID by searching the machine group list (https://www.tencentcloud.com/document/api/614/56438?from_cn_redirect=1).
Filters.N No Array of Filter ip
-Filter by ip.
-Type: String
-Required: No

instance
-Filter by instance id.
-Type: String
-Required: No

version
- Filter by LogListener version.
-Type: String
-Required: No

status
- Filter by machine status.
-Type: String
-Optional: No.
-Available values: 0: offline, 1: normal

offlineTime
- Filter by machine offline time.
-Type: String
-Optional: No.
-Available values: 0: no offline time, 12: within 12 hours, 24: within a day, 48: within two days, 99: before two days

Each request can have up to 10 Filters. The upper limit of Filter.Values is 100.
Offset No Integer Pagination offset.
Limit No Integer Limit on the number of entries per page. A maximum of 100 entries are supported.

3. Output Parameters

Parameter Name Type Description
Machines Array of MachineInfo Group of machine status information
AutoUpdate Integer Whether the machine group has enabled automatic upgrade function. 0: Automatic upgrade not enabled; 1: Automatic upgrade enabled.
UpdateStartTime String Preset start time of automatic update of machine group
UpdateEndTime String Preset end time of automatic update of machine group
LatestAgentVersion String Latest LogListener version available to the current user
ServiceLogging Boolean Whether to enable the service log
TotalCount Integer Total number
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 Getting Machine Status

Input Example

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

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

Output Example

{
    "Response": {
        "Machines": [
            {
                "Ip": "10.10.10.10",
                "Status": 0,
                "Version": "2.1.0",
                "UpdateStatus": 0,
                "ErrCode": 0,
                "ErrMsg": "OK",
                "AutoUpdate": 1,
                "OfflineTime": "2020-12-18 11:17:28"
            }
        ],
        "AutoUpdate": 0,
        "UpdateStartTime": "00:00:00",
        "UpdateEndTime": "01:00:00",
        "LatestAgentVersion": "2.2.0",
        "ServiceLogging": true,
        "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.AgentVersionNotExist The agent version does not exist.
ResourceNotFound.MachineGroupNotExist The machine group does not exist.
Anterior: DescribeMachineGroupsPróximo: AddMachineGroupInfo

Ajuda e Suporte

Esta página foi útil?

comentários