
# 获取任务详情 - ShowJobByInstance
#### 功能介绍
获取任务详情。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LakeFormation/doc?api=ShowJobByInstance)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lakeformation/abcd.html)。
#### URI
GET /v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释:** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-lakeformation/lakeformation_04_0026.html) **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及 |
| instance_id | 是    | String | **参数解释:** LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25 **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及                                 |
| job_id      | 是    | String | **参数解释:** 任务ID **约束限制:** 不涉及 **取值范围:** 不涉及 **默认取值:** 不涉及                                                                                                |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | **参数解释:** 租户token **约束限制:** 长度为0\~65535个字符 **取值范围:** 长度为0\~65535个字符 **默认取值:** 不涉及 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数                    | 参数类型                                                             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| id                    | String                                                           | **参数解释:** 任务ID，创建任务时自动生成。例如：03141229-84cd-4b1b-9733-dd124320c125                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| name                  | String                                                           | **参数解释:** 任务名称，只能包含中文、字母、数字和下划线，且长度为4到255个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| description           | String                                                           | **参数解释:** 用户创建任务时写的描述信息                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| type                  | String                                                           | **参数解释:** METADATA_MIGRATION：元数据迁移 PERMISSION_MIGRATION：数据权限迁移 METADATA_DISCOVERY：元数据发现 DISASTER_RECOVERY：容灾同步任务                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| parameter             | [JobParameter] object | 任务参数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| create_time           | String                                                           | **参数解释:** 任务创建时间戳，根据创建任务时间生成                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| last_success_run_time | String                                                           | **参数解释:** 任务上一次成功运行时间戳，任务运行成功后根据上次执行时间生成                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| start_time            | String                                                           | **参数解释:** 上次任务执行时间戳，根据上次任务执行时间生成                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| status                | String                                                           | **参数解释:** 当前状态及含义 - CREATED：已创建   - SUBMITTED：已提交   - RUNNING：运行中   - SUCCESS：成功   - FAILED：失败   - STOPPED：已停止   - FROZEN_RELEASABLE：冻结可恢复   - FROZEN_UNRELEASABLE：冻结不可恢复   - PARTIAL_SUCCESS：部分成功    |
   
 表4JobParameter 
| 参数                             | 参数类型                                                                                             | 描述                                                                                                                                                                                     |
|:---|:---|:---|
| metadata_migration_parameter   | [MetaDataMigrationParameter] object     | 元数据迁移参数。                                                                                                                                                                               |
| permission_migration_parameter | [PermissionMigrationParameter] object | 权限迁移参数。                                                                                                                                                                                |
| metadata_discovery_parameter   | [MetaDataDiscoveryParameter] object     | 元数据发现参数。                                                                                                                                                                               |
| disaster_recovery_parameter    | [DisasterRecoveryParameter] object       | 容灾参数。                                                                                                                                                                                  |
| smn_notify                     | Boolean                                                                                          | **参数解释:** 该任务是否进行smn通知 **取值范围:** 不涉及                                    |
| smn_notify_topic               | String                                                                                           | **参数解释:** 任务通知的smn主题 **取值范围:** 长度为1\~255个字符                             |
| smn_notify_types               | Array of strings                                                                                 | **参数解释:** 任务发起通知的类型，区分成功任务和失败任务，取值为SUCCESS、FAILED **取值范围:** 数组元素个数为0\~2 |
   
 表5MetaDataMigrationParameter 
