tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Observability Platform
    Documentation
    Download PDF

    DescribePrometheusAgents

    Last updated: 2023-08-11 16:09:06
    Download PDF

    1. API Description

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

    This API is used to list Prometheus CVM agents.

    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: DescribePrometheusAgents.
    Version Yes String Common Params. The value used for this API: 2018-07-24.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
    InstanceId Yes String Instance ID
    Name No String Agent name
    AgentIds.N No Array of String List of agent IDs
    Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    AgentSet Array of PrometheusAgent List of agents
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of agents
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Listing Prometheus agents

    This example shows you how to query the list of Prometheus agents.

    Input Example

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

{
    "InstanceId": "prom-m4fb9h34"
}

    Output Example

    {
    "Response": {
        "AgentSet": [
            {
                "AgentId": "agent-hod16m34",
                "Name": "node-agent",
                "InstanceId": "prom-m4fb9h34",
                "HeartbeatTime": "2021-12-03T16:16:24+08:00",
                "Ipv4": "199.21.24.90",
                "LastError": "",
                "AgentVersion": "2.31.1-rig.1"
            }
        ],
        "RequestId": "e6a09531-0b40-41ab-a932-33061e9e1832",
        "TotalCount": 12
    }
}

    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 Error with CAM signature/authentication.
    FailedOperation Operation failed.
    FailedOperation.DbQueryFailed Failed to query the database.
    FailedOperation.DbRecordUpdateFailed Failed to update the database record.
    FailedOperation.DbTransactionBeginFailed Failed to start the database transaction.
    FailedOperation.ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource is not found.
    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 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy