华为云用户手册

  • 响应参数 状态码: 202 表10 响应Body参数 参数 参数类型 描述 name String 集群名称 id String 集群ID task Task object 任务信息 datastore Datastore object 集群信息 instances Array of ClusterInstance objects 集群的节点信息 表11 Task 参数 参数类型 描述 id String 任务id name String 任务名称 表12 Datastore 参数 参数类型 描述 type String 类型,一般为cdm。 version String 集群版本。 表13 ClusterInstance 参数 参数类型 描述 id String 节点的虚拟机ID。 name String 节点的虚拟机名称。 type String 节点类型,只支持一种类型“cdm”。 shard_id String 分片ID
  • 响应示例 状态码: 200 ok { "publicEndpoint" : "49.xx.xx.10", "instances" : [ { "flavor" : { "id" : "fb8fe666-6734-4b11-bc6c-43d11db3c745" }, "volume" : { "size" : "100", "type" : "LOCAL_DISK" }, "name" : "cdm-c018", "id" : "635dce67-3df8-4756-b4c7-90e45e687367", "isFrozen" : "0", "type" : "cdm", "actions" : "REBOOTING", "config_status" : "In-Sync", "status" : "200" } ], "created" : "2018-09-05T08:38:25", "statusDetail" : "Normal", "actionProgress" : { }, "name" : "cdm-c018", "id" : "bae65496-643e-47ca-84af-948672de7eeb", "isFrozen" : "0", "actions" : "REBOOTING", "updated" : "2018-09-05T08:38:25", "status" : "200" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 publicEndpoint String 集群绑定的EIP instances Array of ClusterDetailInstance objects 集群的节点信息,请参见instances参数说明 security_group_id String 安全组id subnet_id String 子网id vpc_id String 虚拟私有云ID customerConfig CustomerConfig object 用户配置信息 datastore Datastore object cdm信息 isAutoOff Boolean 自动关机 publicEndpointDomainName String 集群绑定的EIP域名 bakExpectedStartTime String 开始时间 bakKeepDay Integer 保留时间 maintainWindow maintainWindow object 维护窗口 recentEvent Integer 事件数 flavorName String 规格名称 azName String az名称 endpointDomainName String 对端域名 publicEndpointStatus publicEndpointStatus object EIP状态信息 isScheduleBootOff Boolean 选择是否启用定时开关机功能。定时开关机功能和自动关机功能不可同时开启 namespace String 命名空间 eipId String 弹性ip id failedReasons FailedReasons object 失败原因。集群处于正常状态时不返回。 dbuser String 数据库用户 links Array of ClusterLinks objects 集群连接信息 clusterMode String 集群模式:sharding(分片集群) task ClusterTask object 任务信息 created String 集群创建时间,格式为ISO8601:YYYY-MM-DDThh:mm:ssZ statusDetail String 集群状态描述:Normal(正常) config_status String 集群配置状态: In-Sync:配置已同步。 Applying:配置中。 Sync-Failure:配置失败 actionProgress ActionProgress object 集群操作进度,任务信息,由key、value组成。key值为正在进行的任务,value值为正在进行任务的进度。示例如 "action_progress":{"SNAPSHOTTING":"16%"} name String 集群名称 id String 集群ID isFrozen String 集群是否冻结:0:否1:是 actions Array of strings 集群配置状态:In-Sync:配置已同步。Applying:配置中。Sync-Failure:配置失败 updated String 集群更新时间,格式为 ISO8601:YYYY-MM-DDThh:mm:ssZ status String 集群状态: 100:创建中 200:正常 300:失败 303:创建失败 800:冻结 900:已关机 910:正在关机 920:正在开机 表4 ClusterDetailInstance 参数 参数类型 描述 flavor flavor object 节点的虚拟机规格,请参见flavor参数说明(查询集群列表时返回值为null)。 volume volume object 节点的磁盘信息,请参见volume参数说明(查询集群列表时返回值为null)。 status String 节点状态: 100:创建中。 200:正常。 300:失败。 303:创建失败。 400:已删除。 800:冻结。 actions Array of strings 节点操作状态列表: REBOOTING:重启中。 RESTORING:恢复中。 REBOOT_FAILURE:重启失败。 type String 节点类型,只支持一种类型“cdm”。 id String 节点的虚拟机ID。 name String 节点的虚拟机名称。 isFrozen String 节点是否冻结:0:否。1:是。 components String 组件 config_status String 节点配置状态(查询集群列表时为null): In-Sync:配置已同步。 Applying:配置中。 Sync-Failure:配置失败。 role String 实例角色 group String 分组 links Array of ClusterLinks objects 链接信息(查询集群列表时返回值为null) paramsGroupId String 组件分组id publicIp String 公网ip manageIp String 管理ip trafficIp String 流量ip shard_id String 分片id manage_fix_ip String 管理修复ip private_ip String 私有ip internal_ip String 内部ip resource Array of Resource objects 资源信息(查询集群列表时返回值为null) 表5 flavor 参数 参数类型 描述 id String 节点虚拟机的规格ID。 links Array of ClusterLinks objects 链接信息 表6 volume 参数 参数类型 描述 type String 节点的磁盘类型,只支持本地磁盘 size Long 节点磁盘大小,单位G。 表7 Resource 参数 参数类型 描述 resource_id String 资源id resource_type String 资源类型:server(服务器) 表8 CustomerConfig 参数 参数类型 描述 failureRemind String 失败提醒。 clusterName String 集群类型。 serviceProvider String 服务提供 localDisk String 是否本地磁盘。 ssl String 是否使用ssl。 createFrom String 创建来源 resourceId String 资源ID flavorType String 规格类型 workSpaceId String 工作空间ID trial String 适用 表9 Datastore 参数 参数类型 描述 type String 类型,一般为cdm。 version String 集群版本。 表10 maintainWindow 参数 参数类型 描述 day String 周几 startTime String 开始时间。 endTime String 结束时间。 表11 publicEndpointStatus 参数 参数类型 描述 status String 状态 errorMessage String 错误信息 表12 FailedReasons 参数 参数类型 描述 CREATE_FAILED CREATE_FAILED object 集群创建失败原因。 表13 CREATE_FAILED 参数 参数类型 描述 errorCode String 错误码 errorMsg String 失败原因 表14 ClusterLinks 参数 参数类型 描述 rel String 关系 href String 链接地址 表15 ClusterTask 参数 参数类型 描述 description String 任务描述 id String 任务id name String 任务名称 表16 ActionProgress 参数 参数类型 描述 CREATING String 创建集群进度,例如:29% GROWING String 扩容集群进度,例如:29% RESTORING String 恢复集群进度,例如:29% SNAPSHOTTING String 集群快照进度,例如:29% REPAIRING String 修复集群进度,例如:29%
  • 响应示例 状态码: 200 ok { "submissions" : [ { "isIncrementing" : false, "job-name" : "obs2obs-03", "submission-id" : 13, "isStopingIncrement" : "", "last-update-date" : 1635909057030, "is-execute-auto" : false, "delete_rows" : 0, "write_rows" : 0, "isDeleteJob" : false, "creation-user" : "mwx5316849", "progress" : 0, "creation-date" : 1635909057030, "update_rows" : 0, "status" : "PENDING", "execute-date" : 1635909057030 } ] }
  • 请求示例 在CDM集群ID列表中随机选择一个集群,创建一个源端为elasticsearch,目的端为DIS,作业名为es_css的表迁移作业。 POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/job { "jobs" : [ { "job_type" : "NORMAL_JOB", "from-connector-name" : "elasticsearch-connector", "to-config-values" : { "configs" : [ { "inputs" : [ { "name" : "toJobConfig.streamName", "value" : "dis-lkGm" }, { "name" : "toJobConfig.separator", "value" : "|" }, { "name" : "toJobConfig.columnList", "value" : "1&2&3" } ], "name" : "toJobConfig" } ] }, "to-link-name" : "dis", "driver-config-values" : { "configs" : [ { "inputs" : [ { "name" : "throttlingConfig.numExtractors", "value" : "1" }, { "name" : "throttlingConfig.submitToCluster", "value" : "false" }, { "name" : "throttlingConfig.numLoaders", "value" : "1" }, { "name" : "throttlingConfig.recordDirtyData", "value" : "false" } ], "name" : "throttlingConfig" }, { "inputs" : [ ], "name" : "jarConfig" }, { "inputs" : [ { "name" : "schedulerConfig.isSchedulerJob", "value" : "false" }, { "name" : "schedulerConfig.disposableType", "value" : "NONE" } ], "name" : "schedulerConfig" }, { "inputs" : [ ], "name" : "transformConfig" }, { "inputs" : [ { "name" : "retryJobConfig.retryJobType", "value" : "NONE" } ], "name" : "retryJobConfig" } ] }, "from-config-values" : { "configs" : [ { "inputs" : [ { "name" : "fromJobConfig.index", "value" : "52est" }, { "name" : "fromJobConfig.type", "value" : "est_array" }, { "name" : "fromJobConfig.columnList", "value" : "array_f1_int:long&array_f2_text:string&array_f3_object:nested" }, { "name" : "fromJobConfig.splitNestedField", "value" : "false" } ], "name" : "fromJobConfig" } ] }, "to-connector-name" : "dis-connector", "name" : "es_css", "from-link-name" : "css" } ], "clusters" : [ "b0791496-e111-4e75-b7ca-9277aeab9297", "c2db1191-eb6c-464a-a0d3-b434e6c6df26", "c2db1191-eb6c-464a-a0d3-b434e6c6df26" ] }
  • 响应参数 状态码: 200 表9 响应Body参数 参数 参数类型 描述 submissions Array of StartJobSubmission objects 作业运行信息,请参见submission参数说明 表10 StartJobSubmission 参数 参数类型 描述 isIncrementing Boolean 作业是否为增量迁移 delete_rows Integer 删除数据行数 update_rows Integer 更新数据行数 write_rows Integer 写入数据行数 submission-id Integer 作业提交id job-name String 作业名称 creation-user String 创建用户 creation-date Long 创建时间,单位:毫秒。 execute-date Long 执行时间 progress Float 作业进度,失败时为“-1”,其它情况为0~100 status String 作业状态: BOOTING:启动中。 FAILURE_ON_SUBMIT:提交失败。 RUNNING:运行中。 SUCCEEDED:成功。 FAILED:失败。 UNKNOWN:未知。 NEVER_EXECUTED:未被执行 isStopingIncrement String 是否停止增量迁移 is-execute-auto Boolean 是否定时执行作业 last-update-date Long 作业最后更新时间 last-udpate-user String 最后更新作业状态的用户 isDeleteJob Boolean 作业执行完成后是否删除
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 X-Language 是 String 请求语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of Job objects 作业列表,请参见jobs数据结构说明。 clusters 是 Array of strings CDM集群ID列表,系统会从里面随机选择一个开机状态的集群,在该集群中创建作业并执行作业。 表4 Job 参数 是否必选 参数类型 描述 job_type 否 String 作业类型: NORMAL_JOB:表/文件迁移。 BATCH_JOB:整库迁移。 SCENARIO_JOB:场景迁移。 枚举值: NORMAL_JOB BATCH_JOB SCENARIO_JOB from-connector-name 是 String 源端连接类型,对应的连接参数如下: generic-jdbc-connector:关系数据库连接。 obs-connector:OBS连接。 hdfs-connector:HDFS连接。 hbase-connector:HBase连接、CloudTable连接。 hive-connector:Hive连接。 ftp-connector/sftp-connector:FTP/SFTP连接。 mongodb-connector:MongoDB连接。 redis-connector:Redis/DCS连接。 kafka-connector:Kafka连接。 dis-connector:DIS连接。 elasticsearch-connector:Elasticsearch/云搜索服务连接。 dli-connector:DLI连接。 http-connector:HTTP/HTTPS连接,该连接暂无连接参数。 dms-kafka-connector:DMSKafka连接 to-config-values 是 ConfigValues object 目的连接参数配置。根据不同目的端有不同的参数配置,具体可参考目的端作业参数说明下相应的目的端参数配置。 to-link-name 是 String 目的端连接名称,即为通过“创建连接”接口创建的连接对应的连接名。 driver-config-values 是 ConfigValues object 作业任务参数配置。例如配置作业失败重试、抽取并发数,具体可参考作业任务参数说明。 from-config-values 是 ConfigValues object 源连接参数配置。根据不同源端有不同的参数配置,具体可参考源端作业参数说明下相应的源端参数配置。 to-connector-name 否 String 目的端连接类型,对应的连接参数如下: generic-jdbc-connector:关系数据库连接。 obs-connector:OBS连接。 hdfs-connector:HDFS连接。 hbase-connector:HBase连接、CloudTable连接。 hive-connector:Hive连接。 ftp-connector/sftp-connector:FTP/SFTP连接。 mongodb-connector:MongoDB连接。 redis-connector:Redis/DCS连接。 kafka-connector:Kafka连接。 dis-connector:DIS连接。 elasticsearch-connector:Elasticsearch/云搜索服务连接。 dli-connector:DLI连接。 http-connector:HTTP/HTTPS连接,该连接暂无连接参数。 dms-kafka-connector:DMSKafka连接 name 否 String 作业名称,长度在1到240个字符之间 最小长度:1 最大长度:240 from-link-name 否 String 源连接名称,即为通过“创建连接”接口创建的连接对应的连接名。 creation-user 否 String 创建作业的用户。由系统生成,用户无需填写。 creation-date 否 Long 作业创建的时间,单位:毫秒。由系统生成,用户无需填写。 update-date 否 Long 作业最后更新的时间,单位:毫秒。由系统生成,用户无需填写。 is_incre_job 否 Boolean 是否是增量作业。已废弃 flag 否 Integer 是否是定时作业标记,如果是定时作业则为1,否则为0。由系统根据定时任务配置生成,用户无需填写。 files_read 否 Integer 已读文件数。由系统生成,用户无需填写。 update-user 否 String 最后更新作业的用户。由系统生成,用户无需填写。 external_id 否 String 具体执行的作业id,如果是本地作业,则一般为"job_local1202051771_0002"形式,如果是DLI作业,则为DLI作业ID,比如"12345"。由系统生成,用户无需填写。 type 否 String 与job_type一致,作业类型: NORMAL_JOB:表/文件迁移。 BATCH_JOB:整库迁移。 SCENARIO_JOB:场景迁移。 execute_start_date 否 Long 最近一次执行任务开始时间,单位:毫秒。由系统生成,用户无需填写。 delete_rows 否 Integer 增量作业删除行数,已废弃。 enabled 否 Boolean 是否激活连接。由系统生成,用户无需填写。 bytes_written 否 Long 作业写入的字节。由系统生成,用户无需填写。 id 否 Integer 作业ID。由系统生成,用户无需填写。 is_use_sql 否 Boolean 用户是否使用sql。由系统根据源端抽取是否使用sql语句生成,用户无需填写 update_rows 否 Integer 增量作业更新行数,已废弃。 group_name 否 String 组名 bytes_read 否 Long 作业读取的字节。由系统生成,用户无需填写。 execute_update_date 否 Long 最近一次执行任务更新时间,单位:毫秒。由系统生成,用户无需填写。 write_rows 否 Integer 增量作业写入行数,已废弃。 rows_written 否 Integer 作业写入的行数。由系统生成,用户无需填写。 rows_read 否 Long 作业读取的行数。由系统生成,用户无需填写。 files_written 否 Integer 写入文件数。由系统生成,用户无需填写。 is_incrementing 否 Boolean 是否是增量作业,同is_incre_job,已废弃。 execute_create_date 否 Long 最近一次执行任务创建时间,单位:毫秒。由系统生成,用户无需填写。 status 否 String 作业最后的执行状态: BOOTING:启动中。 RUNNING:运行中。 SUCCEEDED:成功。 FAILED:失败。 NEW:未被执行。 表5 ConfigValues 参数 是否必选 参数类型 描述 configs 是 Array of configs objects 源连接参数、目的连接参数和作业任务参数,它们的配置数据结构相同,其中“inputs”里的参数不一样,详细请参见configs数据结构说明 extended-configs 否 extended-configs object 扩展配置,请参见extended-configs参数说明。扩展配置暂不对外开放,用户无需填写。 表6 configs 参数 是否必选 参数类型 描述 inputs 是 Array of Input objects 输入参数列表,列表中的每个参数为“name,value”结构,请参考inputs数据结构参数说明。在“from-config-values”数据结构中,不同的源连接类型有不同的“inputs”参数列表,请参见源端作业参数说明下的章节。在“to-config-values”数据结构中,不同的目的连接类型有不同的“inputs”参数列表,请参见目的端作业参数说明下面的子章节。在“driver-config-values”数据结构中,“inputs”具体参数请参见作业任务参数说明。 name 是 String 配置名称:源端作业的配置名称为“fromJobConfig”。目的端作业的配置名称为“toJobConfig”,连接的配置名称固定为“linkConfig”。 id 否 Integer 配置ID,由系统生成,用户无需填写。 type 否 String 配置类型,由系统生成,用户无需填写。值为LINK或者JOB,如果是连接管理API,则为LINK;如果是作业管理API,则为JOB。 表7 Input 参数 是否必选 参数类型 描述 name 是 String 参数名: 如果是连接管理API,则以“linkConfig.”开头,对于不同连接类型有不同的参数,具体可参见连接参数说明下相应连接的参数说明。 如果是作业管理API,对于源端连接参数,则以“fromJobConfig.”开头,具体可参见源端作业参数说明下相应的源端参数说明;对于目的端连接参数,则以“toJobConfig.”开头,具体可参见目的端作业参数说明下相应的目的端参数说明;对于作业任务参数,请参见作业任务参数说明下相应的任务参数说明。 value 是 String 参数值,参数名对应的值,必须填写为字符串 type 否 String 值类型,如STRING、INTEGER,由系统设定,用户无需填写。 表8 extended-configs 参数 是否必选 参数类型 描述 name 否 String 扩展配置名称,暂不对外开放,用户无需填写。 value 否 String 扩展配置值,暂不对外开放,用户无需填写。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 submissions Array of StartJobSubmission objects 作业运行信息,请参见submission参数说明 表4 StartJobSubmission 参数 参数类型 描述 isIncrementing Boolean 作业是否为增量迁移 delete_rows Integer 删除数据行数 update_rows Integer 更新数据行数 write_rows Integer 写入数据行数 submission-id Integer 作业提交id job-name String 作业名称 creation-user String 创建用户 creation-date Long 创建时间,单位:毫秒。 execute-date Long 执行时间 progress Float 作业进度,失败时为“-1”,其它情况为0~100 status String 作业状态: BOOTING:启动中。 FAILURE_ON_SUBMIT:提交失败。 RUNNING:运行中。 SUCCEEDED:成功。 FAILED:失败。 UNKNOWN:未知。 NEVER_EXECUTED:未被执行 isStopingIncrement String 是否停止增量迁移 is-execute-auto Boolean 是否定时执行作业 last-update-date Long 作业最后更新时间 last-udpate-user String 最后更新作业状态的用户 isDeleteJob Boolean 作业执行完成后是否删除
  • 响应示例 状态码: 200 ok { "total" : 1, "jobs" : [ { "job_type" : "NORMAL_JOB", "from-connector-name" : "elasticsearch-connector", "to-config-values" : { "configs" : [ { "inputs" : [ { "name" : "toJobConfig.streamName", "value" : "dis-lkGm" }, { "name" : "toJobConfig.separator", "value" : "|" }, { "name" : "toJobConfig.columnList", "value" : "1&2&3" } ], "name" : "toJobConfig" } ] }, "to-link-name" : "dis", "driver-config-values" : { "configs" : [ { "inputs" : [ { "name" : "throttlingConfig.numExtractors", "value" : "1" }, { "name" : "throttlingConfig.submitToCluster", "value" : "false" }, { "name" : "throttlingConfig.numLoaders", "value" : "1" }, { "name" : "throttlingConfig.recordDirtyData", "value" : "false" } ], "name" : "throttlingConfig" }, { "inputs" : [ ], "name" : "jarConfig" }, { "inputs" : [ { "name" : "schedulerConfig.isSchedulerJob", "value" : "false" }, { "name" : "schedulerConfig.disposableType", "value" : "NONE" } ], "name" : "schedulerConfig" }, { "inputs" : [ ], "name" : "transformConfig" }, { "inputs" : [ { "name" : "retryJobConfig.retryJobType", "value" : "NONE" } ], "name" : "retryJobConfig" } ] }, "from-config-values" : { "configs" : [ { "inputs" : [ { "name" : "fromJobConfig.index", "value" : "52est" }, { "name" : "fromJobConfig.type", "value" : "est_array" }, { "name" : "fromJobConfig.columnList", "value" : "array_f1_int:long&array_f2_text:string&array_f3_object:nested" }, { "name" : "fromJobConfig.splitNestedField", "value" : "false" } ], "name" : "fromJobConfig" } ] }, "to-connector-name" : "dis-connector", "name" : "es_css", "from-link-name" : "css" } ], "page_no" : 1, "page_size" : 10 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 作业数,查询单个作业时为0 jobs Array of Job objects 作业列表,请参见jobs参数说明 page_no Integer 返回指定页号的作业 page_size Integer 每页作业数 表5 Job 参数 参数类型 描述 job_type String 作业类型: NORMAL_JOB:表/文件迁移。 BATCH_JOB:整库迁移。 SCENARIO_JOB:场景迁移。 枚举值: NORMAL_JOB BATCH_JOB SCENARIO_JOB from-connector-name String 源端连接类型,对应的连接参数如下: generic-jdbc-connector:关系数据库连接。 obs-connector:OBS连接。 hdfs-connector:HDFS连接。 hbase-connector:HBase连接、CloudTable连接。 hive-connector:Hive连接。 ftp-connector/sftp-connector:FTP/SFTP连接。 mongodb-connector:MongoDB连接。 redis-connector:Redis/DCS连接。 kafka-connector:Kafka连接。 dis-connector:DIS连接。 elasticsearch-connector:Elasticsearch/云搜索服务连接。 dli-connector:DLI连接。 http-connector:HTTP/HTTPS连接,该连接暂无连接参数。 dms-kafka-connector:DMSKafka连接 to-config-values ConfigValues object 目的连接参数配置。根据不同目的端有不同的参数配置,具体可参考目的端作业参数说明下相应的目的端参数配置。 to-link-name String 目的端连接名称,即为通过“创建连接”接口创建的连接对应的连接名。 driver-config-values ConfigValues object 作业任务参数配置。例如配置作业失败重试、抽取并发数,具体可参考作业任务参数说明。 from-config-values ConfigValues object 源连接参数配置。根据不同源端有不同的参数配置,具体可参考源端作业参数说明下相应的源端参数配置。 to-connector-name String 目的端连接类型,对应的连接参数如下: generic-jdbc-connector:关系数据库连接。 obs-connector:OBS连接。 hdfs-connector:HDFS连接。 hbase-connector:HBase连接、CloudTable连接。 hive-connector:Hive连接。 ftp-connector/sftp-connector:FTP/SFTP连接。 mongodb-connector:MongoDB连接。 redis-connector:Redis/DCS连接。 kafka-connector:Kafka连接。 dis-connector:DIS连接。 elasticsearch-connector:Elasticsearch/云搜索服务连接。 dli-connector:DLI连接。 http-connector:HTTP/HTTPS连接,该连接暂无连接参数。 dms-kafka-connector:DMSKafka连接 name String 作业名称,长度在1到240个字符之间 最小长度:1 最大长度:240 from-link-name String 源连接名称,即为通过“创建连接”接口创建的连接对应的连接名。 creation-user String 创建作业的用户。由系统生成,用户无需填写。 creation-date Long 作业创建的时间,单位:毫秒。由系统生成,用户无需填写。 update-date Long 作业最后更新的时间,单位:毫秒。由系统生成,用户无需填写。 is_incre_job Boolean 是否是增量作业。已废弃 flag Integer 是否是定时作业标记,如果是定时作业则为1,否则为0。由系统根据定时任务配置生成,用户无需填写。 files_read Integer 已读文件数。由系统生成,用户无需填写。 update-user String 最后更新作业的用户。由系统生成,用户无需填写。 external_id String 具体执行的作业id,如果是本地作业,则一般为"job_local1202051771_0002"形式,如果是DLI作业,则为DLI作业ID,比如"12345"。由系统生成,用户无需填写。 type String 与job_type一致,作业类型: NORMAL_JOB:表/文件迁移。 BATCH_JOB:整库迁移。 SCENARIO_JOB:场景迁移。 execute_start_date Long 最近一次执行任务开始时间,单位:毫秒。由系统生成,用户无需填写。 delete_rows Integer 增量作业删除行数,已废弃。 enabled Boolean 是否激活连接。由系统生成,用户无需填写。 bytes_written Long 作业写入的字节。由系统生成,用户无需填写。 id Integer 作业ID。由系统生成,用户无需填写。 is_use_sql Boolean 用户是否使用sql。由系统根据源端抽取是否使用sql语句生成,用户无需填写 update_rows Integer 增量作业更新行数,已废弃。 group_name String 组名 bytes_read Long 作业读取的字节。由系统生成,用户无需填写。 execute_update_date Long 最近一次执行任务更新时间,单位:毫秒。由系统生成,用户无需填写。 write_rows Integer 增量作业写入行数,已废弃。 rows_written Integer 作业写入的行数。由系统生成,用户无需填写。 rows_read Long 作业读取的行数。由系统生成,用户无需填写。 files_written Integer 写入文件数。由系统生成,用户无需填写。 is_incrementing Boolean 是否是增量作业,同is_incre_job,已废弃。 execute_create_date Long 最近一次执行任务创建时间,单位:毫秒。由系统生成,用户无需填写。 status String 作业最后的执行状态: BOOTING:启动中。 RUNNING:运行中。 SUCCEEDED:成功。 FAILED:失败。 NEW:未被执行。 表6 ConfigValues 参数 参数类型 描述 configs Array of configs objects 源连接参数、目的连接参数和作业任务参数,它们的配置数据结构相同,其中“inputs”里的参数不一样,详细请参见configs数据结构说明 extended-configs extended-configs object 扩展配置,请参见extended-configs参数说明。扩展配置暂不对外开放,用户无需填写。 表7 configs 参数 参数类型 描述 inputs Array of Input objects 输入参数列表,列表中的每个参数为“name,value”结构,请参考inputs数据结构参数说明。在“from-config-values”数据结构中,不同的源连接类型有不同的“inputs”参数列表,请参见源端作业参数说明下的章节。在“to-config-values”数据结构中,不同的目的连接类型有不同的“inputs”参数列表,请参见目的端作业参数说明下面的子章节。在“driver-config-values”数据结构中,“inputs”具体参数请参见作业任务参数说明。 name String 配置名称:源端作业的配置名称为“fromJobConfig”。目的端作业的配置名称为“toJobConfig”,连接的配置名称固定为“linkConfig”。 id Integer 配置ID,由系统生成,用户无需填写。 type String 配置类型,由系统生成,用户无需填写。值为LINK或者JOB,如果是连接管理API,则为LINK;如果是作业管理API,则为JOB。 表8 Input 参数 参数类型 描述 name String 参数名: 如果是连接管理API,则以“linkConfig.”开头,对于不同连接类型有不同的参数,具体可参见连接参数说明下相应连接的参数说明。 如果是作业管理API,对于源端连接参数,则以“fromJobConfig.”开头,具体可参见源端作业参数说明下相应的源端参数说明;对于目的端连接参数,则以“toJobConfig.”开头,具体可参见目的端作业参数说明下相应的目的端参数说明;对于作业任务参数,请参见作业任务参数说明下相应的任务参数说明。 value String 参数值,参数名对应的值,必须填写为字符串 type String 值类型,如STRING、INTEGER,由系统设定,用户无需填写。 表9 extended-configs 参数 参数类型 描述 name String 扩展配置名称,暂不对外开放,用户无需填写。 value String 扩展配置值,暂不对外开放,用户无需填写。
  • URI GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见项目ID和帐号ID cluster_id 是 String 集群ID job_name 是 String 查询多个作业用all,查询单个作业输入作业名 表2 Query参数 参数 是否必选 参数类型 描述 filter 否 String 当“job_name”为“all”时,此参数用于模糊过滤作业 page_no 否 Integer 指定作业页号 最小值:1 page_size 否 Integer 每页作业数,值在10-100之间 最小值:10 最大值:100 jobType 否 String 作业类型: jobType=NORMAL_JOB:表示查询表/文件迁移的作业。 jobType=BATCH_JOB:表示查询整库迁移的作业。 jobType=SCENARIO_JOB:表示查询场景迁移的作业。 不指定该参数时,默认只查询表/文件迁移的作业。 枚举值: NORMAL_JOB BATCH_JOB SCENARIO_JOB
  • 请求参数 表2 请求Header参数 参数名 是否必选 参数类型 说明 workspace 否 String 工作空间id。 如果不设置该参数,默认查询default工作空间下的数据。 如果需要查询其他工作空间的数据,需要带上该消息头。 X-Auth-Token 否 String 使用Token认证时该字段必选,用户Token的长度要求如下: 最小长度:0 最大长度:4096 Content-Type 否 String 有Body体的情况下必选,无Body体的情况下则无需填写和校验。 示例:Content-Type: application/json;charset=UTF-8 Authorization 否 String 使用AK/SK进行认证时该字段必选。 Host 否 String 使用AK/SK进行认证时该字段必选。 表3 Body参数说明 参数名 是否必选 参数类型 说明 name 是 String 新的作业名称。
  • 包年/包月资源 对于包年/包月计费模式的ServiceComb引擎专享版,用户在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默认为到期前7日)之前关闭自动续费。
  • 续费相关的功能 包年/包月ServiceComb引擎专享版续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月ServiceComb引擎专享版从购买到被自动删除之前,您可以随时在费用中心为其续费,以延长ServiceComb引擎专享版的使用时间。 自动续费 开通自动续费后,ServiceComb引擎专享版会在每次到期前自动续费,避免因忘记手动续费而导致资源被自动删除。 在一个包年/包月ServiceComb引擎专享版生命周期的不同阶段,您可以根据需要选择一种方式进行续费,具体如图1所示。 图1 ServiceComb引擎专享版生命周期 ServiceComb引擎专享版从购买到到期前,处于正常运行阶段,资源状态为“使用中”。 到期后,资源状态变为“已过期”。 到期未续费时,ServiceComb引擎专享版首先会进入宽限期,宽限期到期后仍未续费,资源状态变为“已冻结”。 超过宽限期仍未续费将进入保留期,如果保留期内仍未续费,资源将被自动删除。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在ServiceComb引擎专享版到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至ServiceComb引擎专享版到期或者续费成功。到期前7日自动续费扣款是系统默认配置,您也可以根据需要修改此扣款日。
  • 续费简介 包年/包月ServiceComb引擎专享版到期后会影响ServiceComb引擎专享版正常运行。如果您想继续使用,需要在指定的时间内为ServiceComb引擎专享版续费,否则ServiceComb引擎专享版将被删除,数据丢失且不可恢复。 续费操作仅适用于包年/包月ServiceComb引擎专享版,按需计费不需要续费,只需要保证账户余额充足即可。 ServiceComb引擎专享版在到期前续费成功,所有资源得以保留,且ServiceComb引擎专享版的运行不受影响。ServiceComb引擎专享版到期后的状态说明,请参见到期后影响。
  • 变更配置后对计费的影响 如果您在购买按需计费引擎后变更了规格,会产生一个新订单并开始按新规格的价格计费,旧订单自动失效。 如果您在一个小时内变更了规格,将会产生多条计费信息。每条计费信息的开始时间和结束时间对应不同规格在该小时内的生效时间。 例如,您在9:00:00购买了一个注册配置中心Nacos引擎,实例规格为微服务实例数500,并在9:30:00升配为微服务实例数1000,那么在9:00:00 ~ 10:00:00间会产生两条计费信息。 第一条对应9:00:00 ~ 9:30:00,实例规格按照微服务实例数500计费。 第二条对应9:30:00 ~ 10:00:00,实例规格按照微服务实例数1000计费。
  • 计费示例 假设您在2023/04/18 9:59:30购买了一个按需计费注册配置中心Nacos引擎(规格:微服务实例数500),然后在2023/04/18 10:45:46将其删除,则: 第一个计费周期为9:00:00 ~ 10:00:00,在9:59:30 ~ 10:00:00间产生费用,该计费周期内的计费时长为30秒。该计费周期内的花费为:(0.407+0.134*10)÷3600*30=0.01元。 第二个计费周期为10:00:00 ~ 11:00:00,在10:00:00 ~ 10:45:46间产生费用,该计费周期内的计费时长为2746秒。该计费周期内的花费为:(0.407+0.134*10)÷3600*2746=1.33元。 您需要为每个计费周期付费,即为0.01+1.33=1.34元,计费公式如表2所示。产品价格详情中标出了资源的每小时价格,您需要将每小时价格除以3600,得到每秒价格。 表2 计费公式 资源类型 计费公式 单价 注册配置中心Nacos实例 单价 *使用时长 请参考计费模式概述。 注册配置中心Nacos容量单元(50微服务实例) 容量单元单价*10*使用时长 请参考计费模式概述。 该示例中的价格仅供参考,实际计算请以价格计算器中的价格为准。
  • 计费周期 按需计费注册配置中心是按秒计费,每一个小时整点结算一次费用(以GMT+8:00时间为准),结算完毕后进入新的计费周期。计费的起点以引擎创建开始的时间点为准,终点以引擎删除时间为准。 例如,您在8:05:00购买了一个注册配置中心,然后在8:55:00将其删除成功,则计费周期为8:00:00 ~ 9:00:00,在8:05:00 ~ 8:55:00间产生费用,该计费周期内的计费时长为3000秒。
  • 适用计费项 根据需要托管的微服务实例数量总额选择注册配置中心Nacos引擎的规格,系统会根据选择的引擎规格计费,以下计费项支持按需计费。 表1 适用计费项 计费项 说明 注册配置中心Nacos实例 注册配置中心Nacos实例的固定费用。 注册配置中心Nacos容量单元(50微服务实例) 注册配置中心Nacos管理容量费用,按容量单元购买,1个容量单元等于50个微服务实例。 说明: 微服务实例指一个微服务的最小运行和部署单元,通常对应CCE中的一个pod或者ECS环境中的进程数。
  • 续费相关的功能 包年/包月注册配置中心续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费 包年/包月注册配置中心从购买到被自动删除之前,您可以随时在费用中心为其续费,以延长注册配置中心的使用时间。 自动续费 开通自动续费后,注册配置中心会在每次到期前自动续费,避免因忘记手动续费而导致资源被自动删除。 在一个包年/包月注册配置中心生命周期的不同阶段,您可以根据需要选择一种方式进行续费,具体如图1所示。 图1 注册配置中心生命周期 注册配置中心从购买到到期前,处于正常运行阶段,资源状态为“使用中”。 到期后,资源状态变为“已过期”。 到期未续费时,注册配置中心首先会进入宽限期,宽限期到期后仍未续费,资源状态变为“已冻结”。 超过宽限期仍未续费将进入保留期,如果保留期内仍未续费,资源将被自动删除。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 在注册配置中心到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至注册配置中心到期或者续费成功。到期前7日自动续费扣款是系统默认配置,您也可以根据需要修改此扣款日。
  • 计费示例 假设您在2023/03/08 15:50:04购买了一个包年/包月ServiceComb引擎专享版(实例规格:100个实例),计费项为实例规格。购买时长为一个月,并在到期前手动续费1个月,则: 第一个计费周期为:2023/03/08 15:50:04 ~ 2023/04/08 23:59:59 第二个计费周期为:2023/04/08 23:59:59 ~ 2023/05/08 23:59:59 您需要为每个计费周期预先付费,假设ServiceComb引擎实例数为100的规格的包月单价费用为3,000元,那么根据计费公式如表2所示,你需要支付两个计费周期的费用:6,000元。 表2 计费公式 资源类型 计费公式 资源单价 ServiceComb引擎专享版 实例规格包月单价 * 购买时长 请参见ServiceComb专享版引擎价格详情。 该示例中的价格仅供参考,实际计算请以价格计算器中的价格为准。
  • 适用计费项 根据需要托管的微服务实例数量总额选择ServiceComb引擎的规格,系统会根据选择的引擎规格计费,以下计费项支持包年/包月。 表1 适用计费项 计费项 说明 ServiceComb引擎实例规格 根据您选择的ServiceComb引擎实例规格计费。ServiceComb引擎实例规格当前支持微服务实例数为100、200、500、2000。各规格实例包月单价请参见ServiceComb引擎专享版价格详情。 购买ServiceComb引擎包年/包月时,支持购买1~9个月或者1年,购买时长为1年时,可享受实付10个月的优惠。 假设您计划购买微服务实例数为100的ServiceComb引擎专享版,选择的购买时长为1个月,则在购买ServiceComb引擎页面底部,您将看到所需费用,如图1所示。 图中价格仅供参考,实际计算请以ServiceComb引擎专享版价格详情中的价格为准。 图1 配置费用示例
  • 计费周期 包年/包月ServiceComb引擎专享版的计费周期是根据您购买的时长来确定的(以GMT+8:00时间为准)。一个计费周期的起点是您开通或续费资源的时间(精确到秒),终点则是到期日的23:59:59。 例如,如果您在2023/03/08 15:50:04购买了一个时长为一个月的ServiceComb引擎专享版,那么其计费周期为:2023/03/08 15:50:04 ~ 2023/04/08 23:59:59。
  • 到期后影响 图2描述了包年/包月ServiceComb引擎专享版各个阶段的状态。购买后,在计费周期内资源正常运行,此阶段为有效期;资源到期而未续费时,将陆续进入宽限期和保留期。 图2 包年/包月ServiceComb引擎专享版生命周期 到期预警 包年/包月ServiceComb引擎专享版在到期前第7天内,系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为云账号的创建者。 到期后影响 当您的包年/包月ServiceComb引擎专享版到期未续费,首先会进入宽限期。宽限期内您可正常使用已购买和开通的资源,在宽限期内产生的相关费用将在您续费时一并收取(抵扣续费周期时长)。 如果您在宽限期内仍未续费包年/包月ServiceComb引擎专享版,那么就会进入保留期,引擎状态变为“已冻结”,您将无法对处于保留期的包年/包月引擎执行任何操作。 保留期到期后,若包年/包月ServiceComb引擎专享版仍未续费,ServiceComb实例中的数据将被删除且无法恢复。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 关于续费的详细介绍请参见续费概述。
  • 变更规格后对计费的影响 当前包年/包月ServiceComb引擎专享版的规格不满足您的业务需要时,您可以在微服务引擎控制台发起变更规格操作,ServiceComb引擎专享版只支持升配,变更时系统将按照如下规则为您计算变更费用: 规格升配:新配置价格高于老配置价格,此时您需要支付新老配置的差价。 现在以升级ServiceComb引擎实例规格且无任何优惠的场景为例,此处计算价格仅作示例用,非官网实际价格,实际价格请参见价格计算器。假设您在2023/04/08购买了一个实例数为100规格,计费模式为包年/包月的ServiceComb引擎,购买时长为1个月,计划在2023/04/18变更规格为实例数为200。旧规格价格为3,000元/月,新规格价格为6,000元/月。计算公式如下: 升配费用=新规格价格*剩余周期-旧规格价格*剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。本示例中,剩余周期=12(4月份剩余天数)/ 30(4月份最大天数)+ 8(5月份剩余天数)/ 31(5月份最大天数)=0.6581,代入公式可得升配费用=6,000*0.6581-3,000*0.6581=1,974.30(元) 更多信息请参见变更资源规格费用说明。
  • 在费用中心续费 登录华为云控制台。 单击控制台页面上方“费用”,在下拉菜单中选择“续费管理”进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”和“到期不续费项”页签查询全部待续费资源,对资源进行手动续费的操作。 所有需手动续费的资源都可归置到“手动续费项”页签,具体操作请参见如何恢复为手动续费。 手动续费资源。 单个引擎:在资源页面找到需要续费的引擎,单击操作列的“续费”。 批量引擎:在资源页面勾选需要续费的引擎,单击列表左上角的“批量续费”。 选择注册配置中心的续费时长,判断是否勾选“统一到期日”,将注册配置中心到期时间统一到各个月的某一天(详细介绍请参见统一包年/包月资源的到期日)。确认配置费用后单击“去支付”。 进入支付页面,选择支付方式,确认付款,支付订单后即可完成续费。
  • 包年/包月资源 对于包年/包月计费模式的注册配置中心,用户在购买时会一次性付费,服务将在到期后自动停止使用。 如果在计费周期内不再使用包年/包月资源,您可以执行退订操作,系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。 如果您已开启“自动续费”功能,为避免继续产生费用,请在自动续费扣款日(默认为到期前7日)之前关闭自动续费。
  • 变更规格后对计费的影响 当前包年/包月注册配置中心的规格不满足您的业务需要时,您可以在微服务引擎控制台发起变更规格操作,注册配置中心只支持升配,变更时系统将按照如下规则为您计算变更费用: 规格升配:新配置价格高于老配置价格,此时您需要支付新老配置的差价。 现在以升级注册配置中心实例规格且无任何优惠的场景为例,此处计算价格仅作示例用,非官网实际价格,实际价格请参考价格详情。假设您在2023/04/08购买了一个实例数为500规格,计费模式为包年/包月的注册配置中心,购买时长为1个月,计划在2023/04/18变更规格为实例数为1000。旧规格价格为640.00元/月,新规格价格为1,280.00元/月。计算公式如下: 升配费用=新规格价格*剩余周期-旧规格价格*剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。本示例中,剩余周期=12(4月份剩余天数)/ 30(4月份最大天数)+ 8(5月份剩余天数)/ 31(5月份最大天数)=0.6581,代入公式可得升配费用=1,280.00*0.6581-640.00*0.6581=421.18(元)。 更多信息请参见变更资源规格费用说明。
  • 到期后影响 图1描述了包年/包月注册配置中心各个阶段的状态。购买后,在计费周期内资源正常运行,此阶段为有效期;资源到期而未续费时,将陆续进入宽限期和保留期。 图1 包年/包月注册配置中心生命周期 到期预警 包年/包月注册配置中心在到期前第7天内,系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为云账号的创建者。 到期后影响 当您的包年/包月注册配置中心到期未续费,首先会进入宽限期。宽限期内您可正常使用已购买和开通的资源,在宽限期内产生的相关费用将在您续费时一并收取(抵扣续费周期时长)。 如果您在宽限期内仍未续费,那么就会进入保留期,引擎状态变为“已冻结”,您将无法对处于保留期的包年/包月引擎执行任何操作。 保留期到期后,若包年/包月注册配置中心仍未续费,注册配置中心中的数据将被删除且无法恢复。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 关于续费的详细介绍请参见续费概述。
  • 适用计费项 根据需要托管的微服务实例数量总额选择注册配置中心Nacos引擎的规格,系统会根据选择的引擎规格计费,以下计费项支持包年/包月。 表1 适用计费项 计费项 说明 注册配置中心Nacos实例 注册配置中心Nacos实例的固定费用。 注册配置中心Nacos容量单元(50微服务实例) 注册配置中心Nacos管理容量费用,按容量单元购买,1个容量单元等于50个微服务实例。 说明: 微服务实例指一个微服务的最小运行和部署单元,通常对应CCE中的一个pod或者ECS环境中的进程数。
共100000条