| 参数                                 | 参数类型                                                                                     | 描述                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| datasource_type                    | String                                                                                   | **参数解释:** 数据源类型： ALIYUN_DLF代表Data Lake Formation DLF、 MRS_RDS_FOR_MYSQL代表MRS云数据库RDS(for MySQL)、 OPEN_FOR_MYSQL代表开源HiveMetastore(for MySQL)、 MRS_RDS_FOR_PG代表MRS云数据库RDS(for PostgreSQL)、 MRS_LOCAL_GAUSSDB代表MRS本地数据库(GaussDB) **取值范围:** 不涉及                                                             |
| datasource_parameter               | [DataSourceParameter] object           | 数据源参数。                                                                                                                                                                                                                                                                                                                                                                                                                |
| source_catalog                     | String                                                                                   | **参数解释:** 源Catalog，要迁移出的catalog **取值范围:** 长度为1\~255个字符                                                                                                                                                                                                                                                 |
| target_catalog                     | String                                                                                   | **参数解释:** 目标Catalog，要迁移至的catalog **取值范围:** 长度为1\~255个字符                                                                                                                                                                                                                                                |
| conflict_strategy                  | String                                                                                   | **参数解释:** 冲突解决策略，UPSERT表示仅创建和更新现有元数据，不删除 **取值范围:** 不涉及                                                                                                                                                                                                                                                 |
| delete_strategy                    | String                                                                                   | **参数解释:** 元数据删除策略，IGNORE表示不删除LakeCat端冗余元数据，为默认值；DELETE表示删除LakeCat端冗余元数据 **取值范围:** 不涉及                                                                                                                                                                                                                  |
| log_location                       | String                                                                                   | **参数解释:** 日志存放路径，由用户选择 **取值范围:** 长度为1\~1024个字符                                                                                                                                                                                                                                                         |
| sync_objects                       | Array of strings                                                                         | **参数解释:** 迁移元数据对象数组，DATABASE对应数据库，FUNCTION对应函数，TABLE对应表，PARTITION对应分区 **取值范围:** 数组元素个数为1\~4                                                                                                                                                                                                            |
| default_owner                      | String                                                                                   | **参数解释:** 默认用户信息，由用户确定 **取值范围:** 长度为0\~256个字符                                                                                                                                                                                                                                                          |
| locations                          | Array of [LocationReplaceRule] objects | **参数解释:** 路径替换表，由用户确定键值对后生成，最长20条记录 **取值范围:** 数组元素个数为0\~20                                                                                                                                                                                                                                             |
| instance_id                        | String                                                                                   | **参数解释:** 实例ID **取值范围:** 不涉及                                                                                                                                                                                                                                                                           |
| ignore_obs_checked                 | Boolean                                                                                  | **参数解释:** 忽略内表建表时对OBS路径的限制 **取值范围:** 不涉及                                                                                                                                                                                                                                                               |
| network_type                       | String                                                                                   | **参数解释:** 迁移网络类型，包括EIP，VPC_PEERING **取值范围:** 不涉及                                                                                                                                                                                                                                                       |
| accepted_vpc_id                    | String                                                                                   | **参数解释:** 对端rds所在的vpcid **取值范围:** 长度为0\~100个字符                                                                                                                                                                                                                                                         |
| security_group_id                  | String                                                                                   | **参数解释:** 元数据迁移时数据源所在的vpc的安全组id **取值范围:** 长度为0\~100个字符                                                                                                                                                                                                                                                 |
| migration_filter_type              | String                                                                                   | **参数解释:** 元数据过滤方式，分为按自定义规则和按元数据类型。BY_TYPE表示按元数据类型过滤，BY_PREFERENCE表示按自定义规则过滤 **取值范围:** 不涉及                                                                                                                                                                                                              |
| migration_preference_file_location | String                                                                                   | **参数解释:** 用于获取元数据迁移指定库表的OBS文件路径 **取值范围:** 长度为0\~4000个字符                                                                                                                                                                                                                                                |
| migration_preference_file_name     | String                                                                                   | **参数解释:** 元数据迁移指定库表文件名，文件名中不得包含 \<, \>, :, ", /, \|, ?, \* 这些特殊字符 **取值范围:** 长度为1\~512个字符                                                                                                                                                                                                               |
| execute_strategy                   | String                                                                                   | **参数解释:** 元数据迁移执行方式：MANNUAL手动执行、SCHEDULE调度执行、默认为MANNUAL **取值范围:** 不涉及                                                                                                                                                                                                                                  |
| execute_frequency                  | String                                                                                   | **参数解释:** 元数据迁移调度执行频率：可选值为MONTHLY每月执行、WEEKLY每周执行、DAILY每日执行、HOURLY每小时执行 **取值范围:** 不涉及                                                                                                                                                                                                                   |
| execute_day                        | String                                                                                   | **参数解释:** 元数据迁移调度执行的日期时间点，当execute_frequency为MONTHLY每月执行时，该选项表示每月执行的日期，范围为1\~31，注意如果当月实际不存在指定日期时则不执行，如选定了execute_frequency为MONTHLY且execute_day为30时，则2月不会触发元数据发现任务;当execute_frequency为WEEKLY每周执行时，该选项表示每周执行的日期，范围为1\~7;当execute_frequency为DAILY每日执行时或HOURLY每小时执行时，该选项值为\*，表示每天都会执行 **取值范围:** 长度为0\~2个字符 |
| execute_hour                       | String                                                                                   | **参数解释:** 元数据迁移调度执行的小时时间点，当execute_frequency为MONTHLY每月执行时或WEEKLY每周执行时或DAILY每日执行时，该选项表示选定的天内的执行时间点，范围为0\~23；当execute_frequency为HOURLY每小时执行时，该选项值为\*，表示每小时都会触发执行 **取值范围:** 长度为0\~2个字符                                                                                                                    |
| execute_minute                     | String                                                                                   | **参数解释:** 元数据迁移调度执行的分钟时间点，范围为0\~59，表示会在选定的时间点对应的分钟执行 **取值范围:** 长度为0\~2个字符                                                                                                                                                                                                                              |
   
 表6PermissionMigrationParameter 
