附录

规范化字符串

通常一个字符串中可以包含任何Unicode字符,在编程中这种灵活性会带来不少困扰,因此引入“规范字符串”的概念。

将任意一个字符串转换为规范字符串的方式是:

  1. 将字符串转换成UTF-8编码的字节流。

  2. 将转换后的字符串按照URL编码规则进行编码。

URL编码规则

URL编码规则遵循RFC 3986标准,大体规则如下:

i. 对于字母(A-Z,a-z)、数字(0-9)、连字号(-)、点号(.)、下划线(_)、波浪线(~)。不编码;

ii. 对于其他字符编码成 “%XY” 的格式,其中 XY 是字符对应 ASCII 码的 16 进制表示。比如英文的双引号(”)对应的编码就是 %22

iii.对于扩展的 UTF-8 字符,编码成 “%XY%ZA…” 的格式;

iv. 需要注意的是英文空格( )要被编码是 %20

主机套餐规格

型号 套餐名称 增值配置
DC01 标准型 -
DC02 增强型 -
DC03 优选型 -
DC04 高配型 -
DC05 豪华型 -
DC06 旗舰型 -
BC01 入门型 -
BC02 经济型 -
BC03 优选型 -
BC04 高配型 -
BC05 豪华型 -
MC00-0-0-0 CMS开发型 5G防护包
MC01-1-0-0 微官网型 5G防护包
MC02-2-0-0 官网增强型 5G防护包
MC03-3-0-0 O2O预约型 5G防护包
MC04-4-0-0 电商商城型 5G防护包
MC00-0-1-0 CMS开发型 20G防护包
MC01-1-1-0 微官网型 20G防护包
MC02-2-1-0 官网增强型 20G防护包
MC03-3-1-0 O2O预约型 20G防护包
MC04-4-1-0 电商商城型 20G防护包
MC01-1-0-1 微官网型 5G防护包,人工配置服务包
MC02-2-0-1 官网增强型 5G防护包,人工配置服务包
MC03-3-0-1 O2O预约型 5G防护包,人工配置服务包
MC04-4-0-1 电商商城型 5G防护包,人工配置服务包
MC01-1-0-2 微官网型 5G防护包,VIP定制服务包
MC02-2-0-2 官网增强型 5G防护包,VIP定制服务包
MC03-3-0-2 O2O预约型 5G防护包,VIP定制服务包
MC04-4-0-2 电商商城型 5G防护包,VIP定制服务包
MC01-1-1-1 微官网型 20G防护包,人工配置服务包
MC02-2-1-1 官网增强型 20G防护包,人工配置服务包
MC03-3-1-1 O2O预约型 20G防护包,人工配置服务包
MC04-4-1-1 电商商城型 20G防护包,人工配置服务包
MC01-1-1-2 微官网型 20G防护包,VIP定制服务包
MC02-2-1-2 官网增强型 20G防护包,VIP定制服务包
MC03-3-1-2 O2O预约型 20G防护包,VIP定制服务包
MC04-4-1-2 电商商城型 20G防护包,VIP定制服务包

有关BCH套餐的具体规格,请参看产品定价

数据类型

Contact

描述

联系人类型

包含参数

参数名称 类型 是否必须 描述
name String 联系人姓名
mobilePhone String 联系人手机号码
email String 联系人邮箱

BindFailResult

描述

域名绑定失败的结果

包含参数

参数名称 类型 是否必须 描述
domain String 失败的域名
reason String 失败的原因

BCHIP购买

描述

本接口用于创建一个BCHIP实例

请求

请求结构

POST /v{version}/host/bchip HTTP/1.1
Host: bch.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
bandwidth Integer RequestBody参数 购买的Bchip的带宽大小
purchaseLength Integer RequestBody参数 Bchip购买时长
region String RequestBody参数 Bchip所在的region。注意,bchip只能绑定在同一个region的bch实例,如gz的bch实例只能绑定gz区域的bchip
couponName String RequestBody参数 使用的代金券名字

