tencent cloud

腾讯云可观测平台

文档腾讯云可观测平台API 文档TMP APIsRoutePrometheusDynamicAPI

RoutePrometheusDynamicAPI

Download
聚焦模式
字号
最后更新时间： 2026-07-01 17:30:17

1. API Description

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

Prometheus internal dynamics api proxy supports accessing Prometheus native APIs via cloud APIs.
support the following APIs:

It is recommended to use the ExportPrometheusReadOnlyDynamicAPI call for Read API, supporting longer query latency and response size. Meanwhile, it makes permission management easy.

path method purpose
/api/v1/query GET, POST point query
/api/v1/query_range GET, POST Range query
/api/v1/series GET, POST Query the series list
/api/v1/labels GET, POST Query labels
/api/v1/label/{label_name}/values GET Query label values.
/api/v1/rules GET Query pre-aggregation and alert rules.
/api/v1/user_limits GET Query prometheus instance limits
/alertmanager/api/v2/alerts/groups GET Query current alarm information
/alertmanager/api/v2/silences GET, POST Query, create, or modify alert silences
/alertmanager/api/v2/silence/{id} GET, DELETE Query alert silence details, Delete alert silence

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: RoutePrometheusDynamicAPI.
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-bangkok, 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, sa-saopaulo.
InstanceId Yes String

Prometheus Instance ID
Method Yes String

HTTP method name GET/POST/PUT/DELETE
Path Yes String

HTTP path (including query string)
RequestBody No String

HTTP request body, any data
Headers.N No Array of PrometheusStringKeyValuePair

HTTP headers

3. Output Parameters

Parameter Name Type Description
HTTP PrometheusDynamicAPIResponseHTTP

HTTP response data
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 Querying Label Values

Path: /api/v1/label/<label_name>/values
Method: GET
Query parameter 
1. match[] = <series_selector> prometheus query expression, returns matching timeline
2. start = <rfc3339 | unix_timestamp> Query start time
3. end = <rfc3339 | unix_timestamp> End time of the query (End time must be later than start time)
response body
{
    "status": "success" | "error",
    "data": [
        all values where the matched key is label_name
        "value1",
        "value2"
        // ...
    ],

    return on error
    "errorType": "<string>",
    "error": "<string>",

    warning message
    "warnings": ["<string>"]
}

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "GET",
    "Path": "/api/v1/label/__name__/values?match[]=up&match[]=ALERTS{}"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":[\"ALERTS\",\"up\"]}"
        },
        "RequestId": "3q393dqikzp-mebz4bi9xsta9zzb7q54"
    }
}

Example2 Querying Labels

Path: /api/v1/labels
Method: GET POST
Query parameter 
1. match[] = <series_selector> prometheus query expression, returns matching timeline
2. start = <rfc3339 | unix_timestamp> Query start time
3. end = <rfc3339 | unix_timestamp> End time of the query (End time must be later than start time)
response body
{
    "status": "success" | "error",
    "data": [
        // match[] ALL matched label names
        "__name__",
        "job"
        // ...
    ],

    return on error
    "errorType": "<string>",
    "error": "<string>",

    warning message
    "warnings": ["<string>"]
}

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "POST",
    "Path": "/api/v1/labels?match[]=up&match[]=ALERTS{}"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":[\"__name__\",\"_appid_\",\"_instanceid_\",\"_interval_\",\"_language_\",\"_policyid_\",\"_policyname_\",\"_region_\",\"_regionid_\",\"_subaccountuin_\",\"_uin_\",\"alertName\",\"alertname\",\"alertstate\",\"beta_kubernetes_io_arch\",\"beta_kubernetes_io_instance_type\",\"beta_kubernetes_io_os\",\"c\",\"cloud_tencent_com_node_instance_id\",\"cluster\",\"cluster_type\",\"container\",\"endpoint\",\"failure_domain_beta_kubernetes_io_region\",\"failure_domain_beta_kubernetes_io_zone\",\"instance\",\"job\",\"kubernetes_io_arch\",\"kubernetes_io_hostname\",\"kubernetes_io_os\",\"namespace\",\"node\",\"node_kubernetes_io_instance_type\",\"notification\",\"notify_way\",\"pod\",\"service\",\"severity\",\"tcloud_region_id\",\"tcloud_region_name\",\"tke_cloud_tencent_com_cbs_mountable\",\"tke_scene_flag\",\"topology_com_tencent_cloud_csi_cbs_zone\",\"topology_kubernetes_io_region\",\"topology_kubernetes_io_zone\"]}"
        },
        "RequestId": "92rmr4l74y37llzqc2nz-mn8usc93qq-"
    }
}