| 参数                                          | 参数类型                                                                                                                   | 描述                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| migrate_existing_obs_acl                    | Boolean                                                                                                                | **参数解释:** 是否进行存量OBS路径权限迁移 **取值范围:** 不涉及                                                                                                                          |
| location                                    | String                                                                                                                 | **参数解释:** 用于获取权限迁移的OBS文件路径 **取值范围:** 长度为0\~4000个字符                                                                                                               |
| file_name                                   | String                                                                                                                 | **参数解释:** 权限json文件，文件名中不得包含 \<, \>, :,", /, \|, ?, \* 这些特殊字符 **取值范围:** 长度为1\~512个字符                                                                              |
| log_location                                | String                                                                                                                 | **参数解释:** 日志存放路径，由用户选择 **取值范围:** 长度为1\~1024个字符                                                                                                                   |
| target_location                             | String                                                                                                                 | **参数解释:** HDFS权限迁移的目标桶路径 **取值范围:** 长度为1\~1024个字符                                                                                                                 |
| policy_type                                 | String                                                                                                                 | **参数解释:** 权限类型：DLF、HDFS、RANGER、LAKEFORMATION、MRS_LOCAL_GAUSSDB对应mrs本地高斯数据库、MRS_RDS_FOR_PG对应mrs对接RDS POSTGRESQL数据库、MRS_RDS_FOR_MYSQL对应mrs对接MYSQL数据库 **取值范围:** 不涉及 |
| catalog_id                                  | String                                                                                                                 | **参数解释:** dlf权限策略转换需要传入catalog_id字段 **取值范围:** 长度为0\~1000个字符                                                                                                      |
| instance_id                                 | String                                                                                                                 | **参数解释:** 实例ID **取值范围:** 不涉及                                                                                                                                     |
| ranger_permission_migration_principal_relas | [RangerPermissionMigrationPrincipalRelas] object | **参数解释:** ranger的授权主体转换关系 **取值范围:** 不涉及                                                                                                                          |
| datasource_parameter                        | [DataSourceParameter] object                                         | 数据源参数。                                                                                                                                                                                                                                                                          |
| security_group_id                           | String                                                                                                                 | **参数解释:** 权限迁移时数据源所在的vpc的安全组id **取值范围:** 长度为0\~100个字符                                                                                                            |
| locations                                   | Array of [LocationReplaceRule] objects                               | **参数解释:** 路径替换表，由用户确定键值对后生成 **取值范围:** 数组元素个数为0\~2000                                                                                                             |
   
 表7RangerPermissionMigrationPrincipalRelas 
| 参数           | 参数类型   | 描述                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| user_to      | String | **参数解释:** user为转换对象 IAM_USER为IAM用户 IAM_GROUP为IAM群组 ROLE为角色 **取值范围:** 不涉及  |
| user_prefix  | String | **参数解释:** user转换后的对象名称的前缀 **取值范围:** 长度为0\~10个字符                                                                                                                                          |
| user_suffix  | String | **参数解释:** user转换后的对象名称的后缀 **取值范围:** 长度为0\~10个字符                                                                                                                                          |
| group_to     | String | **参数解释:** group为转换对象 IAM_USER为IAM用户 IAM_GROUP为IAM群组 ROLE为角色 **取值范围:** 不涉及 |
| group_prefix | String | **参数解释:** group转换后的对象名称的前缀 **取值范围:** 长度为0\~10个字符                                                                                                                                         |
| group_suffix | String | **参数解释:** group转换后的对象名称的后缀 **取值范围:** 长度为0\~10个字符                                                                                                                                         |
| role_to      | String | **参数解释:** role为转换对象 IAM_USER为IAM用户 IAM_GROUP为IAM群组 ROLE为角色 **取值范围:** 不涉及  |
| role_prefix  | String | **参数解释:** role转换后的对象名称的前缀 **取值范围:** 长度为0\~10个字符                                                                                                                                          |
| role_suffix  | String | **参数解释:** role转换后的对象名称的后缀 **取值范围:** 长度为0\~10个字符                                                                                                                                          |
   
 表8DataSourceParameter 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                 |
|:---|:---|:---|
| jdbc_url   | String | **参数解释:** JDBC URL。例如：jdbc:protocol://host:port/db_name **取值范围:** 最大长度为255          |
| username   | String | **参数解释:** 用户名，只能包含字母、数字，且长度不能超过255个字符 **取值范围:** 最大长度为255                            |
| password   | String | **参数解释:** 密码，此值只在创建或更新任务时可能传入，为空值时代表没有密码或不需要更新密码， 查询和列举时不能暴露密码 **取值范围:** 最大长度为255   |
| endpoint   | String | **参数解释:** endpoint URL。例如：example.com **取值范围:** 最大长度为255                            |
| access_key | String | **参数解释:** 访问密钥，此值只在创建或更新任务时可能传入，为空值时代表没有密钥或不需要更新密钥，查询和列举时不能暴露此密钥 **取值范围:** 最大长度为255 |
| secret_key | String | **参数解释:** 密钥，此值只在创建或更新任务时可能传入，为空值时代表没有密钥或不需要更新密钥， 查询和列举时不能暴露此密钥 **取值范围:** 最大长度为255  |
| subnet_ip  | String | **参数解释:** rds的子网ip **取值范围:** 不涉及                                                    |
   
 表9MetaDataDiscoveryParameter 