请求备注

  • 该创建接口为同步返回接口,请求超时时间建议设置为1分钟或以上
  • couponName需要传入请求用户可用于BCH消费的代金券ID。传入无效ID,可能出现以下两种情况:

    (1)如果代金券是他人的或者已过期的,则直接扣除现金余额创建。

    (2)如果是不存在的ID,则返回错误

返回

返回头域

除公共头域,无其它特殊头域

返回参数

参数名称 类型 描述
userId String 公有云账号id
eip String bchip地址
eipId String 唯一标识一个bchip
status String bchip状态
bandwidthInMbps Integer 购买的bchip带宽大小
region String 购买的区域
expireTime DateTime 到期日期

返回错误

Code Message HTTP Status Code 说明
BceValidationException [param]:[param]=[Validation criteria] 400 无效的[param]参数
ServerNameInvalidException The specified parameter [server] is not valid 400 无效的server参数
MoneyNotEnough Money not enough to complete the current request 400 余额不足以完成当前的请求操作
SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details 400 Authorization头域中附带的签名和服务端验证不一致
PurchaseLengthInvalid The specified parameter "purchaseLength" is not valid 400 无效的购买时长
ExecOrderFailed Failed to execute the order 400 执行订单失败
InvalidAccessKeyId MThe Access Key ID you provided does not exist in our records 403 Access Key ID不存在
ServiceInternalError Service internal error occurred 500 内部服务发生错误

示例

请求示例

POST /v1/host/bchip HTTP/1.1
Host: bch.bj.baidubce.com
x-bce-date: 2015-08-11T04:17:29Z
Content-Type: application/json; charset=utf-8     
Authorization:bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "bandwidth": 1,
    "purchaseLength": 1,
    "region": "bj",
    "couponName": "DS4I63WK7A3SL9H"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "userId": "b1f91fbe6fe54d2eaf70ef0025f1c3c2",
    "eip": "10.107.246.31",
    "eipId": "6639614935774b2f39426e365a3353456132336468673d3d",
    "bandwidthInMbps": 1,
    "status": "IDLE",
    "region": "bj",
    "expiredTime": "2018-02-09T03:53:25Z"
}

Bchip续费

描述

续费Bchip,延长其到期时间

请求

请求结构

PUT /v{version}/host/bchip/{ip}?renewip HTTP/1.1
Host: bch.bj.baidubce.com
Authorization: authorization string
...

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
ip String URL参数 待续费的ip地址
renewip String Query参数 无值参数,标记请求操作类型
renewLength Integer RequestBody参数 续费时长, 单位为月
couponName String RequestBody参数 代金券ID
region String RequestBody参数 带续费的bchip的区域(北京、广州或香港)

返回

返回头域

除公共头域,无其它特殊头域

返回参数

参数名称 类型 描述
orderId String 续费订单id

返回错误

Code Message HTTP Status Code 说明
BceValidationException [param]:[param]=[Validation criteria] 400 无效的[param]参数
MoneyNotEnough Money not enough to complete the current request 400 余额不足以完成当前的请求操作
RenewLengthInvalid The specified parameter [RenewLength] is not valid 400 无效的续费时长
SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details 400 Authorization头域中附带的签名和服务端验证不一致
InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
ExecOrderFailed Failed to execute the order 500 执行订单失败
ServiceInternalError Service internal error occurred 500 内部服务发生错误

示例

请求示例

PUT /v1/host/bchip/10.107.246.31?renewip HTTP/1.1
Host: bch.bj.baidubce.com
x-bce-date: 2015-08-11T04:17:29Z
Content-Type: application/json; charset=utf-8     
Authorization:bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "renewLength": 1
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "orderId": "4ad35247da9b4a8dae53245dcfee1638"
}

BCHIP升级

描述

升级一个Bchip到一个更高的带宽

请求

请求结构

PUT /v{version}/host/bchip/{ip}?resizeip HTTP/1.1
Host: bch.bj.baidubce.com
Authorization: authorization string
...

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
ip String URL参数 要升级的bchip
resizeip String Query参数 无值参数,标记请求操作类型
bandwidth String RequestBody参数 要升级的带宽大小
couponName String RequestBody参数 代金券ID
region String RequestBody参数 带续费的bchip的区域(北京、广州或香港)

