查询云产品资源目录
更新时间:2026-08-27
查询云产品资源目录
查询云监控支持的云产品、资源类型及地域目录。接口返回的 scope 和 resourceType 可用于后续查询指标目录和监控指标数据。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v3/bcm?action=DescribeResourceCatalogs&locale=zh-cn HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
4
5{}
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为v3 |
| locale | String | 否 | URL参数 | 返回名称的语言,可选值:zh-cn / en-us,默认值为zh-cn |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 响应码 |
| message | String | 错误信息 |
| catalogs | List<ResourceCatalog> | 云产品资源目录列表 |
| catalogs[].scope | String | 云产品标识,可作为指标查询接口的scope参数 |
| catalogs[].scopeLabel | String | 云产品显示名称,根据locale返回中文或英文名称 |
| catalogs[].resources | List<ResourceCatalogItem> | 云产品下的资源类型列表 |
| catalogs[].resources[].resourceType | String | 资源类型标识,可作为指标查询接口的resourceType参数 |
| catalogs[].resources[].resourceTypeLabel | String | 资源类型显示名称,根据locale返回中文或英文名称 |
| catalogs[].regions | List<String> | 云产品适用的地域列表。仅配置了固定地域信息时返回;例如全局产品返回global |
请求示例
Plain Text
1POST /v3/bcm?action=DescribeResourceCatalogs&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{}
响应示例
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 "scope": "BCE_APIGW",
15 "scopeLabel": "API网关",
16 "resources": [
17 {
18 "resourceType": "Api",
19 "resourceTypeLabel": "API"
20 },
21 {
22 "resourceType": "Group",
23 "resourceTypeLabel": "分组"
24 }
25 ]
26 },
27 {
28 "scope": "BCE_BCC",
29 "scopeLabel": "云服务器BCC",
30 "resources": [
31 {
32 "resourceType": "Instance",
33 "resourceTypeLabel": "云服务器BCC"
34 }
35 ]
36 },
37 {
38 "scope": "BCE_QIANFAN_MODELBUILDER",
39 "scopeLabel": "千帆大模型平台 ModelBuilder",
40 "resources": [
41 {
42 "resourceType": "System",
43 "resourceTypeLabel": "预置服务"
44 },
45 {
46 "resourceType": "Custom",
47 "resourceTypeLabel": "定制服务"
48 },
49 {
50 "resourceType": "Endpoint",
51 "resourceTypeLabel": "自定义接入点"
52 }
53 ],
54 "regions": ["global"]
55 }
56 ]
57}
评价此篇文章
