-
Notifications
You must be signed in to change notification settings - Fork 373
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1071 from alex-smile/ft_esb_update_apis_20230328
ESB 更新配置类组件
- Loading branch information
Showing
11 changed files
with
234 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
2.14.44 | ||
2.14.45 |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
83 changes: 83 additions & 0 deletions
83
paas2/esb/components/confapis/bk_log/apidocs/zh_hans/databus_custom_create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
### 功能描述 | ||
|
||
自定义上报日志创建接口 | ||
|
||
### 请求参数 | ||
|
||
#### 接口参数 | ||
|
||
| 字段 | 类型 | 必选 | 描述 | | ||
|--------------------------|--------|-----|-----------------------------------------------------| | ||
| bk_biz_id | int | 是 | 业务ID, 或空间ID | | ||
| collector_config_name_en | string | 是 | 采集英文名称,重要,5-50个字符,仅包含字母数字下划线 | | ||
| collector_config_name | string | 是 | 采集项中文名, 最多50个字符 | | ||
| custom_type | string | 是 | 日志类型,无特殊要求一般固定为log。当前可选的值(log、otlp_trace、otlp_log) | | ||
| category_id | string | 是 | 数据分类, 无特殊要求可以固定为"application_check", 代表这个数据是业务的应用日志 | | ||
| storage_cluster_id | int | 否 | 存储ES集群,默认会选择一个公共集群作为存储,如果需要指定存储,则填写为日志平台注册后的集群ID | | ||
| retention | int | 否 | 存储时间 (注意:指定存储后,该字段为必须) | | ||
| es_shards | int | 否 | 索引分片数 (注意:指定存储后,该字段为必须) | | ||
| storage_replies | int | 否 | 存储副本数 (注意:指定存储后,该字段为必须) | | ||
| allocation_min_days | int | 否 | n天后的数据,转到冷节点,只在集群开启了冷热时生效 (注意:指定存储后,该字段为必须) | | ||
| data_link_id | int | 否 | 数据传输链路,不需要可以不填 | | ||
| description | string | 否 | 描述信息 | | ||
|
||
|
||
### 请求参数示例 | ||
|
||
```json | ||
{ | ||
"bk_app_code": "replace_me_with_bk_app_code", | ||
"bk_app_secret": "replace_me_with_bk_app_secret", | ||
"bk_username": "replace_me_with_bk_username", | ||
|
||
"bk_biz_id": 2, | ||
"collector_config_name": "test_custom_config_name", | ||
"collector_config_name_en": "test_custom_config_name_en", | ||
"custom_type": "log", | ||
"category_id": "application_check", | ||
|
||
|
||
"storage_cluster_id": 15, | ||
"retention": 3, | ||
"es_shards": 1, | ||
"storage_replies": 0, | ||
"allocation_min_days": 0, | ||
|
||
"data_link_id": 1, | ||
"description": "" | ||
|
||
} | ||
``` | ||
|
||
### 响应参数 | ||
|
||
| 字段 | 类型 | 描述 | | ||
| ------- | ------ |---------| | ||
| result | bool | 请求是否成功 | | ||
| code | int | 返回的状态码 | | ||
| message | string | 描述信息 | | ||
| data | dict | 返回配置项内容 | | ||
|
||
|
||
### 返回日志内容字段 | ||
| 字段 | 类型 | 描述 | | ||
| ------- | ------ |--| | ||
| collector_config_id | int | 采集项ID | | ||
| index_set_id | int | 索引集ID,查询时使用 | | ||
| bk_data_id | int | 数据管道ID | | ||
|
||
|
||
### 返回结果示例 | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"data": { | ||
"collector_config_id": 1026, | ||
"index_set_id": 481367, | ||
"bk_data_id": 1578495 | ||
}, | ||
"code": 0, | ||
"message": "" | ||
} | ||
``` |
62 changes: 62 additions & 0 deletions
62
paas2/esb/components/confapis/bk_log/apidocs/zh_hans/databus_custom_update.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
### 功能描述 | ||
|
||
自定义上报日志更新接口 | ||
|
||
### 请求参数 | ||
|
||
#### 接口参数 | ||
|
||
| 字段 | 类型 | 必选 | 描述 | | ||
|--------------------------|--------|-----|-----------------------------------------------------| | ||
| collector_config_name | string | 是 | 采集项中文名, 最多50个字符 | | ||
| custom_type | string | 是 | 日志类型,无特殊要求一般固定为log。当前可选的值(log、otlp_trace、otlp_log) | | ||
| category_id | string | 是 | 数据分类, 无特殊要求可以固定为"application_check", 代表这个数据是业务的应用日志 | | ||
| storage_cluster_id | int | 否 | 存储ES集群,默认会选择一个公共集群作为存储,如果需要指定存储,则填写为日志平台注册后的集群ID | | ||
| retention | int | 否 | 存储时间 (注意:指定存储后,该字段为必须) | | ||
| es_shards | int | 否 | 索引分片数 (注意:指定存储后,该字段为必须) | | ||
| storage_replies | int | 否 | 存储副本数 (注意:指定存储后,该字段为必须) | | ||
| allocation_min_days | int | 否 | n天后的数据,转到冷节点,只在集群开启了冷热时生效 (注意:指定存储后,该字段为必须) | | ||
| description | string | 否 | 描述信息 | | ||
|
||
|
||
### 请求参数示例 | ||
|
||
```json | ||
{ | ||
"bk_app_code": "replace_me_with_bk_app_code", | ||
"bk_app_secret": "replace_me_with_bk_app_secret", | ||
"bk_username": "replace_me_with_bk_username", | ||
|
||
"collector_config_name": "test_custom_config_name", | ||
"custom_type": "log", | ||
"category_id": "application_check", | ||
|
||
"storage_cluster_id": 15, | ||
"retention": 3, | ||
"es_shards": 1, | ||
"storage_replies": 0, | ||
"allocation_min_days": 0, | ||
|
||
"description": "" | ||
} | ||
``` | ||
|
||
### 响应参数 | ||
|
||
| 字段 | 类型 | 描述 | | ||
| ------- | ------ |--------| | ||
| result | bool | 请求是否成功 | | ||
| code | int | 返回的状态码 | | ||
| message | string | 描述信息 | | ||
|
||
|
||
### 返回结果示例 | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"data": null, | ||
"code": 0, | ||
"message": "" | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters