网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

修改任务信息

更新时间:2024-10-22 GMT+08:00
分享

功能介绍

修改任务信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目编号。获取方法,请参见获取项目ID

instance_id

String

LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户token。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

任务名称。

description

String

描述。

parameter

JobParameter object

任务参数。

表4 JobParameter

参数

是否必选

参数类型

描述

metadata_migration_parameter

MetaDataMigrationParameter object

元数据迁移参数。

permission_migration_parameter

PermissionMigrationParameter object

权限迁移参数。

metadata_discovery_parameter

MetaDataDiscoveryParameter object

元数据发现参数。

smn_notify

Boolean

该任务是否进行smn通知

smn_notify_topic

String

任务通知的smn主题

smn_notify_types

Array of strings

任务发起通知的类型,区分成功任务和失败任务,取值为SUCCESS、FAILED。

枚举值:

  • SUCCESS

  • FAILED

表5 MetaDataMigrationParameter

参数

是否必选

参数类型

描述

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)。

枚举值:

  • ALIYUN_DLF

  • MRS_RDS_FOR_MYSQL

  • OPEN_FOR_MYSQL

  • MRS_RDS_FOR_PG

  • MRS_LOCAL_GAUSSDB

datasource_parameter

DataSourceParameter object

数据源参数。

source_catalog

String

源Catalog,要迁移出的catalog。

target_catalog

String

目标Catalog,要迁移至的catalog。

conflict_strategy

String

冲突解决策略,UPSERT表示仅创建和更新现有元数据,不删除。

枚举值:

  • UPSERT

log_location

String

日志存放路径,由用户选择。

sync_objects

Array of strings

迁移元数据对象数组,DATABASE对应数据库,FUNCTION对应函数,TABLE对应表,PARTITION对应分区。

枚举值:

  • DATABASE

  • FUNCTION

  • TABLE

  • PARTITION

default_owner

String

默认用户信息,由用户确定。

locations

Array of LocationReplaceRule objects

路径替换表,由用户确定键值对后生成,最长20条记录。

instance_id

String

实例ID。

ignore_obs_checked

Boolean

忽略内表建表时对Obs路径的限制。

network_type

String

迁移网络类型,包括EIP,VPC_PEERING。

枚举值:

  • EIP

  • VPC_PEERING

accepted_vpc_id

String

对端rds所在的vpcid。

security_group_id

String

元数据迁移时数据源所在的vpc的安全组id

migration_filter_type

String

元数据过滤方式,分为按自定义规则和按元数据类型。BY_TYPE表示按元数据类型过滤,BY_PREFERENCE表示按自定义规则过滤。

枚举值:

  • BY_TYPE

  • BY_PREFERENCE

migration_preference_file_location

String

用于获取元数据迁移指定库表的obs文件路径。

migration_preference_file_name

String

元数据迁移指定库表文件名,文件名中不得包含 <, >, :, ", /, , |, ?, * 这些特殊字符。

表6 PermissionMigrationParameter

参数

是否必选

参数类型

描述

migrate_existing_obs_acl

Boolean

是否进行存量OBS路径权限迁移

location

String

用于获取权限迁移的obs文件路径。

file_name

String

权限json文件,文件名中不得包含 <, >, :, ", /, , |, ?, * 这些特殊字符。

log_location

String

日志存放路径,由用户选择。

target_location

String

HDFS权限迁移的目标桶路径

policy_type

String

权限类型:DLF、HDFS、RANGER、LAKEFORMATION、MRS_LOCAL_GAUSSDB对应mrs本地高斯数据库、MRS_RDS_FOR_PG对应mrs对接RDS POSTGRESQL数据库、MRS_RDS_FOR_MYSQL对应mrs对接MYSQL数据库

枚举值:

  • DLF

  • HDFS

  • RANGER

  • LAKEFORMATION

  • MRS_RDS_FOR_PG

  • MRS_LOCAL_GAUSSDB

  • MRS_RDS_FOR_MYSQL

catalog_id

String

dlf权限策略转换需要传入catalog_id字段。

instance_id

String

实例ID。

ranger_permission_migration_principal_relas

RangerPermissionMigrationPrincipalRelas object

ranger的授权主体转换关系。

datasource_parameter

DataSourceParameter object

数据源参数。

security_group_id

String

权限迁移时数据源所在的vpc的安全组id

locations

Array of LocationReplaceRule objects

路径替换表,由用户确定键值对后生成

