tencent cloud



Last updated: 2023-03-14 16:55:47

1. API Description

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

This API is used to query the status of the TAT agent.

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: DescribeAutomationAgentStatus.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region No String Common Params. This parameter is not required for this API.
InstanceIds.N No Array of String List of instance IDs for the query.
Filters.N No Array of Filter Filter conditions.
  • agent-status - String - Required: No - (Filter condition) Filter by agent status. Valid values: Online, Offline.
  • environment - String - Required: No - (Filter condition) Filter by the agent environment. Valid value: Linux.
  • instance-id - String - Required: No - (Filter condition) Filter by the instance ID.
    Up to 10 Filters allowed in one request. For each filter, five Filter.Values can be specified. InstanceIds and Filters cannot be specified at the same time.
  • Limit No Integer Number of returned results. It defaults to 20. The maximum is 100. For more information on Limit, see the relevant section in the API Overview.
    Offset No Integer Offset. The default value is 0. For more information on Offset, see the relevant section in API Introduction.

    3. Output Parameters

    Parameter Name Type Description
    AutomationAgentSet Array of AutomationAgentInfo Agent information list.
    TotalCount Integer Total number of matching agents.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the agent status

    Input Example

    POST / HTTP/1.1
    Host: tat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAutomationAgentStatus
    <Common request parameters>
        "InstanceIds": [

    Output Example

        "Response": {
            "RequestId": "520e7b93-904d-44de-a2dd-8e4c545be4ce",
            "AutomationAgentSet": [
                    "InstanceId": "lhins-ar5wyn4x",
                    "Version": "0.1.0",
                    "LastHeartbeatTime": "2020-11-16T12:05:44+00:00",
                    "AgentStatus": "Online",
                    "Environment": "Linux"
            "TotalCount": 1

    5. Developer Resources


    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
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.ConflictParameter Conflicting parameters.
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.InvalidFilter Invalid filter.
    InvalidParameterValue.InvalidInstanceId Invalid instance ID.
    InvalidParameterValue.LimitExceeded Parameter limit exceeded.
    UnauthorizedOperation.CamAuthFailed CAM authentication failed.
    UnauthorizedOperation.InvalidToken Invalid token.
    UnauthorizedOperation.MFAExpired The Multi-factor authentication (MFA) code expired.
    UnauthorizedOperation.MFANotFound Multi-factor authentication (MFA) does not exist.
    Contact Us

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

    Technical Support

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

    7x24 Phone Support