Example3 Performing a Timeline Query (GET)

Path: /api/v1/series
Method: GET POST
Query parameter 
1. match[] = <series_selector> prometheus query expression, returns matching timeline
2. start = <rfc3339 | unix_timestamp> Query start time
3. end = <rfc3339 | unix_timestamp> End time of the query (End time must be later than start time)
response body
{
    "status": "success" | "error",
    "data": [
        {
            "__name__": <string>,
            // series labels ...,
            "job": "xxx",
            "instance": "xxx"
        }
    ],

    return on error
    "errorType": "<string>",
    "error": "<string>",

    warning message
    "warnings": ["<string>"]
}

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "GET",
    "Path": "/api/v1/series?match[]=up&match[]=ALERTS{}"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":[{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_interval_\":\"5m\",\"_language_\":\"zh-CN\",\"_policyid_\":\"arule-2wou7mfi\",\"_policyname_\":\"test-monitor-alert\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"test-monitor-alert\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"al-test-changed/aaaaa\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"al-test-changed/aaaaa\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-1\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-1\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-2\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-2\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-iw1k7u0g\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.196\",\"job\":\"cadvisor\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.196\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-iw1k7u0g\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.196\",\"job\":\"kubelet\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.196\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-ka1tk14k\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.185\",\"job\":\"cadvisor\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.185\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-ka1tk14k\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.185\",\"job\":\"kubelet\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.185\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"kube-state-metrics\",\"endpoint\":\"http-metrics\",\"instance\":\"172.19.0.23:8180\",\"job\":\"kube-state-metrics\",\"namespace\":\"kube-system\",\"pod\":\"tke-kube-state-metrics-0\",\"service\":\"tke-kube-state-metrics\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"node-exporter\",\"instance\":\"10.0.0.185\",\"job\":\"node-exporter\",\"namespace\":\"kube-system\",\"pod\":\"tke-node-exporter-rltlc\",\"service\":\"tke-node-exporter\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"node-exporter\",\"instance\":\"10.0.0.196\",\"job\":\"node-exporter\",\"namespace\":\"kube-system\",\"pod\":\"tke-node-exporter-4lcms\",\"service\":\"tke-node-exporter\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"instance\":\"10.0.0.3:9091\",\"job\":\"job1\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"instance\":\"10.0.0.3:9091\",\"job\":\"job2\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"}]}"
        },
        "RequestId": "g1sa-v1z--ebeavewsaenpmt8igv7trm"
    }
}

Example4 Performing a Timeline Query (POST)

GET timeline query