表7 RangerPermissionMigrationPrincipalRelas

参数

是否必选

参数类型

描述

user_to

String

user转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

user_prefix

String

user转换后的对象名称的前缀。

user_suffix

String

user转换后的对象名称的后缀。

group_to

String

group转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

group_prefix

String

group转换后的对象名称的前缀。

group_suffix

String

group转换后的对象名称的后缀。

role_to

String

role转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

role_prefix

String

role转换后的对象名称的前缀。

role_suffix

String

role转换后的对象名称的后缀。

表8 DataSourceParameter

参数

是否必选

参数类型

描述

jdbc_url

String

JDBC URL。例如:jdbc:protocol://host:port/db_name。

username

String

用户名,只能包含字母、数字,且长度不能超过255个字符。

password

String

密码,此值只在创建或更新任务时可能传入,为空值时代表没有密码或不需要更新密码, 查询和列举时不能暴露密码。

endpoint

String

endpoint URL。例如:example.com。

access_key

String

访问钥匙,此值只在创建或更新任务时可能传入,为空值时代表没有密钥或不需要更新密钥,查询和列举时不能暴露此密钥。

secret_key

String

密钥,此值只在创建或更新任务时可能传入,为空值时代表没有密钥或不需要更新密钥, 查询和列举时不能暴露此密钥。

subnet_ip

String

rds的子网ip

表9 LocationReplaceRule

参数

是否必选

参数类型

描述

key

String

键,源路径。

value

String

值,替换路径。

表10 MetaDataDiscoveryParameter

参数

是否必选

参数类型

描述

data_location

String

数据存储路径,由用户选择。

target_catalog

String

目标Catalog,发现元数据后要保存至的catalog。

target_database

String

目标database,发现元数据后要保存至的database。

conflict_strategy

String

冲突解决策略,UPDATE 表示仅更新现有元数据,不删除,INSERT表示仅创建元数据,不更新,不删除,UPSERT 表示仅创建和更新现有元数据,不删除。

枚举值:

  • UPDATE

  • INSERT

  • UPSERT

file_discovery_type

String

文件发现类型, |- PARQUET open-source columnar storage format for Hadoop CSV stands for Comma Seperated Value JSON stands for Java Script Object Notation ORC stands for Optimized Row Columnar AVRO is a row-oriented remote procedure call and data serialization framework ALL means auto-detected the file types

枚举值:

  • PARQUET

  • CSV

  • JSON

  • ORC

  • AVRO

  • ALL

separator

String

文件的分隔符,常用的分隔符包括逗号,分号等。

quote

String

文件的引号字符,常用的引号字符包括单引号,双引号,\u0000等,取值范围DOUBLE_QUOTE、SINGLE_QUOTE、NULL_QUOTE。

枚举值:

  • DOUBLE_QUOTE

  • SINGLE_QUOTE

  • NULL_QUOTE

escape

String

文件的逃逸字符,常用的逃逸字符有 \。

header

Boolean

文件的第一行是否被认为是header,true为第一行是header,false为不是header。默认为false。

file_sample_rate

Integer

文件采样率 (%),取值范围为 0到100,100表示百分之百全量扫描,0表示每个文件夹下只扫描一个文件。

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。

log_location

String

日志存放路径,由用户选择。

default_owner

String

默认用户信息,默认为创建此任务的用户。

principals

Array of Principal objects

主体信息

give_write

Boolean

是否赋予写权限,true为赋予,false为不赋予。默认为false, 赋予写权限后授权主体将拥有读写权限。

instance_id

String

实例ID

rediscovery_policy

String

重新发现策略:FULL_DISCOVERY全量发现、INCREMENTAL_DISCOVERY增量发现、默认为FULL_DISCOVERY。

枚举值:

  • FULL_DISCOVERY

  • INCREMENTAL_DISCOVERY

execute_strategy

String

元数据发现执行方式:MANNUAL手动执行、SCHEDULE调度执行、默认为MANNUAL。

枚举值:

  • MANNUAL

  • SCHEDULE

execute_frequency

String

元数据发现调度执行频率:可选值为MONTHLY每月执行、WEEKLY每周执行、DAILY每日执行、HOURLY每小时执行。

枚举值:

  • MONTHLY

  • WEEKLY

  • DAILY

  • HOURLY

execute_day

String

元数据发现调度执行的日期时间点,当execute_frequency为MONLY每月执行时,该选项表示每月执行的日期,范围为1~31,注意如果当月实际不存在指定日期时则不执行,如选定了execute_frequency为MONLY且execute_day为30时,则2月不会触发元数据发现任务;当execute_frequency为WEEKLY每周执行时,该选项表示每周执行的日期,范围为1~7;当execute_frequency为DAILY每日执行时或HOURLY每小时执行时,该选项值为*,表示每天都会执行。

execute_hour

String

元数据发现调度执行的小时时间点,当execute_frequency为MONLY每月执行时或WEEKLY每周执行时或DAILY每日执行时,该选项表示选定的天内的执行时间点,范围为0~23;当execute_frequency为HOURLY每小时执行时,该选项值为*,表示每小时都会触发执行。

execute_minute

String

元数据发现调度执行的分钟时间点,范围为0~59,表示会在选定的时间点对应的分钟执行。

表11 Principal

参数

是否必选

参数类型

描述

principal_type

String

主体类型: USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-为其它。

枚举值:

  • USER

  • GROUP

  • ROLE

  • SHARE

  • OTHER

principal_source

String

主体来源: IAM-云用户、 SAML-联邦用户、 LDAP-ld用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。

枚举值:

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

principal_name

String

主体名称。只能包含中文、字母、数字和_-.特殊字符,且长度为1~49个字符。

响应参数

状态码: 200

表12 响应Body参数

参数

参数类型

描述

id

String

任务ID,创建任务时自动生成。例如:03141229-84cd-4b1b-9733-dd124320c125。

name

String

任务名称,只能包含中文、字母、数字和下划线,且长度为4到255个字符。

description

String

用户创建任务时写的描述信息。

type

String

METADATA_MIGRATION:元数据迁移、 PERMISSION_MIGRATION:数据权限迁移、 METADATA_DISCOVERY:元数据发现。

枚举值:

  • METADATA_MIGRATION

  • PERMISSION_MIGRATION

  • METADATA_DISCOVERY

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:部分成功

枚举值:

  • CREATED

  • SUBMITTED

  • RUNNING

  • SUCCESS

  • FAILED

  • STOPPED

  • FROZEN_RELEASABLE

  • FROZEN_UNRELEASABLE

  • PARTIAL_SUCCESS

表13 JobParameter

参数

参数类型

描述

metadata_migration_parameter

MetaDataMigrationParameter object

元数据迁移参数。

permission_migration_parameter

PermissionMigrationParameter object

权限迁移参数。

metadata_discovery_parameter

MetaDataDiscoveryParameter object

元数据发现参数。

smn_notify

Boolean

该任务是否进行smn通知

smn_notify_topic

String

任务通知的smn主题

smn_notify_types

Array of strings

任务发起通知的类型,区分成功任务和失败任务,取值为SUCCESS、FAILED。

枚举值:

  • SUCCESS

  • FAILED

表14 MetaDataMigrationParameter

参数

参数类型

描述

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)。

枚举值:

  • ALIYUN_DLF

  • MRS_RDS_FOR_MYSQL

  • OPEN_FOR_MYSQL

  • MRS_RDS_FOR_PG

  • MRS_LOCAL_GAUSSDB

datasource_parameter

DataSourceParameter object

数据源参数。

source_catalog

String

源Catalog,要迁移出的catalog。

target_catalog

String

目标Catalog,要迁移至的catalog。

conflict_strategy

String

冲突解决策略,UPSERT表示仅创建和更新现有元数据,不删除。

枚举值:

  • UPSERT

log_location

String

日志存放路径,由用户选择。

sync_objects

Array of strings

迁移元数据对象数组,DATABASE对应数据库,FUNCTION对应函数,TABLE对应表,PARTITION对应分区。

枚举值:

  • DATABASE

  • FUNCTION

  • TABLE

  • PARTITION

default_owner

String

默认用户信息,由用户确定。

locations

Array of LocationReplaceRule objects

路径替换表,由用户确定键值对后生成,最长20条记录。

instance_id

String

实例ID。

ignore_obs_checked

Boolean

忽略内表建表时对Obs路径的限制。

network_type

String

迁移网络类型,包括EIP,VPC_PEERING。

枚举值:

  • EIP

  • VPC_PEERING

accepted_vpc_id

String

对端rds所在的vpcid。

security_group_id

String

元数据迁移时数据源所在的vpc的安全组id

migration_filter_type

String

