创建日志集模板CreateLogStoreTemplate
更新时间:2025-10-13
描述
创建日志集模板
请求
- 请求语法
Text
1POST /v3/bls?action=CreateLogStoreTemplate HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5
6{
7 "name": <name>,
8 "priority": <priority>
9}
- 请求头域
除公共请求头域外,无其它特殊头域。
- 请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
name | String | Yes | RequestBody | 模板名称,同user下唯一 |
projectPatterns | List<String> | Yes | RequestBody | 日志组匹配模式,支持*通配符 |
logstorePatterns | List<String> | Yes | RequestBody | 日志集匹配模式,支持*通配符 |
priority | Int | Yes | RequestBody | 日志集模板优先级,值越大,优先级越高,同user下唯一 |
template | Template | No | RequestBody | 模板配置 |
其中 Template 对象的元素结构如下:
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
retention | Int | No | RequestBody | 日志集保存时长,单位:天 |
shardCount | Int | No | RequestBody | 日志集初始shard个数 |
disableShardAutoSplit | Boolean | No | RequestBody | 是否关闭shard自动分裂,若启动自动分裂,BLS将根据日志集写入流量,自动扩容shard,选填,默认值:false |
maxShardCount | Int | No | RequestBody | 若开启shard自动分裂,该字段必填,填写最大分裂数量,取值范围:[1, 50] |
enableHotRetention | Boolean | No | RequestBody | 是否开启冷热自动分层,选填,默认值:false |
hotRetention | Int | No | RequestBody | 若开启冷热分层,该字段必填,填写热存时长,单位:天,7 <= hotRetention <= retention |
index | Object | No | RequestBody | 索引配置,参考:创建索引接口 |
响应
- 响应头域
除公共响应头域外,无其它特殊头域。
- 响应参数
字段 | 类型 | 描述 |
---|---|---|
success | Boolean | 请求是否成功 |
code | String | 请求码,成功为OK,错误为具体的错误码 |
message | String | 请求成功为空,失败为具体的错误信息 |
错误码
除了通用的错误码,还可能出现如下错误码:
错误码 | 错误消息 | 描述 | HTTP状态码 |
---|---|---|---|
InvalidParameter | Request param invalid: [msg] | 无效的参数异常 | 400 |
示例
- 请求示例
Text
1POST /v3/bls?action=CreateLogStoreTemplate 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 // 模板名称,同user下唯一,必填
7 "name": "my-template",
8 // 日志组匹配模式,支持*通配符,必填
9 "projectPatterns": [
10 "my-project-*"
11 ],
12 // 日志集匹配模式,支持*通配符,必填
13 "logstorePatterns": [
14 "my-logstore-*"
15 ],
16 // 日志集模板优先级,值越大,优先级越高,必填
17 "priority": 10,
18 // 模板配置,选填
19 "template": {
20 // 保存时长,单位:天,选填
21 "retention": 30,
22 // 初始shard个数,选填
23 "shardCount": 1,
24 // 是否关闭shard自动分裂,若启动自动分裂,BLS将根据日志集写入流量,自动扩容shard,选填,默认值:false
25 "disableShardAutoSplit": false,
26 // 若开启shard自动分裂,该字段必填,填写最大分裂数量,取值范围:[1, 50]
27 "maxShardCount": 50,
28
29 // 是否开启冷热自动分层,选填,默认值:false
30 "enableHotRetention": false,
31 // 若开启冷热分层,该字段必填,填写热存时长,单位:天,7 <= hotRetention <= retention
32 "hotRetention": 7,
33
34 // 索引配置,选填
35 "index": {
36 // 是否开启全文索引,选填,默认值:false
37 "fulltext": true,
38 // 全文索引是否大小写敏感,选填,默认值:false
39 "caseSensitive": false,
40 // 全文索引自定义分割符,选填,若未填写,使用默认分隔符: "@&?|#()='\",;:<>[]{}/ \n\t\r\\"
41 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
42 // 全文索引是否包含中文,选填,默认值:false
43 "includeChinese": false,
44
45 // 字段索引列表,选填
46 "fields": {
47 // key是索引的字段名称
48 "level": {
49 // 字段类型,必填,可选项:bool、long、text、float、json
50 "type": "string",
51 // 是否大小写敏感,选填,默认值:false
52 "caseSensitive": false,
53 // 自定义分割符,选填,若未填写,使用默认分隔符: "@&?|#()='\",;:<>[]{}/ \n\t\r\\"
54 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
55 // 是否包含中文,选填,默认值:false
56 "includeChinese": false,
57 // 是否开启动态索引,选填,默认值:false,只有type=json时,才可启动动态索引
58 "dynamicMapping": false
59 },
60 "salary": {
61 "type": "float",
62 "caseSensitive": false,
63 "separators": "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
64 "includeChinese": false,
65 "dynamicMapping": false
66 }
67 }
68 }
69 }
70}
- 响应示例
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}