获取日志集模板详情DescribeLogStoreTemplate
更新时间：2026-06-23
- 获取日志集模板详情。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/bls?action=DescribeLogStoreTemplate HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": <name>
7}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为3 |
| name | String | 是 | RequestBody参数 | 模板名称 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| message | String | 请求成功为空，失败为具体的错误信息 |
| 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 |
| template | Template | 模板配置 |
请求示例
Plain Text
1POST /v1/xxx?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST xxx.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 // 模板名称，必填
7 "name": "my-template"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK", // 错误码
11 "message": "", // 错误详情
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 "template": {
22 "retention": 1, // 保存时长，单位：天
23 "shardCount": 1, // 初始shard个数
24 "disableShardAutoSplit": false, // 是否关闭shard自动分裂
25 "maxShardCount": 50, // 最大分裂数量
26 "enableHotRetention": false, // 是否开启冷热存分层
27 "hotRetention": 7, // 开启冷热分层后的热存保存时长，单位：天
28 // 索引配置
29 "index": {
30 "fulltext": true, // 是否开启全文索引
31 "caseSensitive": false, // 全文索引是否大小写敏感
32 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\", // 全文索引切词分割符
33 "includeChinese": false, // 全文索引是否包含中文
34 // 字段索引列表
35 "fields": {
36 "level": {
37 "type": "string", // 字段类型，可选项：bool、long、text、float、json
38 "caseSensitive": false, // 是否大小写敏感
39 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\", // 索引切词分割符
40 "includeChinese": false, // 是否包含中文
41 "dynamicMapping": false, // 是否开启动态索引
42 },
43 }
44 }
45 }
46}评价此篇文章