元数据过滤方式,分为按自定义规则和按元数据类型。BY_TYPE表示按元数据类型过滤,BY_PREFERENCE表示按自定义规则过滤。

枚举值:

  • BY_TYPE

  • BY_PREFERENCE

migration_preference_file_location

String

用于获取元数据迁移指定库表的obs文件路径。

migration_preference_file_name

String

元数据迁移指定库表文件名,文件名中不得包含 <, >, :, ", /, , |, ?, * 这些特殊字符。

表15 PermissionMigrationParameter

参数

参数类型

描述

migrate_existing_obs_acl

Boolean

是否进行存量OBS路径权限迁移

location

String

用于获取权限迁移的obs文件路径。

file_name

String

权限json文件,文件名中不得包含 <, >, :, ", /, , |, ?, * 这些特殊字符。

log_location

String

日志存放路径,由用户选择。

target_location

String

HDFS权限迁移的目标桶路径

policy_type

String

权限类型:DLF、HDFS、RANGER、LAKEFORMATION、MRS_LOCAL_GAUSSDB对应mrs本地高斯数据库、MRS_RDS_FOR_PG对应mrs对接RDS POSTGRESQL数据库、MRS_RDS_FOR_MYSQL对应mrs对接MYSQL数据库

枚举值:

  • DLF

  • HDFS

  • RANGER

  • LAKEFORMATION

  • MRS_RDS_FOR_PG

  • MRS_LOCAL_GAUSSDB

  • MRS_RDS_FOR_MYSQL

catalog_id

String

dlf权限策略转换需要传入catalog_id字段。

instance_id

String

实例ID。

ranger_permission_migration_principal_relas

RangerPermissionMigrationPrincipalRelas object

ranger的授权主体转换关系。

datasource_parameter

DataSourceParameter object

数据源参数。

security_group_id

String

权限迁移时数据源所在的vpc的安全组id

locations

Array of LocationReplaceRule objects

路径替换表,由用户确定键值对后生成

表16 RangerPermissionMigrationPrincipalRelas

参数

参数类型

描述

user_to

String

user转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

user_prefix

String

user转换后的对象名称的前缀。

user_suffix

String

user转换后的对象名称的后缀。

group_to

String

group转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

group_prefix

String

group转换后的对象名称的前缀。

group_suffix

String

group转换后的对象名称的后缀。

role_to

String

role转换对象, IAM_USER为iam用户, IAM_GROUP为iam群组, ROLE为角色。

枚举值:

  • IAM_USER

  • IAM_GROUP

  • ROLE

role_prefix

String

role转换后的对象名称的前缀。

role_suffix

String

role转换后的对象名称的后缀。

表17 DataSourceParameter

参数

参数类型

描述

jdbc_url

String

JDBC URL。例如:jdbc:protocol://host:port/db_name。

username

String

用户名,只能包含字母、数字,且长度不能超过255个字符。

password

String

密码,此值只在创建或更新任务时可能传入,为空值时代表没有密码或不需要更新密码, 查询和列举时不能暴露密码。

endpoint

String

endpoint URL。例如:example.com。

access_key

String

访问钥匙,此值只在创建或更新任务时可能传入,为空值时代表没有密钥或不需要更新密钥,查询和列举时不能暴露此密钥。

secret_key

String

密钥,此值只在创建或更新任务时可能传入,为空值时代表没有密钥或不需要更新密钥, 查询和列举时不能暴露此密钥。

subnet_ip

String

rds的子网ip

表18 LocationReplaceRule

参数

参数类型

描述

key

String

键,源路径。

value

String

值,替换路径。

表19 MetaDataDiscoveryParameter

参数

参数类型

描述

data_location

String

数据存储路径,由用户选择。

target_catalog

String

目标Catalog,发现元数据后要保存至的catalog。

target_database

String

目标database,发现元数据后要保存至的database。

conflict_strategy

String

冲突解决策略,UPDATE 表示仅更新现有元数据,不删除,INSERT表示仅创建元数据,不更新,不删除,UPSERT 表示仅创建和更新现有元数据,不删除。

枚举值:

  • UPDATE

  • INSERT

  • UPSERT

file_discovery_type

String

文件发现类型, |- PARQUET open-source columnar storage format for Hadoop CSV stands for Comma Seperated Value JSON stands for Java Script Object Notation ORC stands for Optimized Row Columnar AVRO is a row-oriented remote procedure call and data serialization framework ALL means auto-detected the file types