When the match[] parameter is too long, you can place the query parameter in the request body through Content-Type: application/x-www-form-urlencoded.

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "POST",
    "Path": "/api/v1/series",
    "Headers": [
        {
            "Key": "Content-Type",
            "Value": "application/x-www-form-urlencoded"
        }
    ],
    "RequestBody": "match[]=up&match[]=ALERTS{}"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":[{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_interval_\":\"5m\",\"_language_\":\"zh-CN\",\"_policyid_\":\"arule-2wou7mfi\",\"_policyname_\":\"test-monitor-alert\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"test-monitor-alert\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"al-test-changed/aaaaa\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"al-test-changed/aaaaa\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-1\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-1\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-2\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-2\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-iw1k7u0g\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.196\",\"job\":\"cadvisor\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.196\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-iw1k7u0g\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.196\",\"job\":\"kubelet\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.196\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-ka1tk14k\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.185\",\"job\":\"cadvisor\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.185\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"beta_kubernetes_io_arch\":\"amd64\",\"beta_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"beta_kubernetes_io_os\":\"linux\",\"cloud_tencent_com_node_instance_id\":\"ins-ka1tk14k\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"failure_domain_beta_kubernetes_io_region\":\"cq\",\"failure_domain_beta_kubernetes_io_zone\":\"190001\",\"instance\":\"10.0.0.185\",\"job\":\"kubelet\",\"kubernetes_io_arch\":\"amd64\",\"kubernetes_io_hostname\":\"10.0.0.185\",\"kubernetes_io_os\":\"linux\",\"node_kubernetes_io_instance_type\":\"S5.MEDIUM4\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_cloud_tencent_com_cbs_mountable\":\"true\",\"tke_scene_flag\":\"true\",\"topology_com_tencent_cloud_csi_cbs_zone\":\"ap-chongqing-1\",\"topology_kubernetes_io_region\":\"cq\",\"topology_kubernetes_io_zone\":\"190001\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"kube-state-metrics\",\"endpoint\":\"http-metrics\",\"instance\":\"172.19.0.23:8180\",\"job\":\"kube-state-metrics\",\"namespace\":\"kube-system\",\"pod\":\"tke-kube-state-metrics-0\",\"service\":\"tke-kube-state-metrics\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"node-exporter\",\"instance\":\"10.0.0.185\",\"job\":\"node-exporter\",\"namespace\":\"kube-system\",\"pod\":\"tke-node-exporter-rltlc\",\"service\":\"tke-node-exporter\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"container\":\"node-exporter\",\"instance\":\"10.0.0.196\",\"job\":\"node-exporter\",\"namespace\":\"kube-system\",\"pod\":\"tke-node-exporter-4lcms\",\"service\":\"tke-node-exporter\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"instance\":\"10.0.0.3:9091\",\"job\":\"job1\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"},{\"__name__\":\"up\",\"cluster\":\"cls-qzzzqko6\",\"cluster_type\":\"tke\",\"instance\":\"10.0.0.3:9091\",\"job\":\"job2\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\",\"tke_scene_flag\":\"true\"}]}"
        },
        "RequestId": "uv8-r34jqub--2zkzgtj3p26cwmjcjfw"
    }
}

Example5 Performing an Instant Query

Path: api/v1/query
Method: GET POST
Query parameter 
1. query = <string> prometheus query expression
2. time = <rfc3339 | unix_timestamp> The time when querying data
3. timeout = <duration> (1m / 5s / ...)
response body
{
    "status": "success" | "error",
    "data": {
        "resultType": "matrix" | "vector" | "scalar" | "string",
        "result": <value>
    },

    return on error
    "errorType": "<string>",
    "error": "<string>",

    warning message
    "warnings": ["<string>"]
}

Refer to the result field in the query result for the Prometheus instant query result encoding.

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "GET",
    "Path": "/api/v1/query?query=ALERTS{}&time=1700534157&timeout=30s"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":{\"resultType\":\"vector\",\"result\":[{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-2\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-2\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"value\":[1700534157,\"1\"]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_interval_\":\"5m\",\"_language_\":\"zh-CN\",\"_policyid_\":\"arule-2wou7mfi\",\"_policyname_\":\"test-monitor-alert\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"test-monitor-alert\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"value\":[1700534157,\"1\"]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"al-test-changed/aaaaa\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"al-test-changed/aaaaa\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"value\":[1700534157,\"1\"]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-1\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-1\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"value\":[1700534157,\"1\"]}]}}"
        },
        "RequestId": "8-ztbsc3gc2-rw6lzn4gfg5kuz6khrxg"
    }
}

Example6 Performing a Range Query

Path: /api/v1/query_range
Method: GET POST
Query parameter 
1. query = <string> prometheus query expression
2. start = <rfc3339 | unix_timestamp> Query start time
3. end = <rfc3339 | unix_timestamp> End time of the query (End time must be later than start time)
4. step = <duration | float> Query step length (1m / 15s / ... or floating point seconds)
5. timeout = <duration> Timeout period (1m / 5s / ...)
response body
{
    "status": "success" | "error",
    "data": {
        "resultType": "matrix",
        "result": <value>
    },

    return on error
    "errorType": "<string>",
    "error": "<string>",

    warning message
    "warnings": ["<string>"]
}

