tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribePrometheusGlobalConfig

Last updated: 2024-11-26 16:51:51

    1. API Description

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

    This API is used to get the instance-level scrape configurations.

    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: DescribePrometheusGlobalConfig.
    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-level scrape configuration
    DisableStatistics No Boolean Whether to disable statistics

    3. Output Parameters

    Parameter Name Type Description
    Config String Configuration content
    ServiceMonitors Array of PrometheusConfigItem List of service monitors and the corresponding targets information
    Note: This field may return null, indicating that no valid values can be obtained.
    PodMonitors Array of PrometheusConfigItem List of pod monitors and the corresponding targets information
    Note: This field may return null, indicating that no valid values can be obtained.
    RawJobs Array of PrometheusConfigItem List of raw jobs and the corresponding targets information
    Note: This field may return null, indicating that no valid values can be obtained.
    Probes Array of PrometheusConfigItem List of probes and the corresponding targets information
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Obtaining the instance-level monitoring configurations

    This example shows you how to obtain the instance-level monitoring configurations.

    Input Example

    https://monitor.intl.tencentcloudapi.com/?Action=DescribePrometheusGlobalConfig
&InstanceId=prom-xxx
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Config": "abc",
        "ServiceMonitors": [
            {
                "Name": "abc",
                "Config": "abc",
                "TemplateId": "abc"
            }
        ],
        "PodMonitors": [
            {
                "Name": "abc",
                "Config": "abc",
                "TemplateId": "abc"
            }
        ],
        "RawJobs": [
            {
                "Name": "abc",
                "Config": "abc",
                "TemplateId": "abc"
            }
        ],
        "Probes": [
            {
                "Name": "abc",
                "Config": "abc",
                "TemplateId": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    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.ComponentClientCommon FailedOperation.ComponentClientCommon
    FailedOperation.ComponentClientHttp FailedOperation.ComponentClientHttp
    FailedOperation.DoTRPCTransferFailed DoTRPCTransferFailed
    FailedOperation.KubeCommon FailedOperation.KubeCommon
    InternalError Internal error.
    InternalError.Db InternalError.Db
    InternalError.Param InternalError.Param
    InternalError.UnexpectedInternal InternalError.UnexpectedInternal
    InvalidParameter Invalid parameter.
    InvalidParameter.ClusterNotFound InvalidParameter.ClusterNotFound
    InvalidParameter.Param InvalidParameter.Param
    InvalidParameter.PromInstanceNotFound InvalidParameter.PromInstanceNotFound
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy