获取租户行管订阅列表 - ListTenantManaged
功能介绍
获取租户行管订阅列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/siem/cloud-logs/tenant/config
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| region_id | 否 | String | 参数解释: 区域ID,用于标识资源所属区域。 约束限制: 不涉及 取值范围: 长度为0~256个字符。 默认取值: 不涉及 |
| offset | 否 | Long | 参数解释: 偏移量,分页查询时查询的起始位置。 约束限制: 不涉及 取值范围: 0~1000000 默认取值: 0 |
| limit | 否 | Long | 参数解释: 每页数量,分页查询时每页返回的记录数。 约束限制: 不涉及 取值范围: 1~1000 默认取值: 10 |
| sort_key | 否 | String | 参数解释: 排序字段,用于指定查询结果的排序字段。 约束限制: 不涉及 取值范围: 长度为1~128个字符。 默认取值: 不涉及 |
| sort_dir | 否 | String | 参数解释: 排序顺序,用于指定查询结果的排序方向。 约束限制: 不涉及 取值范围: 长度为1~128个字符。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| all_vendors | Array of all_vendors objects | 参数解释: 所有的云厂商、云产品和日志。 |
| config_statistics | config_statistics object | 参数解释: 统计数据。 取值范围: 不涉及 |
| data_list | Array of data_list objects | 参数解释: 数据。 |
| datasets | Array of DatasetInfo objects | 参数解释: 数据集列表。 |
| dataspace_id | String | 参数解释: 数据空间ID。 取值范围: 长度为36~36个字符。 |
| dataspace_name | String | 参数解释: 数据空间名称。 取值范围: 长度为1~255个字符。 |
| domain_id | String | 参数解释: 账号ID。 取值范围: 长度为32~36个字符。 |
| lts_sets | Array of LtsResponseVo objects | 参数解释: lts日志配置。 |
| project_id | String | 参数解释: 项目ID。 取值范围: 长度为32~36个字符。 |
| region_id | String | 参数解释: 所属region。 取值范围: 长度为1~255个字符。 |
| workspace_id | String | 参数解释: 工作空间 id。 取值范围: 长度为36~36个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cloud_vendor | String | 参数解释: 云厂商ID。 取值范围: 长度为0~64个字符。 |
| csvc_list | Array of csvc_list objects | 参数解释: 所有的云产品。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| csvc | String | 参数解释: 云产品ID。 取值范围: 长度为0~64个字符。 |
| source_list | Array of source_list objects | 参数解释: 所有的日志类型。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| csvc_display | String | 参数解释: 云产品名称。 取值范围: 长度为0~64个字符。 |
| csvc_help | String | 参数解释: 云产品描述。 取值范围: 长度为0~64个字符。 |
| link | String | 参数解释: 链接。 取值范围: 长度为0~64个字符。 |
| source_display | String | 参数解释: 日志名称。 取值范围: 长度为0~1024个字符。 |
| source_help | String | 参数解释: 日志描述。 取值范围: 长度为0~1024个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_num | Number | 参数解释: 账号接入数量。 取值范围: 0~10000 |
| daily_traffic | Number | 参数解释: 每日流量,单位:Byte。 取值范围: 0~9223372036854775807 |
| log_num | Number | 参数解释: 已接入日志数量。 取值范围: 0~10000 |
| product_all_num | Number | 参数解释: 云产品总数量。 取值范围: 0~10000 |
| product_in_num | Number | 参数解释: 接入云产品数量。 取值范围: 0~10000 |
| vendor_num | Number | 参数解释: 云厂商数量。 取值范围: 0~10000 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_all_num | Number | 参数解释: 接入账号总数量。 取值范围: 0~10000 |
| account_successful_num | Number | 参数解释: 成功接入账号数量。 取值范围: 0~10000 |
| csvc | String | 参数解释: 云产品ID。 取值范围: 长度为0~64个字符。 |
| datasets | Array of datasets objects | 参数解释: 日志数据。 |
| last_modified_time | Number | 参数解释: 上次修改时间。 取值范围: 0~10000 |
| log_all_num | Number | 参数解释: 日志总数量。 取值范围: 0~10000 |
| log_in_num | Number | 参数解释: 接入日志数量。 取值范围: 0~10000 |
| log_in_num_last_one_hour | Number | 参数解释: 过去一个小时接入。 取值范围: 0~10000 |
| process_status | String | 参数解释: 状态。 取值范围: 长度为0~64个字符。 |
| vendor | String | 参数解释: 云厂商ID。 取值范围: 长度为0~64个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_all_num | Number | 参数解释: 接入账号总数量。 取值范围: 0~10000 |
| account_successful_num | Number | 参数解释: 成功接入账号数量。 取值范围: 0~10000 |
| accounts | Array of accounts objects | 参数解释: 账号列表。 |
| alert | Boolean | 参数解释: 自动转告警开关。 取值范围: |
| all_accounts | Boolean | 参数解释: 是否接入已纳管的全量账号。 取值范围: |
| allow_alert | Boolean | 参数解释: 能否开自动转告警。 取值范围: |
| dataspace_id | String | 参数解释: 数据空间ID。 取值范围: 长度为0~64个字符。 |
| dataspace_name | String | 参数解释: 数据空间名称。 取值范围: 长度为0~64个字符。 |
| enable | String | 参数解释: 开启状态。 取值范围: 长度为0~64个字符。 |
| last_active_time | Number | 参数解释: 上次活跃时间。 取值范围: 0~4900000000000 |
| limit | String | 参数解释: 限制。 取值范围: 长度为0~64个字符。 |
| new_account_auto_access | Boolean | 参数解释: 新账号自动接入开关。 取值范围: |
| process_status | String | 参数解释: 日志的接入状态。 取值范围: |
| reference | reference object | 参数解释: 名称和描述。 取值范围: 不涉及 |
| region_id | String | 参数解释: 所属区域。 取值范围: 长度为1~255个字符。 |
| sink_msg | String | 参数解释: 错误信息。 取值范围: 长度为0~64个字符。 |
| source_id | Number | 参数解释: 日志ID。 取值范围: 0~10000 |
| source_name | String | 参数解释: 日志名称。 取值范围: 长度为0~64个字符。 |
| target | target object | 参数解释: 目标。 取值范围: 不涉及 |
| type | String | 参数解释: 类型。 取值范围: 长度为0~64个字符。 |
| workspace_id | String | 参数解释: 工作空间ID。 取值范围: 长度为0~64个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_id | String | 参数解释: 账号ID。 取值范围: 长度为0~64个字符。 |
| last_log_date | Number | 参数解释: 最近接入时间。 取值范围: 0~4900000000000 |
| log_count | String | 参数解释: 最近一小时接入数量。 取值范围: 长度为1~32个字符。 |
| name | String | 参数解释: 账号名称。 取值范围: 长度为0~64个字符。 |
| process_status | String | 参数解释: 接入状态。 取值范围: 长度为0~64个字符。 |
| sink_msg | String | 参数解释: 错误信息。 取值范围: 长度为0~64个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| csvc_display | String | 参数解释: 云产品名称。 取值范围: 长度为0~64个字符。 |
| csvc_help | String | 参数解释: 云产品描述。 取值范围: 长度为0~64个字符。 |
| link | String | 参数解释: 链接。 取值范围: 长度为0~64个字符。 |
| source_display | String | 参数解释: 日志名称。 取值范围: 长度为0~64个字符。 |
| source_help | String | 参数解释: 日志描述。 取值范围: 长度为0~64个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pipe | String | 参数解释: 管道。 取值范围: 长度为0~64个字符。 |
| shards | Number | 参数解释: 分片。 取值范围: 0~10000 |
| storage_mode | String | 参数解释: 存储模式。 取值范围: 长度为0~64个字符。 |
| ttl | Number | 参数解释: ttl时间,单位:天。 取值范围: 0~360 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| csvc | String | 参数解释: 所属云服务,例如主机安全就填写hss 取值范围: 长度为1~255个字符 |
| enable | String | 参数解释: 启用状态 取值范围: |
| is_region | Long | 参数解释: 位置信息 取值范围: |
| reference | reference object | 参数解释: 数据源引用信息 取值范围: 不涉及 |
| source_id | Long | 参数解释: 数据源ID 取值范围: 0~9223372036854775807 |
| source_name | String | 参数解释: 数据源名称 取值范围: 长度为1~255个字符 |
| target | Object | 参数解释: 目标管道信息 取值范围: 不涉及 |
| type | Long | 参数解释: 订阅类型 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| csvc_display | String | 参数解释: 云服务描述 取值范围: 不涉及 |
| source_display | String | 参数解释: 数据源描述 取值范围: 不涉及 |
| link | String | 参数解释: 链接 取值范围: 不涉及 |
| csvc_help | String | 参数解释: 云服务帮助说明 取值范围: 不涉及 |
| source_help | String | 参数解释: 数据源帮助说明 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pipe | String | 参数解释: 管道名 取值范围: 长度为1~255个字符 |
| shards | Long | 参数解释: 所需分区数 取值范围: 0~99 |
| ttl | Long | 参数解释: 数据生命周期 取值范围: 0~999999 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| config_id | String | 参数解释: 配置id 取值范围: 长度为32~36个字符 |
| config_name | String | 参数解释: 配置名称 取值范围: 长度为1~255个字符 |
| enable | String | 参数解释: 是否开启 取值范围: 长度为1~255个字符 |
| log_group_id | String | 参数解释: 日志组Id 取值范围: 长度为1~255个字符 |
| log_stream_id | String | 参数解释: 日志流ID 取值范围: 长度为32~36个字符 |
| log_type | String | 参数解释: 日志类型 取值范围: 长度为1~36个字符 |
| log_types | log_types object | 参数解释: 日志类型列表 取值范围: 不涉及 |
| lts_infos | Array of lts_infos objects | 参数解释: lts日志信息map |
| pipe_alias | String | 参数解释: 管道别名 取值范围: 长度为1~255个字符 |
| type_prefix | String | 参数解释: 类型前缀 取值范围: 长度为1~255个字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| log_group_id | String | 参数解释: 日志组id 取值范围: 长度为1~255个字符 |
| log_group_name | String | 参数解释: 组名称 取值范围: 长度为1~255个字符 |
| streams | Array of streams objects | 参数解释: 流列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| log_stream_id | String | 参数解释: 日志流ID 取值范围: 长度为32~36个字符 |
| log_stream_name | String | 参数解释: 日志流名称 取值范围: 长度为1~255个字符 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 取值范围: 长度为8~36个字符 |
| error_msg | String | 参数解释: 错误描述 取值范围: 长度为2~512个字符 |
请求示例
获取租户行管订阅列表的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/siem/cloud-logs/tenant/config 响应示例
状态码:200
成功
{
"all_vendors" : [ {
"cloud_vendor" : "hss",
"csvc_list" : [ {
"csvc" : "hss",
"source_list" : [ {
"csvc_display" : "企业主机安全 HSS",
"csvc_help" : "企业主机安全服务",
"link" : "",
"source_display" : "主机漏洞扫描结果",
"source_help" : "主机漏洞扫描结果"
} ]
} ]
} ],
"config_statistics" : {
"account_num" : 100,
"daily_traffic" : 1024,
"log_num" : 10,
"product_all_num" : 2,
"product_in_num" : 4,
"vendor_num" : 2
},
"data_list" : [ {
"account_all_num" : 100,
"account_successful_num" : 95,
"csvc" : "hss",
"datasets" : [ {
"account_all_num" : 100,
"account_successful_num" : 95,
"accounts" : [ {
"account_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
"last_log_date" : 1584883694354,
"log_count" : "25",
"name" : "账号名称",
"process_status" : "SUCCESS",
"sink_msg" : ""
} ],
"alert" : true,
"all_accounts" : true,
"allow_alert" : true,
"dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
"dataspace_name" : "cloudlogs_2b31ed520xxxxxxebedb6e57xxxxxxxx",
"enable" : "1",
"last_active_time" : 1584883694354,
"limit" : "",
"new_account_auto_access" : true,
"process_status" : "SUCCESS",
"reference" : {
"csvc_display" : "企业主机安全 HSS",
"csvc_help" : "企业主机安全服务",
"link" : "",
"source_display" : "主机漏洞扫描结果",
"source_help" : "主机漏洞扫描结果"
},
"region_id" : "region_c",
"sink_msg" : "",
"source_id" : 102,
"source_name" : "hss-vul",
"target" : {
"pipe" : "",
"shards" : 2,
"storage_mode" : "",
"ttl" : 180
},
"type" : "1",
"workspace_id" : "c22106ba-bede-453c-8488-b60c70bd6aed"
} ],
"last_modified_time" : 1584883694354,
"log_all_num" : 10,
"log_in_num" : 4,
"log_in_num_last_one_hour" : 2,
"process_status" : "SUCCESS",
"vendor" : "hss"
} ],
"dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
"dataspace_name" : "cloudlogs_2b31ed520xxxxxxebedb6e57xxxxxxxx",
"domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx",
"project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"region_id" : "region_c",
"workspace_id" : "c22106ba-bede-453c-8488-b60c70bd6aed"
} 状态码:400
错误响应
{
"error_code" : "SecMaster.10000001",
"error_msg" : "参数无效"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 错误响应 |
错误码
请参见错误码。