tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeMachines

Last updated: 2024-04-15 19:58:29

    1. API Description

    Domain name for API request: cls.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 No String Common Params. This parameter is not required for this API.
    GroupId Yes String ID of the machine group to be queried

    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
    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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy