文档首页> 区块链服务 BCS> API参考(华为云区块链引擎-公测)> API(华为云区块链引擎)> 实例管理> 购买实例
更新时间：2023-08-21 GMT+08:00
查看PDF
分享

购买实例

功能介绍

购买区块链实例

URI

POST /v2/{project_id}/huaweicloudchain/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

最小长度：1

最大长度：65535
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

实例名称，长度限制4-24，支持英文、数字、中划线，不能以中划线开头

edition

是

String

版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum）

枚举值：

  • Professional

  • Enterprise

  • Platinum

data_management

是

String

数据管理模式：云端管理（Cloud）、边缘管理（Edge）

枚举值：

  • Cloud

  • Edge

orgs

是

Array of CreateOrg objects

需要创建的组织信息

数组长度：1 - 100

chain_info

否

CreateChain object

链配置信息

org_order_info

否

CreateOrgOrderInfo object

实例组织订购相关信息

enterprise_project_id

否

String

企业项目id,不填默认为“0”，即default企业项目。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》

backup_id

否

String

备份id，恢复实例的时候必填
表4 CreateOrg

参数

是否必选

参数类型

描述

name

是

String

组织名称，长度限制4-16，支持小写字母、数字,且必须以小写字母开头
表5 CreateChain

参数

是否必选

参数类型

描述

consensus

否

String

区块链共识类型：raft

枚举值：

  • raft

sign_algorithm

否

String

区块链签名算法：ECDSA（ecdsa_with_sha256）、国密（sm2_with_sm3），专业版当前不支持国密

枚举值：

  • ecdsa_with_sha256

  • sm2_with_sm3
表6 CreateOrgOrderInfo

参数

是否必选

参数类型

描述

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

表7 响应Body参数

参数

参数类型

描述

order_id

String

订购生成的订单ID

order_num

Integer

订购资源数量

最小值：1

最大值：100

instance_id

String

实例ID

job_id

String

资源创建Job ID

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

请求示例

  • {
  "name" : "huawei-chain-01",
  "edition" : "Professional",
  "enterprise_project_id" : "bd33ecd4-89cd-442c-abd0-3ba88aedd40c",
  "data_management" : "Cloud",
  "orgs" : [ {
    "name" : "org1"
  }, {
    "name" : "org2"
  } ],
  "chain_info" : {
    "consensus" : "raft",
    "sign_algorithm" : "ecdsa_with_sha256"
  },
  "org_order_info" : {
    "charge_mode" : 0,
    "period_type" : 2,
    "period_num" : 1,
    "is_auto_pay" : true,
    "is_auto_renew" : true
  }
}
  • {
  "name" : "huawei-chain-02",
  "edition" : "Professional",
  "data_management" : "Cloud",
  "enterprise_project_id" : "0",
  "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"
  }
}

响应示例

状态码： 200

请求成功

{
  "order_id" : "CS2205101612RBMZD",
  "order_num" : 2,
  "instance_id" : "e224e6b6-e215-11ec-9675-0255ac101552",
  "job_id" : "e9541c1a-e17e-11ec-9826-0255ac10040d"
}

状态码

状态码

描述

200

请求成功

400

请求参数校验不通过

401

鉴权失败

500

服务内部执行错误
父主题： 实例管理
分享：

    相关文档

    相关产品