请求备注

  • ip在PUT请求时,需要加入到path中
  • 升级操作以Query参数加入

返回

返回头域

除公共头域,无其它特殊头域

返回参数

参数名称 类型 描述
orderId String 升级订单id

返回错误

Code Message HTTP Status Code 说明
BceValidationException [param]:[param]=[Validation criteria] 400 无效的[param]参数
MoneyNotEnough Money not enough to complete the current request 400 余额不足以完成当前的请求操作
SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. Check your Secret Access Key and signing method. Consult the service documentation for details 400 Authorization头域中附带的签名和服务端验证不一致
AccountInvalid The specified parameter [account] is not valid 400 管理账号不合法
ResourceIsLocked The resource is locked for adjusting or other unconfirmed upgrade order 404 升级的资源被锁定中,无法升级
ResourceNotExist The required resource does not exist 404 查询不到升级的资源
ServiceInternalError Service internal error occurred 500 内部服务发生错误

示例

请求示例

PUT /v1/host/bchip/10.107.246.31?resizeip HTTP/1.1
Host: bch.bj.baidubce.com
x-bce-date: 2015-08-11T04:17:29Z
Content-Type: application/json; charset=utf-8    
Authorization:bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "bandwidth": 2
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "orderId": "db41576e3cd2453794dd95509ddee095"
}

BCHIP绑定bch

描述

绑定一个bchip到指定的bch主机

请求

请求结构

PUT /v{version}/host/bchip/{account}?bindeip HTTP/1.1
Host: bch.bj.baidubce.com
Authorization: authorization string
...

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
account String URL参数 需要绑定bch主机账号
bindeip String Query参数 无值参数,标记请求操作类型
eip String RequestBody参数 要绑定的bchip
region String RequestBody参数 要绑定的bchip所在的区域

请求备注

  • account在PUT请求时,需要加入到path中
  • 绑定操作以Query参数加入

返回

返回头域

除公共头域,无其它特殊头域

返回参数

参数名称 类型 描述
bchip String 绑定的bchip

返回错误

Code Message HTTP Status Code 说明
ResourceNotExistException 请求的资源不存在,请稍后重试 400
ServiceInternalError Service internal error occurred 500 内部服务发生错误

示例

请求示例

PUT /v1/host/bchip/openapi7rrf3?bindeip HTTP/1.1
Host: bch.bj.baidubce.com
x-bce-date: 2015-08-11T04:17:29Z
Content-Type: application/json; charset=utf-8    
Authorization:bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "eip" : "10.107.246.31"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

10.107.246.31

BCHIP解绑bch

描述

解除指定bch和bchip的绑定关系

请求

请求结构

PUT /v{version}/host/bchip/{account}?unbindeip HTTP/1.1
Host: bch.bj.baidubce.com
Authorization: authorization string
...

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
account String URL参数 需要解绑bch主机账号
unbindeip String Query参数 无值参数,标记请求操作类型
eip String RequestBody参数 要绑定的bchip
region String RequestBody参数 要绑定的bchip所在的区域
force Boolean RequestBody参数 是否要强制解绑bchip(当bchip正在使用时, 默认false)

请求备注

  • account在PUT请求时,需要加入到path中
  • 解绑操作以Query参数加入

返回

返回头域

除公共头域,无其它特殊头域

返回参数

参数名称 类型 描述
bchip String 绑定的bchip

返回错误

Code Message HTTP Status Code 说明
ResourceNotExistException 请求的资源不存在,请稍后重试 400
ServiceInternalError Service internal error occurred 500 内部服务发生错误

示例

请求示例

PUT /v1/host/bchip/openapi7rrf3?unbindeip HTTP/1.1
Host: bch.bj.baidubce.com
x-bce-date: 2015-08-11T04:17:29Z
Content-Type: application/json; charset=utf-8    
Authorization:bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host;x-bce-date/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "eip" : "10.107.246.31"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

10.107.246.31