枚举值:

  • PARQUET

  • CSV

  • JSON

  • ORC

  • AVRO

  • ALL

separator

String

文件的分隔符,常用的分隔符包括逗号,分号等。

quote

String

文件的引号字符,常用的引号字符包括单引号,双引号,\u0000等,取值范围DOUBLE_QUOTE、SINGLE_QUOTE、NULL_QUOTE。

枚举值:

  • DOUBLE_QUOTE

  • SINGLE_QUOTE

  • NULL_QUOTE

escape

String

文件的逃逸字符,常用的逃逸字符有 \。

header

Boolean

文件的第一行是否被认为是header,true为第一行是header,false为不是header。默认为false。

file_sample_rate

Integer

文件采样率 (%),取值范围为 0到100,100表示百分之百全量扫描,0表示每个文件夹下只扫描一个文件。

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。

log_location

String

日志存放路径,由用户选择。

default_owner

String

默认用户信息,默认为创建此任务的用户。

principals

Array of Principal objects

主体信息

give_write

Boolean

是否赋予写权限,true为赋予,false为不赋予。默认为false, 赋予写权限后授权主体将拥有读写权限。

instance_id

String

实例ID

rediscovery_policy

String

重新发现策略:FULL_DISCOVERY全量发现、INCREMENTAL_DISCOVERY增量发现、默认为FULL_DISCOVERY。

枚举值:

  • FULL_DISCOVERY

  • INCREMENTAL_DISCOVERY

execute_strategy

String

元数据发现执行方式:MANNUAL手动执行、SCHEDULE调度执行、默认为MANNUAL。

枚举值:

  • MANNUAL

  • SCHEDULE

execute_frequency

String

元数据发现调度执行频率:可选值为MONTHLY每月执行、WEEKLY每周执行、DAILY每日执行、HOURLY每小时执行。

枚举值:

  • MONTHLY

  • WEEKLY

  • DAILY

  • HOURLY

execute_day

String

元数据发现调度执行的日期时间点,当execute_frequency为MONLY每月执行时,该选项表示每月执行的日期,范围为1~31,注意如果当月实际不存在指定日期时则不执行,如选定了execute_frequency为MONLY且execute_day为30时,则2月不会触发元数据发现任务;当execute_frequency为WEEKLY每周执行时,该选项表示每周执行的日期,范围为1~7;当execute_frequency为DAILY每日执行时或HOURLY每小时执行时,该选项值为*,表示每天都会执行。

execute_hour

String

元数据发现调度执行的小时时间点,当execute_frequency为MONLY每月执行时或WEEKLY每周执行时或DAILY每日执行时,该选项表示选定的天内的执行时间点,范围为0~23;当execute_frequency为HOURLY每小时执行时,该选项值为*,表示每小时都会触发执行。

execute_minute

String

元数据发现调度执行的分钟时间点,范围为0~59,表示会在选定的时间点对应的分钟执行。

表20 Principal

参数

参数类型

描述

principal_type

String

主体类型: USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-为其它。

枚举值:

  • USER

  • GROUP

  • ROLE

  • SHARE

  • OTHER

principal_source

String

主体来源: IAM-云用户、 SAML-联邦用户、 LDAP-ld用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。

枚举值:

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

principal_name

String

主体名称。只能包含中文、字母、数字和_-.特殊字符,且长度为1~49个字符。

状态码: 400

表21 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码: 404

表22 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

状态码: 500

表23 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

common_error_code

String

CBC公共错误码。

solution_msg

String

解决方案描述。

请求示例

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/lf-jobs/{job_id}

{
  "name" : "testjob",
  "description" : "string",
  "parameter" : {
    "metadata_migration_parameter" : {
      "datasource_type" : "ALIYUN_DLF",
      "datasource_parameter" : {
        "endpoint" : "protocol://example.com",
        "access_key" : "LTAIxxxxxxxxxxxxxxxxRxPG",
        "secret_key" : "1234xxxxxxxxxxxxxxxxxxxxefgh"
      },
      "source_catalog" : "sourceCatalog1",
      "target_catalog" : "targetCatalog1",
      "conflict_strategy" : "UPDATE",
      "log_location" : "obs://logStore/2023",
      "sync_objects" : [ "DATABASE" ],
      "locations" : [ {
        "key" : "test/test1",
        "value" : "test2/db"
      } ],
      "instance_id" : "12345678910a"
    }
  }
}

响应示例

状态码: 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

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容