| 参数                  | 参数类型                                                                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|
| data_location       | String                                                               | **参数解释:** 数据存储路径，由用户选择 **取值范围:** 长度为1\~4000个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| target_catalog      | String                                                               | **参数解释:** 目标Catalog，发现元数据后要保存至的catalog **取值范围:** 长度为1\~256个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| target_database     | String                                                               | **参数解释:** 目标database，发现元数据后要保存至的database **取值范围:** 长度为1\~128个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| conflict_strategy   | String                                                               | **参数解释:** 冲突解决策略，UPDATE 表示仅更新现有元数据，不删除，INSERT表示仅创建元数据，不更新，不删除，UPSERT 表示仅创建和更新现有元数据，不删除，ONLY_CREATE_PARTITION表示仅创建分区 **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| file_discovery_type | String                                                               | **参数解释：** 文件发现类型 **取值范围：** 不涉及 - CSV：逗号分隔值的存储格式   - JSON：JavaScript对象表示法的存储格式   - ORC：优化行列存储格式   - AVRO：面向行的远程过程调用与数据序列化框架   - ALL：自动检测文件类型    |
| separator           | String                                                               | **参数解释:** 文件的分隔符，常用的分隔符包括逗号，分号等 **取值范围:** 长度为1\~10个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| quote               | String                                                               | **参数解释:** 文件的引号字符，常用的引号字符包括单引号，双引号，\\u0000等，取值范围DOUBLE_QUOTE、SINGLE_QUOTE、NULL_QUOTE **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| escape              | String                                                               | **参数解释:** 文件的转义字符 **取值范围:** 长度为1\~10个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| header              | Boolean                                                              | **参数解释:** 文件的第一行是否被认为是header，true为第一行是header，false为不是header。默认为false **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| file_sample_rate    | Integer                                                              | **参数解释:** 文件采样率 (%)，取值范围为 0到100，100表示百分之百全量扫描，0表示每个文件夹下只扫描一个文件 **取值范围:** 取值为0\~100                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| table_depth         | Integer                                                              | **参数解释:** 表深度。假设有路径obs://a/b/c/d/e=1/f=99，用户设置了数据存储路径为obs://a/b，则分组层级2代表以d为分界，d为table名，e=1和f=99说明table d 是分区表，并且分区键为e和f，分区值为1和99 **取值范围:** 取值为0\~1024                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| log_location        | String                                                               | **参数解释:** 日志存放路径，由用户选择 **取值范围:** 长度为1\~1024个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| default_owner       | String                                                               | **参数解释:** 默认用户信息，默认为创建此任务的用户 **取值范围:** 长度为1\~256个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| principals          | Array of [Principal] objects | **参数解释:** 主体信息 **取值范围:** 数组元素个数为0\~20                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| give_write          | Boolean                                                              | **参数解释:** 是否赋予写权限，true为赋予，false为不赋予。默认为false， 赋予写权限后授权主体将拥有读写权限 **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| instance_id         | String                                                               | **参数解释:** 实例ID **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| rediscovery_policy  | String                                                               | **参数解释:** 重新发现策略：FULL_DISCOVERY全量发现、INCREMENTAL_DISCOVERY增量发现、默认为FULL_DISCOVERY **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| execute_strategy    | String                                                               | **参数解释:** 元数据发现执行方式：MANNUAL手动执行、SCHEDULE调度执行、默认为MANNUAL **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| execute_frequency   | String                                                               | **参数解释:** 元数据发现调度执行频率：可选值为MONTHLY每月执行、WEEKLY每周执行、DAILY每日执行、HOURLY每小时执行 **取值范围:** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| execute_day         | String                                                               | **参数解释:** 元数据发现调度执行的日期时间点，当execute_frequency为MONTHLY每月执行时，该选项表示每月执行的日期，范围为1\~31，注意如果当月实际不存在指定日期时则不执行，如选定了execute_frequency为MONTHLY且execute_day为30时，则2月不会触发元数据发现任务;当execute_frequency为WEEKLY每周执行时，该选项表示每周执行的日期，范围为1\~7;当execute_frequency为DAILY每日执行时或HOURLY每小时执行时，该选项值为\*，表示每天都会执行 **取值范围:** 长度为0\~2个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| execute_hour        | String                                                               | **参数解释:** 元数据发现调度执行的小时时间点，当execute_frequency为MONTHLY每月执行时或WEEKLY每周执行时或DAILY每日执行时，该选项表示选定的天内的执行时间点，范围为0\~23；当execute_frequency为HOURLY每小时执行时，该选项值为\*，表示每小时都会触发执行 **取值范围:** 长度为0\~2个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| execute_minute      | String                                                               | **参数解释:** 元数据发现调度执行的分钟时间点，范围为0\~59，表示会在选定的时间点对应的分钟执行 **取值范围:** 长度为0\~2个字符                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
 表10Principal 
| 参数               | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| principal_type   | String | **参数解释:** 主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-为其它。 **取值范围:** 不涉及                                                           |
| principal_source | String | **参数解释:** 主体来源： IAM-云用户、 SAML-联邦用户、 LDAP-ld用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 **取值范围:** 不涉及 |
| principal_name   | String | **参数解释:** 主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1\~49个字符 **取值范围:** 长度为1\~49个字符                                                                                                                                                                                                                                                           |
   
 表11DisasterRecoveryParameter 
| 参数                            | 参数类型                                                                                     | 描述                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| source_instance_id            | String                                                                                   | 主实例ID，需要同步数据的实例。                                                                                                                                                                                                                                                        |
| source_project_id             | String                                                                                   | 主实例所属项目ID（必填），用于跨项目容灾场景。                                                                                                                                                                                                                                                |
| source_endpoint               | String                                                                                   | 主实例接入端点IP，如果存在多个ip使用逗号分隔                                                                                                                                                                                                                                                |
| log_location                  | String                                                                                   | 日志存放路径，由用户选择。                                                                                                                                                                                                                                                           |
| locations                     | Array of [LocationReplaceRule] objects | 路径替换表，由用户确定键值对后生成，最长20条记录。                                                                                                                                                                                                                                              |
| source_catalog                | String                                                                                   | 源catalog名称                                                                                                                                                                                                                                                              |
| target_catalog                | String                                                                                   | 目标catalog名称                                                                                                                                                                                                                                                             |
| sync_strategy                 | String                                                                                   | 同步策略：FULL_SYNC-全量同步、INCREMENTAL_SYNC-增量同步                                                                                                                                                                                                                               |
| incremental_sync_start_time   | String                                                                                   | 增量同步开始时间                                                                                                                                                                                                                                                                |
| sync_preference_file_location | String                                                                                   | 用于获取同步指定库表的OBS文件路径。                                                                                                                                                                                                                                                     |
| sync_preference_file_name     | String                                                                                   | 同步指定库表文件名，文件名中不得包含 \<, \>, :, ", /, , \|, ?, \* 这些特殊字符。                                                                                                                                                                                                                 |
| sync_permission_strategy      | String                                                                                   | 同步权限策略：IGNORE忽略权限同步、FULL_SYNC全量同步，默认为IGNORE。                                                                                                                                                                                                                            |
| data_validation_enabled       | Boolean                                                                                  | 数据校验开关，默认关闭。                                                                                                                                                                                                                                                            |
| execute_strategy              | String                                                                                   | 容灾任务执行方式：MANNUAL手动执行、SCHEDULE调度执行、默认为MANNUAL。                                                                                                                                                                                                                           |
| execute_frequency             | String                                                                                   | 容灾任务执行频率：可选值为MONTHLY每月执行、WEEKLY每周执行、DAILY每日执行、HOURLY每小时执行。                                                                                                                                                                                                              |
| execute_day                   | String                                                                                   | 容灾任务调度执行的日期时间点，当execute_frequency为MONTHLY每月执行时，该选项表示每月执行的日期，范围为1\~31，注意如果当月实际不存在指定日期时则不执行，如选定了execute_frequency为MONTHLY且execute_day为30时，则2月不会触发元数据发现任务;当execute_frequency为WEEKLY每周执行时，该选项表示每周执行的日期，范围为1\~7;当execute_frequency为DAILY每日执行时或HOURLY每小时执行时，该选项值为\*，表示每天都会执行。 |
| execute_hour                  | String                                                                                   | 容灾任务调度执行的小时时间点，当execute_frequency为MONTHLY每月执行时或WEEKLY每周执行时或DAILY每日执行时，该选项表示选定的天内的执行时间点，范围为0\~23；当execute_frequency为HOURLY每小时执行时，该选项值为\*，表示每小时都会触发执行。                                                                                                                    |
| execute_minute                | String                                                                                   | 容灾任务调度执行的分钟时间点，范围为0\~59，表示会在选定的时间点对应的分钟执行。                                                                                                                                                                                                                              |
   
 表12LocationReplaceRule 
| 参数    | 参数类型   | 描述                                                                                                                                                      |
|:---|:---|:---|
| key   | String | **参数解释:** 键，源路径 **取值范围:** 长度为1\~1024个字符  |
| value | String | **参数解释:** 值，替换路径 **取值范围:** 长度为0\~1024个字符 |
   
**状态码：400**
表13响应Body参数 
| 参数                | 参数类型   | 描述                                                      |
|:---|:---|:---|
| error_code        | String | **参数解释:** 错误码      |
| error_msg         | String | **参数解释:** 错误描述     |
| common_error_code | String | **参数解释:** CBC公共错误码 |
| solution_msg      | String | **参数解释:** 解决方案描述   |
   
**状态码：401**
表14响应Body参数 
| 参数                | 参数类型   | 描述                                                      |
|:---|:---|:---|
| error_code        | String | **参数解释:** 错误码      |
| error_msg         | String | **参数解释:** 错误描述     |
| common_error_code | String | **参数解释:** CBC公共错误码 |
| solution_msg      | String | **参数解释:** 解决方案描述   |
   
**状态码：403**
表15响应Body参数 
| 参数         | 参数类型                                               | 描述                                                  |
|:---|:---|:---|
| error      | [Error] object | **参数解释:** 错误信息 |
| error_code | String                                             | **参数解释:** 错误码  |
| error_msg  | String                                             | **参数解释:** 错误描述 |
| title      | String                                             | **参数解释:** 标题   |
   
 表16Error 
| 参数         | 参数类型   | 描述                                                  |
|:---|:---|:---|
| error_code | String | **参数解释:** 错误码  |
| error_msg  | String | **参数解释:** 错误描述 |
| title      | String | **参数解释:** 标题   |
| message    | String | **参数解释:** 错误信息 |
| code       | String | **参数解释:** 状态码  |
   
**状态码：404**
表17响应Body参数 
| 参数                | 参数类型   | 描述                                                      |
|:---|:---|:---|
| error_code        | String | **参数解释:** 错误码      |
| error_msg         | String | **参数解释:** 错误描述     |
| common_error_code | String | **参数解释:** CBC公共错误码 |
| solution_msg      | String | **参数解释:** 解决方案描述   |
   
**状态码：408**
表18响应Body参数 
| 参数                | 参数类型   | 描述                                                      |
|:---|:---|:---|
| error_code        | String | **参数解释:** 错误码      |
| error_msg         | String | **参数解释:** 错误描述     |
| common_error_code | String | **参数解释:** CBC公共错误码 |
| solution_msg      | String | **参数解释:** 解决方案描述   |
   
**状态码：500**
表19响应Body参数 
| 参数                | 参数类型   | 描述                                                      |
|:---|:---|:---|
| error_code        | String | **参数解释:** 错误码      |
| error_msg         | String | **参数解释:** 错误描述     |
| common_error_code | String | **参数解释:** CBC公共错误码 |
| solution_msg      | String | **参数解释:** 解决方案描述   |
   
#### 请求示例
```
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}
```
#### 响应示例
**状态码：200**
获取任务详情成功
```
{
  "id" : "03141229-84cd-4b1b-9733-dd124320c125",
  "name" : "testjob",
  "description" : "testJob",
  "type" : "METADATA_MIGRATION",
  "parameter" : {
    "metadata_migration_parameter" : {
      "datasource_type" : "ALIYUN_DLF",
      "datasource_parameter" : {
        "endpoint" : "protocol://example.com"
      },
      "source_catalog" : "sourceCatalog1",
      "target_catalog" : "targetCatalog1",
      "conflict_strategy" : "UPDATE",
      "log_location" : "obs://logStore/2023",
      "sync_objects" : [ "DATABASE" ],
      "locations" : [ {
        "key" : "test/test1",
        "value" : "test2/db"
      } ]
    }
  },
  "status" : {
    "status" : "SUCCESS"
  }
}
```
**状态码：400**
Bad Request
```
{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}
```
**状态码：401**
Unauthorized
```
{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}
```
**状态码：403**
Forbidden
```
{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}
```
**状态码：404**
Not Found
```
{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}
```
**状态码：408**
Request Timeout
```
{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}
```
**状态码：500**
Internal Server Error
```
{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 200 | 获取任务详情成功              |
| 400 | Bad Request           |
| 401 | Unauthorized          |
| 403 | Forbidden             |
| 404 | Not Found             |
| 408 | Request Timeout       |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-lakeformation/ErrorCode.html)。
