获取日志集模板详情DescribeLogStoreTemplate
更新时间:2025-10-13
描述
获取日志集模板详情
请求
- 请求语法
Text
1POST /v3/bls?action=DescribeLogStoreTemplate HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5
6{
7 "name": <name>,
8}
- 请求头域
除公共请求头域外,无其它特殊头域。
- 请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
name | String | Yes | RequestBody | 模板名称 |
响应
- 响应头域
除公共响应头域外,无其它特殊头域。
- 响应参数
字段 | 类型 | 描述 |
---|---|---|
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 | 模板配置 |
其中 Template 对象的元素结构如下:
参数名称 | 类型 | |
---|---|---|
retention | Int | 日志集保存时长,单位:天 |
shardCount | Int | 日志集初始shard个数 |
disableShardAutoSplit | Boolean | 是否关闭shard自动分裂,若启动自动分裂,BLS将根据日志集写入流量,自动扩容shard,选填,默认值:false |
maxShardCount | Int | 若开启shard自动分裂,该字段必填,填写最大分裂数量,取值范围:[1, 50] |
enableHotRetention | Boolean | 是否开启冷热自动分层,选填,默认值:false |
hotRetention | Int | 若开启冷热分层,该字段必填,填写热存时长,单位:天,7 <= hotRetention <= retention |
index | Object | 索引配置,参考:创建索引接口 |
错误码
除了通用的错误码,无特殊错误码
示例
- 请求示例
Text
1POST /v3/bls?action=DescribeLogStoreTemplate 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}
- 响应示例
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 "name": "my-template", // 模板名称
11 "projectPatterns": ["my-project-*"], // 日志组匹配模式
12 "logstorePatterns": ["my-logstore-*"], // 日志集匹配模式
13 "priority": 10, // 日志集模板优先级
14 "createdTimestamp": "2025-04-20T10:01:12Z", // 创建时间,UTC时间
15 "updatedTimestamp": "2025-04-21T10:01:12Z", // 更新时间,UTC时间
16
17 // 模板配置
18 "template": {
19 "retention": 1, // 保存时长,单位:天
20 "shardCount": 1, // 初始shard个数
21 "disableShardAutoSplit": false, // 是否关闭shard自动分裂
22 "maxShardCount": 50, // 最大分裂数量
23 "enableHotRetention": false, // 是否开启冷热存分层
24 "hotRetention": 7, // 开启冷热分层后的热存保存时长,单位:天
25 // 索引配置
26 "index": {
27 "fulltext": true, // 是否开启全文索引
28 "caseSensitive": false, // 全文索引是否大小写敏感
29 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\", // 全文索引切词分割符
30 "includeChinese": false, // 全文索引是否包含中文
31 // 字段索引列表
32 "fields": {
33 "level": {
34 "type": "string", // 字段类型,可选项:bool、long、text、float、json
35 "caseSensitive": false, // 是否大小写敏感
36 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\", // 索引切词分割符
37 "includeChinese": false, // 是否包含中文
38 "dynamicMapping": false, // 是否开启动态索引
39 },
40 }
41 }
42 }
43}