tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdatePrometheusAgentStatus

Last updated: 2023-08-11 16:09:02

1. API Description

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

This API is used to update the status of a Prometheus CVM 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: UpdatePrometheusAgentStatus.
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 TMP instance ID, such as “prom-abcd1234”.
AgentIds.N Yes Array of String List of agent IDs such as “agent-abcd1234”, which can be obtained on the Agent Management page in the console.
Status Yes Integer Status to update
  • 1 = enabled
  • 2 = disabled

    • 3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Updating the status of a Prometheus agent

    Input Example

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

{
    "InstanceId": "prom-abcd1234",
    "AgentIds": [
        "agent-abcd1234"
    ],
    "Status": 1
}

    Output Example

    {
    "Response": {
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
    }
}

    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
    FailedOperation Operation failed.
    FailedOperation.DbQueryFailed Failed to query the database.
    FailedOperation.DbRecordUpdateFailed Failed to update the database record.
    FailedOperation.ResourceNotFound The resource does not exist.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource is not found.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy