华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 合约总数量 最小值:0 最大值:100 contracts Array of ContractInfo objects 合约列表 数组长度:0 - 100 表5 ContractInfo 参数 参数类型 描述 name String 合约名称 version String 合约版本号 最小长度:2 最大长度:14 type String 合约类型:Go语言类型(go)、Solidity语言类型(solidity)、Java语言类型(java) 枚举值: go solidity java status String 合约状态:安装中(Installing)、安装失败(Failed)、安装完成(Success) 枚举值: Installing Failed Success failed_message String 合约安装失败详细错误信息 description String 合约描述 chain_id String 合约所属链ID install_orgs Array of strings 合约安装组织 数组长度:1 - 1000 endorse_orgs Array of strings 合约背书组织 数组长度:1 - 1000 endorse_policy String 合约背书策略:任意组织背书(OR)、全部组织背书(AND) 枚举值: OR AND file_hash_code String 合约文件SHA256哈希值 最小长度:64 最大长度:64 security_check Boolean 合约是否开启安全检查任务 security_check_status Integer 合约安全检查任务状态:不存在(0)、正在执行(1)、完成(2)、失败(3) 最小值:0 最大值:3 install_time String 合约安装时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/contract/report 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 name 是 String 合约名称 最小长度:6 最大长度:25 language 否 String 扫描报告语言类型:中文(zh-cn)、英文(en-us),默认英文 枚举值: zh-cn en-us
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "orgs" : [ { "uid" : "f1766f8b-c55a-11ec-a67c-0255ac10040d", "name" : "org1", "chain_org_id" : "org1-f8587hwjt", "status" : "Available", "is_consensus" : true, "capacity_info" : { "total" : 512000, "used" : 102400 }, "subscription_id" : "01154-360000102-0", "order_info" : { "edition" : "Professional", "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true }, "countdown" : { "countdown_code" : "hws_countdown_period_using", "countdown_infos" : { "status" : 2, "next_operation_policy" : 0, "next_operation_remaining_day" : 28 }, "countdown_tips" : { "eff_time" : "2022-04-26T12:37:16Z", "exp_time" : "2022-05-26T15:59:59Z" } }, "create_time" : "2022-04-16T07:20:05Z", "update_time" : "2022-04-16T07:20:05Z" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 组织总数量 最小值:0 最大值:100 orgs Array of OrgInfo objects 实例列表 数组长度:1 - 100 表5 OrgInfo 参数 参数类型 描述 uid String 组织资源ID name String 组织名称 chain_org_id String 组织在链上的ID status String 组织状态:正常(Available)、异常(Exception)、不可用(Unavailable)、待付款(Unpaid)、创建中(Creating)、删除中(Deleting) endpoint String besu链节点地址 is_consensus Boolean 是否为共识组织,共识组织为true,非共识组织为false capacity_info capacity_info object 组织磁盘容量相关信息 subscription_id String 资源对应的订购实例ID,可用于组织退订 order_info order_info object 组织订购相关信息 countdown countdown object 组织资源倒计时信息 create_time String 组织创建时间 update_time String 组织数据更新时间 表6 capacity_info 参数 参数类型 描述 total Integer 组织单节点磁盘总容量,单位为MB used Integer 组织单节点磁盘使用容量,单位为MB 表7 order_info 参数 参数类型 描述 edition String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) charge_mode Integer 资源计费模式:包周期计费(0) period_type Integer 订购周期类型:按月(2)、按年(3) period_num Integer 订购周期数量,按年只允许购买一年,按月可以购买1-9个月,超过9个月等同于一年 is_auto_pay Boolean 是否自动付款,true支持自动付款,false不支持自动付款 is_auto_renew Boolean 是否自动续费,true支持自动续费,false不支持自动续费 promotion_id String 资源购买参与促销时的促销活动ID,未参与则为空值;一次促销活动可包含多个促销计划 discount_plan_id String 资源购买参与促销时的折扣计划ID 表8 countdown 参数 参数类型 描述 countdown_code String 包周期资源各状态倒计时呈现Code:正常状态(hws_countdown_period_using)、到期进入宽限期(hws_countdown_period_gracing)、到期冻结(hws_countdown_period_frozen)、违规冻结(hws_countdown_period_illegalfrozen)、公安冻结(hws_countdown_period_policefrozen) 枚举值: hws_countdown_period_using hws_countdown_period_gracing hws_countdown_period_frozen hws_countdown_period_illegalfrozen hws_countdown_period_policefrozen countdown_infos countdown_infos object 倒计时信息,包含资源状态、到期处理策略、到期剩余时间 countdown_tips countdown_tips object 倒计时tips信息,包含资源生效、失效、冻结、释放时间以及宽限期到期时间 表9 countdown_infos 参数 参数类型 描述 status Integer 资源当前状态:未生效(1)、生效中(2)、已删除(3)、冻结中(4)、宽限期中(5)、违规冻结或公安冻结(99) 最小值:1 最大值:99 next_operation_policy Integer 下一步操作的处理策略/到期处理策略:到期进入宽限期(0)、无宽限期和保留期场景到期后自动删除(2)、宽限期到期冻结(4)、宽限期到期后删除(5) 最小值:0 最大值:5 next_operation_remaining_day Integer 当前状态到下一步操作执行还剩下的天数 最小值:0 最大值:365 next_operation_remaining_hour Integer 当前状态到下一步操作执行还剩下的小时数 最小值:0 最大值:24 next_operation_remaining_minute Integer 当前状态到下一步操作执行还剩下的分钟数 最小值:0 最大值:60 next_operation_remaining_second Integer 当前状态到下一步操作执行还剩下的秒数 最小值:0 最大值:60 表10 countdown_tips 参数 参数类型 描述 eff_time String 资源生效时间 exp_time String 资源失效时间 grace_time String 资源宽限期结束时间 frozen_time String 资源冻结时间 release_time String 资源释放时间 状态码: 400 表11 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表12 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表13 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:100
  • 请求示例 { "edition" : "Professional", "org_num" : 1, "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "promotion_id" : "P22020702520656805DMA6A0R1WKID", "discount_plan_id" : "PDP2204021323287781B6J25H1RUC643" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 edition 是 String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) 枚举值: Professional Enterprise Platinum org_num 是 Integer 订购组织数量 最小值:1 最大值:100 charge_mode 否 Integer 资源计费模式:包周期计费(0),默认0值 枚举值: 0 period_type 是 Integer 订购周期类型:按月(2)、按年(3) 枚举值: 2 3 period_num 是 Integer 订购周期数量,按年只可以询价一年,按月可以询价1-9个月,超过9个月相当于一年 promotion_id 否 String 促销活动ID,促销活动目标用户可使用;一次促销活动可包含多个促销计划,参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动 discount_plan_id 否 String 折扣计划ID,促销活动目标用户可使用;参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 amount Integer 产品实付金额 最小值:1 最大值:40000000 original_amount Integer 产品原始金额 最小值:1 最大值:48000000 currency String 币种:人民币(CNY) 枚举值: CNY 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 凭据总数 tokens Array of BesuTokensResponse objects 凭据信息 表4 BesuTokensResponse 参数 参数类型 描述 token_id String 凭据ID description String 描述信息 create_time String 创建时间 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 403 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "txs" : [ { "id" : "0720097286db7edf8627b1eb4b0c9acfd64ba1092bf1472035c7ed1efc0dc048", "type" : "COMMON_TRANSACTION", "status" : "VALID", "block_height" : 2, "create_org" : "org1-jeij39jfo", "contract_name" : "test", "endorsor_orgs" : [ "org1-jeij39jfo" ], "read_set" : [ ], "write_set" : [ "key:\"BS_ADDRESS\" value:\"x.x.x.x\" " ], "create_time" : "2022-04-26T12:37:16Z" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 交易总数量 最小值:1 最大值:500 txs Array of TxInfo objects 交易列表 数组长度:1 - 500 表5 TxInfo 参数 参数类型 描述 id String 交易ID type String 交易类型:普通交易(COMMON_TRANSACTION)、投票交易(VOTE_TRANSACTION) status String 交易状态 block_height Integer 交易所属区块高度 create_org String 交易发起组织 contract_name String 交易执行合约 endorsor_orgs Array of objects 背书组织 数组长度:1 - 100 read_set Array of KeyVersion objects 交易读集 数组长度:0 - 500 write_set Array of files 交易写集 数组长度:0 - 500 create_time String 交易创建时间 表6 KeyVersion 参数 参数类型 描述 key String 交易数据的key version version object 交易数据的版本数据 表7 version 参数 参数类型 描述 block_num Integer 区块号 tx_num Integer 交易序号 状态码: 400 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表9 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表10 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/transactions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 block_height 是 String 区块ID 最小长度:1 最大长度:16 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:500
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 instance_num Integer 实例个数 状态码: 500 表4 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 终端节点总数 最小值:0 最大值:100 endpoints Array of EndpointInfo objects 终端节点列表 数组长度:0 - 100 表5 EndpointInfo 参数 参数类型 描述 id String 终端节点ID name String 终端节点名称 ip String 终端节点IP 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/endpoints 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:100
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 order_id String 订购生成的订单ID order_num Integer 订购资源数量 最小值:1 最大值:100 instance_id String 实例ID job_id String 资源创建Job ID 状态码: 400 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表9 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 请求示例 { "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true } } { "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : false, "is_auto_renew" : true, "promotion_id" : "P22020702520656805DMA6A0R1WKID", "discount_plan_id" : "PDP2204021323287781B6J25H1RUC643" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 orgs 是 Array of CreateOrg objects 需要创建的组织信息,专业版最多订购2个组织,企业版最多订购10个组织,铂金版最多订购100个组织 数组长度:1 - 100 org_order_info 是 org_order_info object 订购相关信息 表4 CreateOrg 参数 是否必选 参数类型 描述 name 是 String 组织名称,长度限制4-16,支持小写字母、数字,且必须以小写字母开头 表5 org_order_info 参数 是否必选 参数类型 描述 charge_mode 否 Integer 资源计费模式:包周期计费(0),默认0值处理 枚举值: 0 period_type 否 Integer 订购周期类型:按月(2)、按年(3) 枚举值: 2 3 period_num 否 Integer 订购周期数量,按年只允许购买一年,按月可以购买1-9个月,超过9个月等同于一年 is_auto_pay 否 Boolean 是否自动付款,true支持自动付款,false不支持自动付款 is_auto_renew 否 Boolean 是否自动续费,true支持自动续费,false不支持自动续费 promotion_id 否 String 促销活动ID,促销活动目标用户可使用;一次促销活动可包含多个促销计划,参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动 discount_plan_id 否 String 折扣计划ID,促销活动目标用户可使用;参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动
  • 响应示例 状态码: 200 请求成功 { "chain_id" : "string", "consensus" : "string", "sign_algorithm" : "string", "contract_num" : 100, "block_num" : 0, "transaction_num" : 0, "orgs" : [ { "id" : "string", "name" : "string", "is_consensus" : true, "is_local" : true, "is_exist" : true, "member_id" : "string", "member_name" : "string" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 chain_id String 链ID consensus String 区块链 共识类型:IBFT2.0 sign_algorithm String 区块链签名算法:ECDSA contract_num Integer 合约数量 block_num Integer 区块数量 transaction_num Integer 交易数量 orgs Array of ChainBesuOrgInfo objects 链上所有节点信息 表4 ChainBesuOrgInfo 参数 参数类型 描述 id String 组织在链上的ID name String 组织名称 is_consensus Boolean 是否为共识组织,共识组织为true,非共识组织为false is_local Boolean 是否为本地组织 is_exist Boolean 组织是否存在当前链上 member_id String 组织所属成员ID member_name String 组织所属成员名称 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String 备份方式:手动备份(ManualBackup),自动备份(AutoBackup) rule 否 Integer 备份规则 只在备份方式为自动备份时生效 1: 每天备份一次 3: 每3天备份一次 7:每7天备份一次 最小值:1 最大值:7 is_enable 否 Boolean 自动备份规则是否开启 只在备份方式为自动备份时生效
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result String 操作结果,值固定为success 最小长度:7 最大长度:7 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 403 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 200 请求成功 { "count" : 0, "blocks" : [ { "block_height" : "string", "transaction_num" : 500, "body_hash" : "string", "parent_hash" : "string", "create_time" : "string" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 区块总数量 blocks Array of BesuBlockInfo objects 区块列表 表5 BesuBlockInfo 参数 参数类型 描述 block_height String 区块高度 transaction_num Integer 区块包含交易数量 body_hash String 区块hash parent_hash String 父区块hash create_time String 区块创建时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • URI GET /v2/{project_id}/besu/instances/{instance_id}/chain/blocks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:500
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_id String 操作对应Job ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 步骤二:数据迁移 配置 CDM 数据源连接。 创建源端DWS数据库的连接。 登录CDM控制台,选择“集群管理”,选择已创建的CDM集群,在操作列选择“作业管理”。 在作业管理界面,选择“连接管理”,单击“新建连接”,连接器类型选择“ 数据仓库 服务(DWS)”,单击“下一步”。 配置连接DWS的数据源连接参数,具体参数配置如下。 表1 DWS数据源配置 参数 值 名称 自定义DWS数据源名称。例如当前配置为:source_dws。 数据库服务器 单击输入框旁边的“选择”按钮,选择当前已创建的DWS集群名称。 端口 DWS数据库的端口,默认为:8000。 数据库名称 当前需要迁移的DWS数据库名称。当前示例为DWS集群上创建数据库和表中创建的数据库“testdwsdb”。 用户名 待连接数据库的用户。该数据库用户需要有数据表的读写权限,以及对元数据的读取权限。 本示例使用创建DWS数据库实例的默认管理员用户“dbadmin”。 密码 对应的DWS数据库用户的密码。 图2 CDM配置DWS数据源 其他更多参数保持默认即可,如果需要了解更多参数说明,可以参考配置关系数据库连接。单击“保存”完成DWS数据源连接配置。 创建目的端 DLI 数据源的连接。 登录CDM控制台,选择“集群管理”,选择已创建的CDM集群,在操作列选择“作业管理”。 在作业管理界面,选择“连接管理”,单击“新建连接”,连接器类型选择“ 数据湖探索 (DLI)”,单击“下一步”。 图3 创建DLI数据源连接 配置目的端DLI数据源连接。具体参数配置可以参考在CDM上配置DLI连接。 图4 创建DLI数据源连接 配置完成后,单击“保存”完成DLI数据源配置。 创建CDM迁移作业。 登录CDM控制台,选择“集群管理”,选择已创建的CDM集群,在操作列选择“作业管理”。 在“作业管理”界面,选择“表/文件迁移”,单击“新建作业”。 在新建作业界面,配置当前作业配置信息,具体参数参考如下: 图5 CDM数据迁移作业配置 作业名称:自定义数据迁移的作业名称。例如,当前定义为:test。 源端作业配置,具体参考如下: 表2 源端作业配置 参数名 参数值 源连接名称 选择1.a中已创建的数据源名称。 使用SQL语句 “使用SQL语句”选择“是”时,您可以在这里输入自定义的SQL语句,CDM将根据该语句导出数据。 本示例当前选择为“否”。 模式或表空间 “使用SQL语句”选择“否”时,显示该参数,表示待抽取数据的模式或表空间名称。单击输入框后面的按钮可进入模式选择界面,用户也可以直接输入模式或表空间名称。 本示例因为DWS集群上创建数据库和表中没有创建SCHEMA,则本参数为默认的“public”。 如果选择界面没有待选择的模式或表空间,请确认对应连接里的账号是否有元数据查询的权限。 说明: 该参数支持配置通配符(*),实现导出以某一前缀开头或者以某一后缀结尾的所有数据库。例如: SCHEMA*表示导出所有以“SCHEMA”开头的数据库。 *SCHEMA表示导出所有以“SCHEMA”结尾的数据库。 *SCHEMA*表示数据库名称中只要有“SCHEMA”字符串,就全部导出。 表名 待迁移的DWS数据表名。当前为DWS集群上创建数据库和表中的“table1”表。 更多详细参数配置请参考配置关系数据库源端参数。 目的端作业参数配置,具体参考如下: 表3 目的端作业配置 参数名 参数值 目的连接名称 选择已创建的DLI数据源连接。 资源队列 选择已创建的DLI SQL类型的队列。 数据库名称 选择DLI下已创建的数据库。当前示例为在DLI上创建数据库和表创建的数据库名,即为“testdb”。 表名 选择DLI下已创建的表名。当前示例为在DLI上创建数据库和表创建的表名,即为“tabletest”。 导入前清空数据 选择导入前是否清空目的表的数据。当前示例选择为“否”。 如果设置为是,任务启动前会清除目标表中数据。 详细的参数配置可以参考:CDM配置DLI目的端参数。 单击“下一步”,进入到字段映射界面,CDM会自动匹配源和目的字段。 如果字段映射顺序不匹配,可通过拖拽字段调整。 如果选择在目的端自动创建类型,这里还需要配置每个类型的字段类型、字段名称。 CDM支持迁移过程中转换字段内容,详细请参见字段转换。 图6 字段映射 单击“下一步”配置任务参数,一般情况下全部保持默认即可。 该步骤用户可以配置如下可选功能: 作业失败重试:如果作业执行失败,可选择是否自动重试,这里保持默认值“不重试”。 作业分组:选择作业所属的分组,默认分组为“DEFAULT”。在CDM“作业管理”界面,支持作业分组显示、按组批量启动作业、按分组导出作业等操作。 是否定时执行:如果需要配置作业定时自动执行,请参见配置定时任务。这里保持默认值“否”。 抽取并发数:设置同时执行的抽取任务数。这里保持默认值“1”。 是否写入脏数据:如果需要将作业执行过程中处理失败的数据、或者被清洗过滤掉的数据写入OBS中,以便后面查看,可通过该参数配置,写入脏数据前需要先配置好OBS连接。这里保持默认值“否”即可,不记录脏数据。 单击“保存并运行”,回到作业管理界面,在作业管理界面可查看作业执行进度和结果。 图7 迁移作业进度和结果查询
  • 前提条件 已创建DLI的SQL队列。创建DLI队列的操作可以参考创建DLI队列。 创建DLI队列时队列类型需要选择为“SQL队列”。 已创建数据仓库服务DWS集群。具体创建DWS集群的操作可以参考创建DWS集群。 已创建CDM迁移集群。创建CDM集群的操作可以参考创建CDM集群。 如果目标数据源为云下的数据库,则需要通过公网或者专线打通网络。通过公网互通时,需确保CDM集群已绑定EIP、CDM云上安全组出方向放通云下数据源所在的主机、数据源所在的主机可以访问公网且防火墙规则已开放连接端口。 数据源为云上的DWS、 MRS 等服务时,网络互通需满足如下条件: i. CDM集群与云上服务处于不同区域的情况下,需要通过公网或者专线打通网络。通过公网互通时,需确保CDM集群已绑定EIP,数据源所在的主机可以访问公网且防火墙规则已开放连接端口。 ii. CDM集群与云上服务同区域情况下,同虚拟私有云、同子网、同安全组的不同实例默认网络互通;如果同虚拟私有云但是子网或安全组不同,还需配置路由规则及安全组规则。 配置路由规则请参见如何配置路由规则章节,配置安全组规则请参见如何配置安全组规则章节。 iii. 此外,您还必须确保该云服务的实例与CDM集群所属的企业项目必须相同,如果不同,需要修改工作空间的企业项目。 本示例CDM集群的虚拟私有云、子网以及安全组和DWS集群保持一致。
  • 步骤一:数据准备 DWS集群上创建数据库和表。 参考使用gsql命令行客户端连接DWS集群连接已创建的DWS集群。 执行以下命令连接DWS集群的默认数据库“gaussdb”: gsql -d gaussdb -h DWS集群连接地址 -U dbadmin -p 8000 -W password -r gaussdb:DWS集群默认数据库。 DWS集群连接地址:请参见获取集群连接地址进行获取。如果通过公网地址连接,请指定为集群“公网访问地址”或“公网访问 域名 ”,如果通过内网地址连接,请指定为集群“内网访问地址”或“内网访问域名”。如果通过弹性负载均衡连接,请指定为“弹性负载均衡地址”。 dbadmin:创建集群时设置的默认管理员用户名。 -W:默认管理员用户的密码。 在命令行窗口输入以下命令创建数据库“testdwsdb”。 CREATE DATABASE testdwsdb; 执行以下命令,退出gaussdb数据库,连接新创建的数据库“testdwsdb”。 \q gsql -d testdwsdb -h DWS集群连接地址 -U dbadmin -p 8000 -W password -r 执行以下命令创建表并插入数据。 创建表: CREATE TABLE table1(id int, a char(6), b varchar(6),c varchar(6)) ; 插入表数据: INSERT INTO table1 VALUES(1,'123','456','789'); INSERT INTO table1 VALUES(2,'abc','efg','hif'); 查询表数据确认数据插入成功。 select * from table1; 图1 查询表数据 在DLI上创建数据库和表。 登录DLI管理控制台,选择“SQL编辑器”,在SQL编辑器中“执行引擎”选择“spark”,“队列”选择已创建的SQL队列。 在编辑器中输入以下语句创建数据库,例如当前创建迁移后的DLI数据库testdb。详细的DLI创建数据库的语法可以参考创建DLI数据库。 create database testdb; 在“SQL编辑器”中,数据库选择“testdb”,执行以下建表语句创建数据库下的表。详细的DLI建表语法可以参考创建DLI表。 create table tabletest(id INT, name1 string, name2 string, name3 string);
共100000条