获取日志集模板列表DescribeLogStoreTemplates
更新时间：2025-10-13
描述
获取日志集模板列表
请求
- 请求语法
Text
1POST /v3/bls?action=DescribeLogStoreTemplates HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5
6{
7 "name": <name>,
8 "pageNo": 1,
9 "pageSize": 10
10}- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | No | RequestBody | 按模板名称过滤 |
| orderBy | String | No | RequestBody | 排序字段，createdTime: 创建时间， updatedTime: 更新时间，name: 名称，priority: 优先级 默认值：priority |
| order | String | No | RequestBody | 排序方式，asc: 升序， desc: 降序，默认值：desc |
| pageNo | Int | Yes | RequestBody | 第几页，从1开始计数 |
| pageSize | Int | Yes | RequestBody | 每页展示数量，最大值：100 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| templates | List<Template> | 模板列表 |
| pageNo | Int | 第几页 |
| pageSize | Int | 每页展示数量 |
| totalCount | Int | 总数 |
其中 Template 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| name | String | 模板名称，同user下唯一 |
| projectPatterns | List<String> | 日志组匹配模式，支持*通配符 |
| logstorePatterns | List<String> | 日志集匹配模式，支持*通配符 |
| priority | Int | 日志集模板优先级，值越大，优先级越高，同user下唯一 |
| createdTimestamp | String | 创建时间，UTC时间，格式：2025-04-20T10:01:12Z |
| updatedTimestamp | String | 更新时间，UTC时间，格式：2025-04-20T10:01:12Z |
错误码
除了通用的错误码，无特殊错误码
示例
- 请求示例
Text
1POST /v3/bls?action=DescribeLogStoreTemplates HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8
5{
6 // 按策略名称过滤，选填
7 "name": "my-template",
8 // 排序字段, 选填，默认值：priority
9 // 可选项：
10 // priority - 优先级
11 "orderBy": "priority",
12 // 排序方式，选填，默认值：desc
13 // 可选项：
14 // asc - 升序
15 // desc - 降序
16 "order": "desc",
17 // 第几页，从1开始计数，必填
18 "pageNo": 1,
19 // 每页展示数量，必填，最大值：100
20 "pageSize": 10
21}- 响应示例
Text
1HTTP/1.1 201
2Content-Type: application/json; charset=utf-8
3X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
4Date: Fri, 10 Apr 2020 04:42:37 GMT
5{
6 "success": true,
7 "code": "OK", // 错误码
8 "message": "", // 错误详情
9
10 // 日志集模板列表
11 "templates": [
12 {
13 "name": "my-template", // 模板名称
14 "projectPatterns": ["my-project-*"], // 日志组匹配模式
15 "logstorePatterns": ["my-logstore-*"], // 日志集匹配模式
16 "priority": 10, // 日志集模板优先级
17 "createdTimestamp": "2025-04-20T10:01:12Z", // 创建时间，UTC时间
18 "updatedTimestamp": "2025-04-21T10:01:12Z", // 更新时间，UTC时间
19 }
20 ],
21
22 "pageNo": 1, // 第几页，从1开始计数
23 "pageSize": 10, // 每页展示数量
24 "totalCount": 100 // 总数
25}