tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribePrometheusScrapeJobs

Last updated: 2024-11-26 16:52:15

    1. API Description

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

    This API is used to list Prometheus scrape tasks.

    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: DescribePrometheusScrapeJobs.
    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.
    InstanceId Yes String Instance ID
    AgentId Yes String Agent ID
    Name No String Task name
    JobIds.N No Array of String List of task 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
    ScrapeJobSet Array of PrometheusScrapeJob List of tasks
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer Total number of tasks
    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 Listing Prometheus scrape tasks

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

    Input Example

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

{
    "InstanceId": "prom-evrh1x32",
    "AgentId": "agent-hod16m43"
}

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "RequestId": "5fa8c92-3072-4f46-8553-4cb82c30943c",
        "ScrapeJobSet": [
            {
                "AgentId": "agent-hod16m43",
                "Config": "job_name: static\nhonor_timestamps: true\nmetrics_path: /metrics\nscheme: http\nfollow_redirects: true\nstatic_configs:\n- targets:\n  - localhost:9090\n",
                "Name": "node-exporter",
                "JobId": "job-afeiig0k"
            }
        ]
    }
}

    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.BadYamlFormat The YAML format is incorrect.
    FailedOperation.DbQueryFailed Failed to query the database.
    FailedOperation.DbRecordCreateFailed Failed to create the database record.
    FailedOperation.DbRecordDeleteFailed Failed to delete the database record.
    FailedOperation.DbRecordUpdateFailed Failed to update the database record.
    FailedOperation.ResourceNotFound The resource does not exist.
    InternalError Internal error.
    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