Query result field, see Prometheus range query result encoding

Input Example

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

{
    "InstanceId": "prom-xz223asd",
    "Method": "GET",
    "Path": "/api/v1/query_range?query=ALERTS{}&start=1700535380&end=1700535680&step=1m&timeout=20s"
}

Output Example

{
    "Response": {
        "HTTP": {
            "StatusCode": 200,
            "ResponseBody": "{\"status\":\"success\",\"data\":{\"resultType\":\"matrix\",\"result\":[{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_interval_\":\"5m\",\"_language_\":\"zh-CN\",\"_policyid_\":\"arule-2wou7mfi\",\"_policyname_\":\"test-monitor-alert\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"test-monitor-alert\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"values\":[[1700535380,\"1\"],[1700535440,\"1\"],[1700535500,\"1\"],[1700535560,\"1\"],[1700535620,\"1\"],[1700535680,\"1\"]]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"al-test-changed/aaaaa\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"100026263254\",\"_uin_\":\"1500000688\",\"alertname\":\"al-test-changed/aaaaa\",\"alertstate\":\"firing\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"values\":[[1700535380,\"1\"],[1700535440,\"1\"],[1700535500,\"1\"],[1700535560,\"1\"],[1700535620,\"1\"],[1700535680,\"1\"]]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-1\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-1\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"values\":[[1700535380,\"1\"],[1700535440,\"1\"],[1700535500,\"1\"],[1700535560,\"1\"],[1700535620,\"1\"],[1700535680,\"1\"]]},{\"metric\":{\"__name__\":\"ALERTS\",\"_appid_\":\"1251763868\",\"_instanceid_\":\"prom-7031abs0\",\"_language_\":\"zh-CN\",\"_policyname_\":\"alertgroup-in-tke/alert-2\",\"_region_\":\"ap-chongqing\",\"_regionid_\":\"19\",\"_subaccountuin_\":\"4611686018429437801\",\"_uin_\":\"1500000688\",\"alertname\":\"alertgroup-in-tke/alert-2\",\"alertstate\":\"firing\",\"severity\":\"warning\",\"tcloud_region_id\":\"19\",\"tcloud_region_name\":\"ap-chongqing\"},\"values\":[[1700535380,\"1\"],[1700535440,\"1\"],[1700535500,\"1\"],[1700535560,\"1\"],[1700535620,\"1\"],[1700535680,\"1\"]]}]}}"
        },
        "RequestId": "ms6le5eg5-l16rh6fr2f6r57h3eiolbh"
    }
}

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.
AuthFailure.AccessCAMFail Access authentication failed.
AuthFailure.UnauthorizedOperation The request is not authorized. For more information on the authentication, see the CAM documentation.
FailedOperation Operation failed.
FailedOperation.DataColumnNotFound The data table field doesn't exist.
FailedOperation.DataQueryFailed Failed to query the data.
FailedOperation.DataTableNotFound The data table doesn't exist.
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.DbTransactionBeginFailed Failed to start the database transaction.
FailedOperation.DbTransactionCommitFailed Failed to submit the database transaction.
FailedOperation.InstanceNotFound The instance does not exist.
FailedOperation.InternalError Internal service error.
FailedOperation.ResourceNotFound The resource does not exist.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.InvalidAppId Invalid AppId.
InvalidParameter.InvalidParameter Invalid parameter.
InvalidParameter.InvalidParameterParam Invalid parameter.
InvalidParameter.ParamError Incorrect parameter.
InvalidParameterValue The parameter value is incorrect.
LimitExceeded Quota limit is reached.
MissingParameter Missing parameter.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound The resource is not found.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
上一篇: ModifyPrometheusInstanceAttributes下一篇: ExportPrometheusReadOnlyDynamicAPI

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