1. 接口描述
接口请求域名： monitor.tencentcloudapi.com 。
Prometheus 内部动态 api 代理，支持以云api形式访问prometheus原生api
支持以下api:
注意：读接口建议使用ExportPrometheusReadOnlyDynamicAPI调用，支持更长的查询时延与响应大小。同时便于权限管理
| path | method | 用途 |
|---|---|---|
| /api/v1/query | GET, POST | 点查询 |
| /api/v1/query_range | GET, POST | 范围查询 |
| /api/v1/series | GET, POST | series列表查询 |
| /api/v1/labels | GET, POST | label名查询 |
| /api/v1/label/{label_name}/values | GET | label值查询 |
| /api/v1/rules | GET | 告警，预聚合规则查询 |
| /api/v1/user_limits | GET | prometheus实例限制查询 |
| /alertmanager/api/v2/alerts/groups | GET | 当前告警信息查询 |
| /alertmanager/api/v2/silences | GET, POST | 告警静默查询/创建/修改 |
| /alertmanager/api/v2/silence/{id} | GET, DELETE | 告警静默详情查询/删除 |
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RoutePrometheusDynamicAPI。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | Prometheus 实例 ID 示例值：prom-xxxxxxxx |
| Method | 是 | String | HTTP 方法名 GET/POST/PUT/DELETE 等 示例值：GET |
| Path | 是 | String | HTTP 路径（包括 query string） 示例值：/api/v1/query?query=up |
| RequestBody | 否 | String | HTTP 请求体，任何数据 示例值：{"key": "value"} |
| Headers.N | 否 | Array of PrometheusStringKeyValuePair | HTTP 请求头 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| HTTP | PrometheusDynamicAPIResponseHTTP | HTTP 响应数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Labels值查询
Path: /api/v1/label/<label_name>/values
Method: GET
Query参数:
1. match[] = <series_selector> prometheus查询表达式，返回匹配的时间线
2. start = <rfc3339 | unix_timestamp> 查询起始时间
3. end = <rfc3339 | unix_timestamp> 查询结束时间 (结束时间要晚于起始时间)
响应体:
{
"status": "success" | "error",
"data": [
// match[] 匹配到的key为label_name的所有值
"value1",
"value2"
// ...
],
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "GET",
"Path": "/api/v1/label/__name__/values?match[]=up&match[]=ALERTS{}"
}输出示例
{
"Response": {
"HTTP": {
"StatusCode": 200,
"ResponseBody": "{\"status\":\"success\",\"data\":[\"ALERTS\",\"up\"]}"
},
"RequestId": "3q393dqikzp-mebz4bi9xsta9zzb7q54"
}
}示例2 Labels查询
Path: /api/v1/labels
Method: GET POST
Query参数:
1. match[] = <series_selector> prometheus查询表达式，返回匹配的时间线
2. start = <rfc3339 | unix_timestamp> 查询起始时间
3. end = <rfc3339 | unix_timestamp> 查询结束时间 (结束时间要晚于起始时间)
响应体:
{
"status": "success" | "error",
"data": [
// match[] 匹配到的所有label name
"__name__",
"job"
// ...
],
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "POST",
"Path": "/api/v1/labels?match[]=up&match[]=ALERTS{}"
}输出示例
{
"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-"
}
}示例3 时间线查询 GET
Path: /api/v1/series
Method: GET POST
Query参数:
1. match[] = <series_selector> prometheus查询表达式，返回匹配的时间线
2. start = <rfc3339 | unix_timestamp> 查询起始时间
3. end = <rfc3339 | unix_timestamp> 查询结束时间 (结束时间要晚于起始时间)
响应体:
{
"status": "success" | "error",
"data": [
{
"__name__": <string>,
// series labels ...,
"job": "xxx",
"instance": "xxx"
}
],
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "GET",
"Path": "/api/v1/series?match[]=up&match[]=ALERTS{}"
}输出示例
{
"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"
}
}示例4 时间线查询 POST
同时间线查询GET
在match[]参数过长时可以通过Content-Type: application/x-www-form-urlencoded，将查询参数放在请求体
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "POST",
"Path": "/api/v1/series",
"Headers": [
{
"Key": "Content-Type",
"Value": "application/x-www-form-urlencoded"
}
],
"RequestBody": "match[]=up&match[]=ALERTS{}"
}输出示例
{
"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"
}
}示例5 点查询(Instant query)
Path: api/v1/query
Method: GET POST
Query参数:
1. query = <string> prometheus查询表达式
2. time = <rfc3339 | unix_timestamp> 查询数据的时间
3. timeout = <duration> 超时时间 (1m / 5s / ...)
响应体:
{
"status": "success" | "error",
"data": {
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
},
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "GET",
"Path": "/api/v1/query?query=ALERTS{}&time=1700534157&timeout=30s"
}输出示例
{
"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"
}
}示例6 范围查询(Range query)
Path: /api/v1/query_range
Method: GET POST
Query参数:
1. query = <string> prometheus查询表达式
2. start = <rfc3339 | unix_timestamp> 查询起始时间
3. end = <rfc3339 | unix_timestamp> 查询结束时间 (结束时间要晚于起始时间)
4. step = <duration | float> 查询步长 (1m / 15s / ... 或浮点数秒)
5. timeout = <duration> 超时时间 (1m / 5s / ...)
响应体:
{
"status": "success" | "error",
"data": {
"resultType": "matrix",
"result": <value>
},
// 错误时返回
"errorType": "<string>",
"error": "<string>",
// warning 信息
"warnings": ["<string>"]
}输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RoutePrometheusDynamicAPI
<公共请求参数>
{
"InstanceId": "prom-xz223asd",
"Method": "GET",
"Path": "/api/v1/query_range?query=ALERTS{}&start=1700535380&end=1700535680&step=1m&timeout=20s"
}输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.AccessCAMFail | 访问鉴权失败。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DataColumnNotFound | 数据表字段不存在。 |
| FailedOperation.DataQueryFailed | 数据查询失败。 |
| FailedOperation.DataTableNotFound | 数据表不存在。 |
| FailedOperation.DbQueryFailed | 数据库查询失败。 |
| FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
| FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
| FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
| FailedOperation.DbTransactionBeginFailed | 数据库事务开始失败。 |
| FailedOperation.DbTransactionCommitFailed | 数据库事务提交失败。 |
| FailedOperation.InstanceNotFound | 实例不存在。 |
| FailedOperation.InternalError | 内部服务错误。 |
| FailedOperation.ResourceNotFound | 资源不存在。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAppId | 无效的AppId。 |
| InvalidParameter.InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterParam | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
