华为云用户手册

  • 响应示例 状态码: 200 OK { "count": 1, "compare_jobs": [ { "id": "cd05434c-ad91-479c-a8d3-d90d58eccc43", "type": "lines,account,object_comparison", "status": "SUC CES SFUL", "start_time": "1686038400512", "end_time": "1686038408711", "compute_type": "drs" } ] } 状态码: 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 compare_jobs Array of objects 健康对比任务列表。 详情请参见表5。 表5 compare_jobs参数说明 参数 参数类型 描述 id String 任务ID。 type String 对比类型。 start_time String 对比开始时间。 end_time String 对比结束时间。 status String 状态。 WAITING_FOR_RUNNING:等待启动中 RUNNING:运行中 SUCCESSFUL:完成 FAILED:失败 CANCELLED:已取消 TIMEOUT_INTERRUPT:超时中断 FULL_DOING:全量校验中 INCRE_DOING:增量校验中 compute_type String 对比计算资源。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 interval_hour Integer 间隔时间。 period String 对比时间。 begin_time String 对比开始时间。 end_time String 对比结束时间。 compare_type Array of strings 对比类型。 object:对象对比 lines:行对比 account:用户对比 status String 对比策略状态。 OPEN:开启 CLOSED:关闭,没有设置对比策略 NO_SUPPORT:当前无数据 枚举值: OPEN CLOSED NO_SUPPORT next_compare_time String 下次对比时间,UTC时间,例如:2023-06-12T08:00:00Z compare_policy String 对比策略。 normal:普通对比 manyToOne:多对一对比 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 200 OK { "period": "* * 1,2,3,4,5,6,7", "status": "OPEN", "begin_time": "08:00:00", "end_time": "10:00:00", "compare_type": [ "lines", "account", "object_comparison" ], "next_compare_time": "2023-06-12T08:00:00Z", "compare_policy": "normal" } 状态码: 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 dirty_data_list Array of objects 异常数据列表。 详情请参见表5。 表5 dirty_data_list参数说明 参数 参数类型 描述 db_name String 数据库名称。 schema_name String schema名称。 table_name String 表名称。 error_sql String 异常SQL。 error_time String 发生异常时间,UTC时间,例如:2023-06-10T03:01:52Z error_msg String 异常信息。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 200 OK { "count": 1, "dirty_data_list": [ { "db_name": "gltest01", "schema_name": "gltest", "table_name": "decimal_01", "error_sql": "INSERT INTO \"gltest\".\"decimal_01\" (\"c1\",\"c2\",\"c3\") VALUES (2,NULL,'2.000000000000000000000000000'::numeric)", "error_time": "2020-09-01T18:50:20.200Z", "error_msg": "ERROR: null value in column \"c2\" violates not-null constraint" } ] } 状态码: 400 Bad Request { "error_code": "DRS.M05003", "error_msg": "Task information not found." }
  • URI GET /v5/{project_id}/jobs/{job_id}/dirty-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 begin_time 否 Integer 开始时间,UTC时间,例如:2020-09-01T18:50:20Z end_time 否 Integer 结束时间,UTC时间,例如:2020-09-01T19:50:20Z limit 否 String 每页显示的条目数量。默认为10,取值范围【1-1000】 最小值:1 最大值:1000 缺省值:10 offset 否 String 偏移量,表示从此偏移量开始查询, offset 大于等于 0。默认为0 缺省值:0
  • 响应示例 状态码: 200 OK { "product_info_list": [ { "id": "78f3a9f1-3d8d-43f0-acc4-ee93f8a9d934", "cloud_service_type": "hws.service.type.drs", "resource_type": "hws.resource.type.drs.vm", "resource_spec_code": "drs.lg.dr", "resource_size": 1, "usage_factor": "Duration", "usage_value": 1, "usage_measure_id": 4 }, { "id": "f52a74ce-5b11-4c5b-b365-488d9fc38882", "cloud_service_type": "hws.service.type.drs", "resource_type": "hws.resource.type.drs.flow", "resource_spec_code": "drs.flow.free", "resource_size": 1, "usage_factor": "flow", "usage_value": 1, "usage_measure_id": 17 } ] } 状态码: 400 Bad Request { "error_code": "DRS.M00202", "error_msg": "The value of parameter jobId is invalid." }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 product_info_list Array of objects 资源信息列表。 详情请参见表4。 表4 product_info_list字段数据结构说明 参数 参数类型 描述 id String ID标识,同一次询价中不能重复,用于标识返回询价结果和请求的映射关系。 cloud_service_type String 用户购买云服务产品的云服务类型,例如EC2,云服务类型为hws.service.type.ec2。 resource_type String 用户购买云服务产品的资源类型,例如EC2中的VM,资源类型为hws.resource.type.vm。 resource_spec_code String 用户购买云服务产品的资源规格,例如VM的小型规格,资源规格为m1.tiny。 resource_size Integer 资源容量度量标识。 resource_size_measure_id Integer 资源容量大小,例如购买的卷大小或带宽大小。 usage_factor String 使用量因子,按需计费必填,取值和话单中的使用量因子一致,云服务和使用量因子对应关系如下: Duration:云服务器 flow:流量 usage_value Double 使用量值,按需询价必填,例如按小时询价,使用量值为1,使用量单位为小时。 usage_measure_id Integer 使用量单位标识,按需询价必填,例如按小时询价,使用量值为1,使用量单位为小时。 4:小时 10:GB 11:MB 13:Byte 17:FLOW_GB 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务状态。 is_clone_job String 是否为克隆任务。 create_time String 任务创建时间。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 202 Accepted { "id": "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name": "DRS-1234", "status": "CREATING", "is_clone_job": true, "create_time": "2022-11-07T16:15:18Z" } 状态码: 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 克隆任务名称。名称在4位到50位之间,必须以字母开头,可以包含字母、数字、中划线或下划线,不能包含其他特殊字符,任务名称不能重复。 job_id 是 String 被克隆任务ID。 task_version 否 String 任务版本号,新UX任务为2.0。默认为空,即克隆老任务。 枚举值: 2.0
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。使用multipart/form-data,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:multipart/form-data X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 待上传的模板文件。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 async_job_id String 批量导入创建的任务ID。 import_error_messages Array of objects 导入失败的错误信息。 详情请参见import_error_messages字段数据结构说明。 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512 表5 import_error_messages字段数据结构说明 参数 参数类型 描述 sheet_name String sheet名称。 row_rum String 错误行号。 value String 错误行的value列字段值。 error_message String 错误信息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 status String 查询状态 枚举值: pending failed success job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 响应示例 状态码: 200 OK { "id" : "05ef2a25-a472-4144-b444-2e0a11eb5902", "status" : "success" } 状态码: 400 Bad Request { "error_code" : "DRS.10030015", "error_msg" : "Failed to update database object" }
  • URI GET /v5/{project_id}/jobs/{job_id}/db-objects/saving-status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 指保存对象接口返回的ID。
  • URI GET /v5/{project_id}/jobs/{job_id}/db-objects/collection-status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 query_id 是 String 对象信息采集的ID,指的是提交查询对象接口返回的ID。
  • 响应示例 状态码: 200 OK { "object_scope" : "table", "target_root_db" : { "db_name" : "mytest", "db_encoding" : "utf8" }, "object_info" : { "TEST" : { "name" : "TEST", "tables" : { "TBL_2" : { "name" : "TBL_2", "type" : "table", "all" : true, "is_synchronized" : true } }, "is_synchronized" : true, "total_table_num" : 1 } }, "max_table_num" : 50000, "id" : "0eacda0b-9422-4535-8b62-537d1833638b", "status" : "success" } 状态码: 400 Bad Request { "error_code" : "DRS.10030014", "error_msg" : "Firstly, please the query object info." }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。
  • 响应示例 状态码: 202 OK { "id" : "036ceb63-51f8-43fb-9164-82c17b2eadbc", "status" : "pending", "job_id" : "2fccbe0d-4e6b-4957-981a-edca4e2jb201" } 状态码: 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 id String 查询结果ID。 status String 查询状态。 枚举值: pending failed success job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • URI POST /v5/{project_id}/jobs/{job_id}/db-objects/collect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 limit 否 Integer 每页显示的条目数量。 type 是 String 查询对象信息类型。取值: source:查询源库对象信息。 modified:查询已选择的(未下发与已同步的)对象信息。 synchronized:查询已同步的(已下发的)对象信息 , 使用场景在任务处于全量中或者增量中。 is_refresh 否 Boolean 是否强制刷新。取值: true 是,表示从源库重新查询。 false 否,表示从缓存中查询。 db_names 否 Array 查询指定库的信息。
共100000条