采集数据过滤规则信息 - CollectDataFilterRules
功能介绍
采集数据过滤规则信息
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/jobs/{job_id}/filter-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 任务ID,用于指定要查询过滤规则的目标任务。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 否 | String | 参数解释: 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| X-Auth-Token | 是 | String | 参数解释: 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 请根据语言环境,参考支持的范围指定请求语言类型。 取值范围:
默认取值: en-us |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| filter_type | 是 | String | 参数解释: 数据过滤类型。 约束限制: 不涉及。 取值范围:
默认取值: common |
| is_all_rules | 否 | Boolean | 参数解释: 标记是否查询全部过滤规则(含已同步和未下发的) 约束限制: 不涉及。 取值范围:
默认取值: true |
| limit | 否 | Integer | 参数解释: 查询返回记录的数量限制。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 偏移量,表示查询该偏移量后面的记录。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 0 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 异步查询数据过滤规则的任务ID。 约束限制: 需使用此ID轮询获取数据校验规则结果,参考接口/v5/{project_id}/jobs/{job_id}/filter-rules/result。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,当任务报错时返回的错误代码。 约束限制:
取值范围: 格式为DRS.XXXXXX。 |
| error_msg | String | 参数解释: 错误详细信息,当任务执行失败时返回的具体错误描述。 约束限制:
取值范围: 不涉及。 |
请求示例
- 查询一般过滤条件信息
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/filter-rules { "filter_type" : "common", "is_all_rules" : true } - 查询高级配置过滤条件信息
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/filter-rules { "filter_type" : "config", "is_all_rules" : true }
响应示例
状态码:202
数据过滤规则列表响应体
{
"id" : "0eacda0b-9422-4535-8b62-537d1833638b"
} 状态码:400
Bad Request
{
"error_code" : "DRS.10000010",
"error_msg" : "Job does not exist, please check job ID."
} 错误码
请参见错误码。