# 获取数据过滤规则信息结果 - ShowDataFilterRulesResult #### 功能介绍 获取数据过滤规则信息结果 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-drs/drs_api_0035.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v5/{project_id}/jobs/{job_id}/filter-rules/result 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的Project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-drs/drs_api_0106.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及 | | job_id | 是 | String | **参数解释：** 数据迁移任务ID，用于指定要查询过滤规则的目标任务。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | query_id | 否 | String | **参数解释：** 查询数据过滤规则结果请求ID，用于关联之前提交的查询过滤校验请求。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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**：英语 - **zh-cn**：中文 - **es-us**：西班牙语 - **pt-br**：葡萄牙语 **默认取值：** en-us | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Long | **参数解释：** 总数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | rules | Array of objects | **参数解释：** 数据过滤规则列表。 详情请参见[表5]。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 查询过滤规则进度。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | 表5DataFilterRuleResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | batch_id | Long | **参数解释：** 数据过滤规则批次ID，标识同一批次内的多个过滤对象属于同一个规则配置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | filter_object_list | Array of objects | **参数解释：** 过滤对象信息列表，列出此规则下所有需进行数据过滤的具体数据库对象。 详情请参见[表6]。 | | filter_rules_resp | object | **参数解释：** 一般过滤数据条件响应体，包含源库和目标库的SQL过滤条件表达式。 详情请参见[表7]。 | | advanced_setting_resp | object | **参数解释：** 高级配置过滤信息响应体，当过滤规则涉及库/表/列级细粒度过滤时，返回额外的配置参数（索引、主键、自定义值等）。 详情请参见[表8]。 | 表6DataFilterObjectResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | batch_id | Long | **参数解释：** 数据过滤对象信息批次ID，与父级DataFilterRuleResp的batch_id关联，用于追溯对象归属的批次。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 数据过滤对象的唯一标识符，由对象层级结构（库名、表名、对象类型等）组合生成。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | parent_id | String | **参数解释：** 父级过滤对象的标识符，用于表示对象之间的层级归属关系（如列归属于表、表归属于库）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | object_name | String | **参数解释：** 数据过滤对象的名称，按object_type不同可为库名、表名或列名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | object_alias_name | String | **参数解释：** 数据过滤对象的映射名称（别名），在目标端数据库对象名与源端不一致时使用。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | object_type | String | **参数解释：** 数据过滤对象的层级类型，标识当前过滤规则粒度级别。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | db_name | String | **参数解释：** 数据过滤对象所属的数据库名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | schema_name | String | **参数解释：** 数据过滤对象所属的schema名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | table_name | String | **参数解释：** 数据过滤对象所属的表名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | is_data_filter | String | **参数解释：** 标记该对象是否启用数据过滤。 **约束限制：** 不涉及。 **取值范围：** - **true**：启用数据过滤。 - **false**：不启用数据过滤。 | | data_filter_type | String | **参数解释：** 数据过滤的类型，标识使用的过滤策略。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | filter_condition | String | **参数解释：** 数据过滤条件。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | is_synchronized | Boolean | **参数解释：** 数据过滤条件是否已同步。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | 表7GeneralDataFilterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_filter_condition | String | **参数解释：** 源数据库的过滤条件SQL表达式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | target_filter_condition | String | **参数解释：** 目标数据库的过滤条件SQL表达式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | condition_separated | String | **参数解释：** 标记源库和目标库过滤条件是否分开配置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | 表8DataFilteringAdvancedSetting | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_name | String | **参数解释：** 库名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | table_name | String | **参数解释：** 表名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | col_names | String | **参数解释：** 列名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | prim_key_or_indexes | String | **参数解释：** 主键或唯一索引。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | indexes | String | **参数解释：** 优化查询所需的索引。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | | values | String | **参数解释：** 过滤条件。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，当任务报错时返回的错误代码。 **约束限制**： - 最小长度：12 - 最大长度：12 **取值范围**： 格式为DRS.XXXXXX。 | | error_msg | String | **参数解释**： 错误详细信息，当任务执行失败时返回的具体错误描述。 **约束限制**： - 最小长度：1 - 最大长度：512 **取值范围**： 不涉及。 | #### 请求示例 获取数据过滤规则信息结果 ``` https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/filter-rules/result?query_id=0eacda0b-9422-4535-8b62-537d1833638b ``` #### 响应示例 **状态码：200** 一般数据过滤规则列表响应体 ``` { "status" : "success", "total_count" : 2, "rules" : [ { "batch_id" : 2, "filter_object_list" : [ { "batch_id" : "2", "id" : "test_drs-*-*-mysql3-*-*---conditionFilter--", "parent_id" : "test_drs-*-*-mysql3", "object_type" : "column", "object_name" : "--conditionFilter--", "db_name" : "test_drs", "schema_name" : null, "table_name" : "mysql3", "is_data_filter" : true, "data_filter_type" : "contentConditionalFilter", "filter_condition" : "id in (select id from test_drs.mysql5 where id > 1)" } ], "filter_rules_resp" : { "data_filter_type" : "contentConditionalFilter", "source_filter_condition" : "id in (select id from test_drs.mysql5 where id > 1)", "target_filter_condition" : null, "condition_separated" : false }, "advanced_setting_resp" : null }, { "batch_id" : 1, "objectInfo" : [ { "batch_id" : "1", "id" : "test_drs-*-*-mysql1-*-*---conditionFilter--", "parent_id" : "test_drs-*-*-mysql1", "object_type" : "column", "object_name" : "--conditionFilter--", "db_name" : "test_drs", "schema_name" : null, "table_name" : "mysql3", "is_data_filter" : true, "data_filter_type" : "contentConditionalFilter", "filter_condition" : "id in (select id from test_drs.mysql4 where id > 1)" }, { "batch_id" : "1", "id" : "test_drs-*-*-mysql2-*-*---conditionFilter--", "parent_id" : "test_drs-*-*-mysql2", "object_type" : "column", "object_name" : "--conditionFilter--", "db_name" : "test_drs", "schema_name" : null, "table_name" : "mysql3", "is_data_filter" : true, "data_filter_type" : "contentConditionalFilter", "filter_condition" : "id in (select id from test_drs.mysql4 where id > 1)" } ], "filter_rules_resp" : { "source_filter_condition" : "id in (select id from test_drs.mysql4 where id > 1)", "target_filter_condition" : null, "condition_separated" : false }, "configTransformation" : null } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | 其他状态请参见[状态码](https://support.huaweicloud.com/api-drs/drs_api_0108.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-drs/drs_05_0004.html)。