保存云服务采集配置 - CreateCollectConfig
功能介绍
保存云服务采集配置
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/collector/cloudlogs/config
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
region_id |
否 |
String |
区域ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
config |
是 |
Array of ConfigInfo objects |
数据集列表 |
|
dataspace_id |
是 |
String |
数据空间ID |
|
dataspace_name |
是 |
String |
数据空间名称 |
|
domain_id |
否 |
String |
账号ID |
|
lts_config |
否 |
Array of LtsRquestVo objects |
lts配置 |
|
workspace_id |
是 |
String |
工作空间 id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
accounts |
否 |
Array of strings |
纳管账号列表(非跨账号场景不传递) |
|
action |
否 |
String |
操作 |
|
alert |
否 |
Boolean |
自动转告警的开关 |
|
all_accounts |
否 |
Boolean |
是否接入已纳管的全量账号 |
|
csvc |
否 |
String |
云产品 |
|
csvc_display |
是 |
String |
云服务描述 |
|
enable |
是 |
Long |
启用状态:0未启用;1启用 |
|
new_account_auto_access |
否 |
Boolean |
新账号自动同步的开关 |
|
shards |
是 |
Long |
所需分区数 |
|
source_display |
是 |
String |
数据源描述 |
|
source_id |
是 |
Long |
数据源ID |
|
source_name |
否 |
String |
日志名称 |
|
ttl |
是 |
Long |
数据生命周期 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of ConfigResponse objects |
保存云服务采集配置响应 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
alert |
Boolean |
自动转告警的开关 |
|
allow_alert |
Boolean |
能否开自动转告警 |
|
allow_lts |
Boolean |
是否允许长期存储 |
|
csvc_display |
String |
云服务描述 |
|
datasets |
Array of DatasetInfo objects |
关联的数据集列表 |
|
region |
Boolean |
是否按区域分片采集 |
|
source_display |
String |
数据源描述 |
|
success |
Boolean |
是否创建成功 |
|
total |
Integer |
当前已采集的日志条数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
csvc |
String |
所属云服务,例如主机安全就填写hss |
|
enable |
String |
启用状态:0未启用;1启用 |
|
is_region |
Long |
位置信息:1 region;0 global |
|
reference |
reference object |
数据源名称 |
|
source_id |
Long |
数据源ID |
|
source_name |
String |
数据源名称 |
|
target |
Object |
目标管道信息 |
|
type |
Long |
订阅类型:1租户订阅;2租户行管订阅;3平台行管(当前都为1) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
csvc_display |
String |
云服务描述 |
|
source_display |
String |
数据源描述 |
|
link |
String |
链接 |
|
csvc_help |
String |
云服务帮助说明 |
|
source_help |
String |
数据源帮助说明 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pipe |
String |
管道名 |
|
shards |
Long |
所需分区数 |
|
ttl |
Long |
数据生命周期 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
错误码
请参见错误码。