查询指标目录
更新时间：2026-08-27
查询指标目录
查询指定云产品和资源类型下的指标目录及指标元数据。接口返回指标名称、资源标识维度、指标维度、采集周期和单位，可用于构造监控指标数据查询请求。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
Plain Text
1POST /v3/bcm?action=DescribeMetricCatalogs&locale=zh-cn HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "scope": "BCE_APIGW",
7 "resourceType": "Group",
8 "catalog": "GroupMonitoring",
9 "filters": [],
10 "includingDimensions": [],
11 "excludingDimensions": []
12}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v3 |
| locale | String | 否 | URL参数 | 返回名称的语言，可选值：zh-cn / en-us，默认值为zh-cn |
| scope | String | 是 | RequestBody参数 | 云产品标识，可通过DescribeResourceCatalogs接口获取，例如BCE_BCC |
| resourceType | String | 是 | RequestBody参数 | 资源类型标识，可通过DescribeResourceCatalogs接口获取，例如Instance |
| catalog | String | 否 | RequestBody参数 | 一级指标目录名称。按名称过滤目录时使用，名称匹配不区分大小写 |
| filters | List<MetricFilter> | 否 | RequestBody参数 | 指标属性过滤条件列表。多个条件之间为AND关系，可根据指标标签或指标维度过滤 |
| filters[].key | String | 是 | RequestBody参数 | 过滤字段名称。配置filters时必填，可填写指标标签名称或指标维度名称 |
| filters[].op | String | 是 | RequestBody参数 | 过滤操作符，可选值：= / != / contains / in |
| filters[].value | String | 否 | RequestBody参数 | 单值过滤条件，用于=、!=或contains操作符。对指标维度使用空字符串时，可用于判断该维度是否存在 |
| filters[].values | List<String> | 否 | RequestBody参数 | 多值过滤条件，op为in时必填，匹配任意一个值即满足当前条件 |
| includingDimensions | List<String> | 否 | RequestBody参数 | 指标必须同时包含的指标维度列表 |
| excludingDimensions | List<String> | 否 | RequestBody参数 | 指标不能包含其中任意维度的指标维度列表 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 响应码 |
| message | String | 错误信息 |
| catalogs | List<MetricCatalog> | 指标目录列表。目录为树形结构，可通过catalogs字段递归包含子目录 |
| catalogs[].name | String | 指标目录名称 |
| catalogs[].label | String | 指标目录显示名称，根据locale返回中文或英文名称 |
| catalogs[].catalogs | List<MetricCatalog> | 当前目录下的子目录列表，结构与catalogs相同 |
| catalogs[].metrics | List<Metric> | 当前目录下的指标列表 |
| catalogs[].metrics[].name | String | 指标名称，可作为指标数据查询接口的metricNames参数 |
| catalogs[].metrics[].label | String | 指标显示名称，根据locale返回中文或英文名称 |
| catalogs[].metrics[].resourceIdentifiers | List<String> | 资源标识维度列表。查询指标数据时，过滤条件需要包含当前资源类型要求的全部资源标识维度 |
| catalogs[].metrics[].metricDimensions | List<String> | 除资源标识维度以外的指标维度列表，可用于进一步筛选时序数据 |
| catalogs[].metrics[].period | Double | 指标采集周期数值 |
| catalogs[].metrics[].periodUnit | String | 指标采集周期单位，例如s表示秒 |
| catalogs[].metrics[].unit | String | 指标值单位，根据locale返回中文或英文单位 |
请求示例
Plain Text
1POST /v3/bcm?action=DescribeMetricCatalogs&locale=zh-cn HTTP/1.1
2HOST bcm.bj.baidubce.com
3Authorization: bce-auth-v1/accessKeyId/2024-10-11T10:00:00Z/1800/host/signature
4
5{
6 "scope": "BCE_APIGW",
7 "resourceType": "Group"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 8a3b5c7d-1234-5678-abcd-ef0123456789
3Date: Fri, 11 Oct 2024 10:10:30 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK",
11 "message": "",
12 "catalogs": [
13 {
14 "name": "GroupMonitoring",
15 "label": "分组监控",
16 "catalogs": [
17 {
18 "name": "",
19 "label": "",
20 "catalogs": null,
21 "metrics": [
22 {
23 "name": "APIQps",
24 "label": "API调用量",
25 "resourceIdentifiers": ["GroupUuid"],
26 "metricDimensions": [],
27 "period": 60,
28 "periodUnit": "s",
29 "unit": "count/s"
30 },
31 {
32 "name": "ApiRtAvg",
33 "label": "API请求平均时延",
34 "resourceIdentifiers": ["GroupUuid"],
35 "metricDimensions": [],
36 "period": 60,
37 "periodUnit": "s",
38 "unit": "ms"
39 }
40 ]
41 }
42 ],
43 "metrics": null
44 }
45 ]
46}评价此篇文章