所有文档

          云虚拟主机 BCH

          接口说明

          说明

          BCH API仅对申请的用户开放,使用前请先提交工单申请。

          主机购买

          描述

          本接口用于创建一个云虚拟主机实例(BCH)。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串。用户可自定义的随机字符串,用来实现超时或者出错重试
          account String RequestBody参数 免费域名前缀/管理账号,在同域下唯一标识一台主机,仅支持字母、数字、连字符“-”,且必须以字母开头,不以连字符结尾。不区分大小写,长度为4-20个字符。
          packageId String RequestBody参数 购买的主机的规格类型,如VHost-FC01, VHost-FC02等套餐规格
          purchaseLength int RequestBody参数 主机购买时长,单位为月
          hostName String RequestBody参数 网站名称
          domains List< String> RequestBody参数 绑定的域名列表
          recordName String RequestBody参数 备案主体名称
          hostContact Contact RequestBody参数 主机联系人,同时也将默认设置为网站负责人
          ftpPassword String RequestBody参数 ftp初始密码,密码限制为6-16位字符,由英文,数字或符号组成,符号仅限!@#$%^*() 如果不传或传空,则会随机生成8位长度的初始化密码
          accountPassword String RequestBody参数 管理账号初始密码,密码限制为6-16位字符,由英文,数字或符号组成,符号仅限!@#$%^*() 如果不传或传空,则会随机生成8位长度的初始化密码
          couponName String RequestBody参数 代金券ID
          server String RequestBody参数 创建的服务器类型,默认为nginx,暂时只支持nginx
          mktTemplateId String RequestBody参数 云市场的模板ID,默认为空
          phpVersion String RequestBody参数 php版本,当前支持:5.2, 5.3, 5.4

          请求备注

          • 一台主机实例最多能绑定50个域名。
          • 主机购买时长支持范围是:1-9,12,24,36,60。
          • 创建请求中,如果提供域名列表,则会逐个检查域名是否合法,如有不合法域名,则会返回错误。
          • 为防止重复进行相同请求,客户端需要在请求query string中附加一个clientToken字段,clientToken是一个长度不超过64位的ASCII字符串,由客户端随机生成。
          • 该创建接口为同步返回接口,请求超时时间建议设置为1分钟或以上。
          • 如果管理账号密码与FTP密码都不传或都传空,将生成一致的密码。
          • 如果管理账号密码与FTP密码其中一个不传或传空,不传或传空的密码将完全随机生成。非空的按照给定的密码设定。
          • 调用API创建的主机将默认已经初始化。
          • couponName需要传入请求用户可用于BCH消费的代金券ID。传入无效ID,可能出现以下两种情况:

            1. 如果代金券是他人的或者已过期的,则直接扣除现金余额创建;
            2. 如果是不存在的ID,则返回错误。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          account String 主机管理账号
          accountPwd String 主机管理账号密码
          domain String 主机临时域名,格式为[account].bj.bdysite.com
          createTime String 主机创建时间
          expireTime String 主机到期时间
          ftpAddr String FTP地址,格式[account].ftp.bcehost.com
          ftpPort int FTP端口号
          ftpUserName String FTP登录账号
          ftpPwd String FTP登录密码
          dbType String 数据库类型
          dbAddr String 数据库连接地址
          dbPort int 数据库端口号
          dbUserName String 数据库账号
          dbPwd String 数据库密码

          返回错误

          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头域中附带的签名和服务端验证不一致
          PackageIdInvalid The specified parameter [packageId] is not supported 400 指定的套餐不存在或不再支持
          PasswordInvalid The specified password is not valid 400 给定的密码不符合规范
          DomainInvalid The specified parameter [domains] is not valid 400 域名列表中存在非法域名
          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?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 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
          
          {
              "packageId": "VHost-FC01",
              "purchaseLength": 1
              "account": "example",
              "hostName": "测试网站",
              "domains": [
                 "www.test001.com",
                 "www.test002.com",
              ],
              "server": "nginx"
              "recordName": "测试备案主体名称",
              "ftpPassword": "test1234",
              "accountPassword":"test5678",
              "Contact":{
                  "name":"管理员",
                  "mobilePhone":"13111111111",
                  "email":"example@baidu.com"
              }
          }

          返回示例

          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
          
          {
              "account":"example",
              "accountPwd":"test5678",
              "domain": "example.bj.bdysite.com",
              "createTime": "2015-08-11T04:17:29Z",
              "expireTime": "2015-09-11T04:17:29Z",
              "ftpAddr": "example.ftp.bcehost.com",
              "ftpPort": 8010,
              "ftpUserName": "example",
              "ftpPwd": "test1234",
              "dbType": "mysql",
              "dbAddr": "sqld.bcehost.com",
              "dbPort": 14051,
              "dbName": "GTCYLmCccYbgkzMzgORl",
              "dbUsername": "ba5aa51c2f5f4c0eb3096aaf9535461b",
              "dbPwd": "6544cc03cf74487992310c2557821ab1"   
          }

          主机信息查询

          描述

          查询主机的详细信息。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机

          请求备注

          account在GET请求时,需要加入到path中。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          account String 管理账号,在同域下唯一标识一台主机
          status String 主机运行的状态
          domain String 主机临时域名,格式为[account].bj.bdysite.com
          accountPwd String 主机管理账号密码(信息不可见)
          createTime String 主机创建时间
          expireTime String 主机到期时间
          ftpAddr String FTP地址,格式[account].ftp.bcehost.com
          ftpPort int FTP端口号
          ftpUserName String FTP登录账号
          ftpPwd String FTP登录密码(信息不可见)
          dbType String 数据库类型
          dbAddr String 数据库连接地址
          dbPort int 数据库端口号
          dbUserName String 数据库账号
          dbPwd String 数据库密码
          phpMyAdminUrl String phpMyAdmin地址

          返回错误

          Code Message HTTP Status Code 说明
          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 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          StatusNotRunningException Operation cannot be completed when host's status is not running 404 主机处于非运行状态, 操作无法执行
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          GET /v1/host/example 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

          返回示例

          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
          
          {
              "status": "RUNNING",
              "domain": "example.bj.bdysite.com",
              "account": "example",
              "accountPwd": "********",
              "createTime": "2015-08-11T04:17:29Z",
              "expireTime": "2015-09-11T04:17:29Z",
              "ftpAddr": "example.ftp.bcehost.com",
              "ftpPort": 8010,
              "ftpUserName": "example",
              "ftpPwd": "********",
              "dbType": "mysql",
              "dbAddr": "sqld.bcehost.com",
              "dbPort": 14051,
              "dbName": "GTCYLmCccYbgkzMzgORl",
              "dbUsername": "ba5aa51c2f5f4c0eb3096aaf9535461b",
              "dbPwd": "6544cc03cf74487992310c2557821ab1",
              "phpMyAdminUrl": "http://sma.bcehost.com:8080/pmap/jump?db=GTCYLmCccYbgkzMzgORl&expires=1440141794&sign=20bda3b4147cc01f28b54a01008509d5&client_id= ba5aa51c2f5f4c0eb3096aaf9535461b"
          }

          主机续费

          描述

          续费一台主机,延长其到期时间。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          renewhost String Query参数 无值参数,标记请求操作类型
          renewLength int RequestBody参数 续费时长, 单位为月
          couponName String RequestBody参数 代金券ID

          请求备注

          • account在PUT请求时,需要加入到path中。
          • 续费操作以Query参数加入。
          • renewLength支持的续费范围是:1-9,12,24,36,60。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          expireTime String 续费后的主机到期时间
          orderCharge String 续费订单费用

          返回错误

          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头域中附带的签名和服务端验证不一致
          AccountInvalid The specified parameter "account" is not valid 400 管理账号不合法
          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/example?renewhost 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": 12
          }

          返回示例

          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
          
          {
              "expireTime": "2016-09-11T04:17:29Z",
              "orderCharge": 58.8
          }

          重置FTP密码

          描述

          重置FTP的登录密码。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          resetftppwd String Query参数 无值参数,标记请求操作类型
          password String RequestBody参数 重置的密码,密码限制为6-16位字符,由英文,数字或符号组成,符号仅限!@#$%^*()

          请求备注

          • account在PUT请求时,需要加入到path中。
          • 重置密码操作以Query参数加入。
          • password为空字符串时,将随机生成以小写字母和数字组成的8位密码。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          password String 新的密码

          返回错误

          Code Message HTTP Status Code 说明
          PwdInvalid The specified password 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头域中附带的签名和服务端验证不一致
          AccountInvalid The specified parameter "account" is not valid 400 管理账号不合法
          AccountNotExist The specified parameter "account" not exists 400 管理账号不存在
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          PUT /v1/host/example?resetftppwd 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
          
          //设置给定密码
          {
              "password": "test123"
          }
          //设置随机密码
          {
              "password": ""
          }

          返回示例

          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
          
          //设置给定密码的返回
          {
              "password": "test123"
          }
          //设置随机密码的返回
          {
              "password": "mg8u7v6c"
          }

          重置管理账号密码

          描述

          重置管理账号的登录密码。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          resetaccountpwd String Query参数 无值参数,标记请求操作类型
          password String RequestBody参数 重置的密码,密码限制为6-16位字符,由英文,数字或符号组成,符号仅限!@#$%^*()

          请求备注

          • account在PUT请求时,需要加入到path中。
          • 重置密码操作以Query参数加入。
          • password为空字符串时,将随机生成以小写字母和数字组成的8位密码。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          password String 新的密码

          返回错误

          Code Message HTTP Status Code 说明
          PwdInvalid The specified password 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头域中附带的签名和服务端验证不一致
          AccountInvalid The specified parameter [account] is not valid 400 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          PUT /v1/host/example?resetaccountpwd 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
          
          //设置给定密码
          {
              "password": "test123"
          }
          //设置随机密码
          {
              "password": ""
          }

          返回示例

          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
          
          //设置给定密码的返回
          {
              "password": "test123"
          }
          //设置随机密码的返回
          {
              "password": "mg8u7v6c"
          }

          添加绑定域名

          描述

          为主机添加绑定域名。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          binddomains String Query参数 无值参数,标记请求操作类型
          domains List< String> RequestBody参数 需要绑定的域名列表

          请求备注

          • account在PUT请求时,需要加入到path中。
          • 绑定域名操作以Query参数加入。
          • 对于同一主机,单次最大绑定域名数目为15,如需绑定15个域名以上,可以发送多次请求。
          • 会逐个对输入的域名进行检查,当存在非法域名时,直接返回错误。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          failList List< BindFailResult> 绑定失败的Domain列表,如全部成功,则列表为空

          返回错误

          Code Message HTTP Status Code 说明
          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 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          DomainInvalid There is an illegal domain name 400 存在非法域名
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          PUT /v1/host/example?binddomains 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
          
          {
              "domains": [
                  "www.test1.com",
                  "www.test2.com"
              ]
          }

          返回示例

          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
          
          //存在失败域名的情况
          {
              "failList": [
                  {
                      "domain":"www.test1.com",
                      "reason": "已绑定存在相同域名"
                  }
                  {
                      "domain":"www.test2.com",
                      "reason": "域名已被他人绑定"
                  }
              ]
          }
          
          //全部成功的情况
          {
              "failList": [
              ]
          }

          解绑单个域名

          描述

          解绑单个域名,如有多个域名需要解绑,要多次调用该接口。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          unbinddomain String Query参数 无值参数,标记请求操作类型
          domain String RequestBody参数 需要解绑域名

          请求备注

          • account在PUT请求时,需要加入到path中。
          • 解绑域名操作以Query参数加入。
          • 会对解绑域名进行检查,当存在非法域名时,直接返回错误。
          • 如果解绑成功或者主机并没有绑定该域名,都会返回成功。

          返回

          返回头域

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

          返回参数

          http状态为200的空返回。

          返回错误

          Code Message HTTP Status Code 说明
          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 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          DomainInvalid There is an illegal domain name. 400 存在非法域名
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          PUT /v1/host/example?unbinddomain 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
          
          {
              "domain": "www.test1.com"
          }

          返回示例

          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
          
          // 空返回
          {
          
          }

          主机升级

          描述

          升级一台主机至更高级的套餐。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          upgradehost String Query参数 无值参数,标记请求操作类型
          packageId String RequestBody参数 升级的目标套餐,详见套餐规格
          couponName String RequestBody参数 代金券ID

          请求备注

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

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          orderCharge String 升级订单全额费用
          discount int 订单折扣, 100表示全额支付,90表示9折支付,以此类推
          couponAmount String 代金券支付的金额
          cashAmount String 现金支持的金额

          返回错误

          Code Message HTTP Status Code 说明
          BceValidationException [param]:[param]=[Validation criteria] 400 无效的[param]参数
          MoneyNotEnough Money not enough to complete the current request 400 余额不足以完成当前的请求操作
          PackageIdInvalid The specified parameter [packageId] is not supported 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 管理账号不合法
          NotUpgradablePackage Cannot upgrade to the package [packageId] 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/example?upgradehost 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
          
          {
              "packageId": "VHost-DC02"
          }

          返回示例

          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
          
          {
              "orderCharge": "4.62",
              "discount": 100,
              "cashAmount":"4.62",
              "couponAmount":"0.00"
          }

          主机管理账号验证

          描述

          验证一个主机管理账号是否可用。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String RequestBody参数 需要验证的管理账号

          请求备注

          account以POST参数提交。

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          valid Boolean 管理账号是否可用

          返回错误

          Code Message HTTP Status Code 说明
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          POST /v1/host/validate_account 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
          
          {
              "account": "testaccount"
          }

          返回示例

          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
          
          {
              "valid":true
          }

          主机绑定域名查询

          描述

          查询主机绑定的域名

          请求

          请求结构

          GET /v{version}/host/{account}/domains HTTP/1.1
          Host: bch.bj.baidubce.com
          Authorization: authorization string
          ...

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机

          请求备注

          • account在GET请求时,需要加入到path中

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          domains List<String> 已绑定域名的列表

          返回错误

          Code Message HTTP Status Code 说明
          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 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          StatusNotRunningException Operation cannot be completed when host's status is not running 404 主机处于非运行状态, 操作无法执行
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          GET /v1/host/example/domains 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

          返回示例

          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
          
          {
              domains:  ["abc.com",
              "bcd.com"
              ]
          }

          切换PHP版本

          描述

          修改主机的PHP版本

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          newVersion String RequestBody参数 切换到的PHP版本,允许的值为:5.2, 5.3, 5.4

          请求备注

          • account在PUT请求时,需要加入到path中
          • 解绑域名操作以Query参数加入
          • newVersion值不合法,直接返回错误

          返回

          返回头域

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

          返回参数

          http状态为200的空返回

          返回错误

          Code Message HTTP Status Code 说明
          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 管理账号不合法
          AccountNotExist The specified parameter [account] not exists 400 管理账号不存在
          PhpVersionInvalid There is an illegal domain name. 400 不支持的PHP 版本
          InvalidAccessKeyId The Access Key ID you provided does not exist in our records 403 Access Key ID不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          PUT /v1/host/example?switchPhpVersion 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
          
          {
              "newVersion": "5.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
          
          // 空返回
          {
          
          }

          批量修改FTP密码

          描述

          修改一个父用户下的指定子用户的FTP密码。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          accounts List<String> RequestBody参数 需要修改的子账户的账户名
          passwords List<String> RequestBody参数 需要修改的对应子账户的FTP密码

          请求备注

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          successAccounts List<String> 修改FTP密码成功的子账号
          successPasswords List<String> 修改FTP密码成功FTP密码
          failAccounts List<String> 修改FTP密码失败的子账号
          failPasswords List<String> 修改FTP密码失败FTP密码
          failReasons List<String> 修改FTP密码失败的原因

          返回备注

          • 请求列表中,账号的位置序号需要与密码的位置序号对应。
          • 返回列表中,账号、密码、失败原因根据其在列表中的序号对应。

          返回错误

          Code Message HTTP Status Code 说明
          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不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          POST /v1/host/ftp_batch_reset HTTP/1.1
          Authorization: bce-auth-v1/00d3ffe2a47d4ddb83c8144b84230aae/2016-11-25T06:56:22Z/3600/host;x-bce-console-rpc-id;x-bce-date/d4e2b9441d6a0036bdc87b6b2c1fe5f0f8c4a82ceccff79de4812f91271deda7
          Content-Type: application/json
          Host: bch.bj.baidubce.com
          x-bce-date: 2016-11-25T06:56:22Z
          {
            "accounts" : [ "web1611141520497", "web1611141519298" ],
            "passwords" : [ "test123!", "123456" ]
          }

          返回示例

          HTTP/1.1 200 OK
          Cache-Control: no-cache
          Content-Type: application/json;charset=UTF-8
          Date: Fri, 25 Nov 2016 06:56:29 GMT
          Server: BWS
          Transfer-Encoding: chunked
          x-bce-request-id: c7cfcecf-2b12-40e0-aa62-a7b721b6eb76
          {"successAccounts":["web1611141519298"],"successPasswords":["123456"],"failAccounts":["web1611141520497"],"failPasswords":["test123!"],"failReasons":["The specified account does not exist or does not belong to you."]}

          导出过期站点

          描述

          导出一个父账号下的所有在指定时间段内到期的站点信息

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          fromDate String RequestBody参数 到期时间段的起始时间
          toDate String RequestBody参数 到期时间段的终止时间

          请求备注

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          success String 请求是否成功,只可能为"true"和"false"
          result List<HostInfo> 到期站点信息列表

          HostInfo结构

          参数名称 类型 描述
          account String 站点管理账户名称
          domain String 站点临时域名
          aliasDomain String 站点别名域名
          expireTime Date 站点到期日期
          appid String 站点的标识

          返回备注

          • 请求列表中,账号的位置序号需要与密码的位置序号对应。
          • 返回列表中,账号、密码、失败原因根据其在列表中的序号对应。

          返回错误

          Code Message HTTP Status Code 说明
          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不存在
          ServiceInternalError Service internal error occurred 500 内部服务发生错误

          示例

          请求示例

          POST /v1/host/list_expired_sites
          Authorization: bce-auth-v1/00d3ffe2a47d4ddb83c8144b84230aae/2016-11-25T07:43:22Z/3600/host;x-bce-console-rpc-id;x-bce-date/51f8303026675e420337d4fab0b14d03b199493e5aacd4d2fe0522a14d4e73c4
          Content-Type: application/json
          Host: localhost
          x-bce-console-rpc-id: 81e35fac-96b4-4e96-872a-6c58ae6ab20b
          x-bce-date: 2016-11-25T07:43:22Z
          {
            "fromDate" : "2017-02-01",
            "toDate" : "2017-03-01"
          }

          返回示例

          HTTP/1.1 200 OK
          Cache-Control: no-cache
          Content-Type: application/json;charset=UTF-8
          Date: Fri, 25 Nov 2016 07:43:25 GMT
          Server: BWS
          Transfer-Encoding: chunked
          x-bce-request-id: fc8ed838-9306-47de-bc42-970a8b65e015
          {"success":true,"result":[{"account":"systemhost3186","domain":"systemhost3186.fc.bdysite.com","aliasDomain":"false","expireTime":"11/02/2017","appid":"appidcq4bhz0452"},{"account":"systemhost7946","domain":"systemhost7946.bj.bdysite.com","aliasDomain":"false","expireTime":"12/02/2017","appid":"appida9aq822n37"},{"account":"systemhost6058","domain":"systemhost6058.bj.bdysite.com","aliasDomain":"false","expireTime":"13/02/2017","appid":"appidb88c08i3sb"},{"account":"systemhost8700","domain":"systemhost8700.fc.bdysite.com","aliasDomain":"false","expireTime":"14/02/2017","appid":"appid6c4cic21bm"},{"account":"systemhost9376","domain":"systemhost9376.bj.bdysite.com","aliasDomain":"false","expireTime":"15/02/2017","appid":"appidd8e2sbawp9"},{"account":"systemhost7425","domain":"systemhost7425.bj.bdysite.com","aliasDomain":"false","expireTime":"16/02/2017","appid":"appidb2kgpuff7f"},{"account":"systemhost9385","domain":"systemhost9385.fc.bdysite.com","aliasDomain":"false","expireTime":"17/02/2017","appid":"appidx76bt2e5d6"},{"account":"systemhost5193","domain":"systemhost5193.bj.bdysite.com","aliasDomain":"false","expireTime":"18/02/2017","appid":"appid2nw2na9672"},{"account":"systemhost3032","domain":"systemhost3032.bj.bdysite.com","aliasDomain":"false","expireTime":"19/02/2017","appid":"appidqb74m01ad7"},{"account":"systemhost3580","domain":"systemhost3580.bj.bdysite.com","aliasDomain":"false","expireTime":"20/02/2017","appid":"appidbf7w54f37f"},{"account":"systemhost2442","domain":"systemhost2442.bj.bdysite.com","aliasDomain":"false","expireTime":"21/02/2017","appid":"appidb9272ue537"},{"account":"systemhost5012","domain":"systemhost5012.fc.bdysite.com","aliasDomain":"false","expireTime":"22/02/2017","appid":"appid6eifol48qz"},{"account":"systemhost1943","domain":"systemhost1943.bj.bdysite.com","aliasDomain":"false","expireTime":"23/02/2017","appid":"appidf6txkbvap3"},{"account":"systemhost7289","domain":"systemhost7289.bj.bdysite.com","aliasDomain":"false","expireTime":"24/02/2017","appid":"appid28x4k69zi1"},{"account":"systemhost9518","domain":"systemhost9518.bj.bdysite.com","aliasDomain":"false","expireTime":"25/02/2017","appid":"appiddbdexqh3xv"}]}

          PHP缓存加速

          描述

          开启/关闭PHP缓存加速功能

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          cache Boolean RequestBody参数 开启:true;关闭:false

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT /v1/host/qyaww53j55?phpcache 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
          
          {
              "cache": true,
          }

          返回示例

          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****

          默认首页设置

          描述

          设置默认的首页,可以多个

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          indexes List<String> RequestBody参数 页面列表

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?index 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
          
          {
              "indexes": ["www.test001.com", "www.test002.com"]
          }

          返回示例

          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****

          错误页面自定义

          描述

          设置错误跳转页面

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          content String RequestBody参数 页面列表
          code String RequestBody参数 400 403 404 500 502 其中之一

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?errorrule  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
          
          {
              "content": "www.test001.com",
              "code" :"404"
          }

          返回示例

          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****

          301/302重定向

          描述

          设置301/302重定向

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          method String RequestBody参数 根据域名'DOMAIN',还是路径"URL",只能是二者之一
          originPath String RequestBody参数 源地址
          targetPath String RequestBody参数 目标地址
          redirectType String RequestBody参数 301或者302

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT /v1/host/qyaww53j55?redirectrule 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
          
          {
                  "method": "URL",
                  "originPath": "www.baidu.com ",
                  "targetPath": "www.hao123.com",
                  "redirectType": "301"
          }

          返回示例

          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****

          文件压缩

          描述

          文件压缩

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          path String RequestBody参数 需要压缩的文件完整路径 可选择除FTP webroot目录及其子目录或文件
          type String RequestBody参数 压缩类型,只能取三者之一;TAR("tar"),TARGZ("targz"),ZIP("zip")

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?compress 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
          
          {
                 "path" :"/webroot",
                 "type" :"zip"
          }

          返回示例

          HTTP/1.1 202 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****

          查询压缩任务的运行状态

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机

          请求备注

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          success Boolean 请求是否成功,成功:true;失败false
          status String 状态 RUNNING
          endTime String 结束时间
          compressedFileName String 文件名称
          errorInfo String 错误信息

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          GET  /v1/host/qyaww53j55?checkcompress 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    

          返回示例

          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****
          
          {
              "success":true,
              "status":200,
              "result":{
                  "status":"FINISHED",
                  "endTime":"1555334609",
                  "compressedFileName":"appidh4zi9dnr9y-webroot-20190415212326.zip"
              }
          }

          文件解压

          描述

          文件解压

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          origin String RequestBody参数 需要解压的文件完整路径(请指定FTP文件路径,/表示FTP根目录,而非网站根目录)
          target String RequestBody参数 解压的目标地址(禁止解压到根目录下,且解压目录不能和压缩包路径同级。)

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?unpack 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
          
          {
                 "origin": "/temp/appidh4zi9dnr9y-webroot-20190415212326.zip",
                 "target": "/temp/"
          }    

          返回示例

          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****   

          查询解压任务的状态

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机

          请求备注

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          success Boolean 请求是否成功,成功:true;失败false
          status String 状态 RUNNING FINISHED
          origin String 源文件地址
          target String 压缩地址
          errorInfo String 错误信息

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          GET  /v1/host/qyaww53j55?checkunpack 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

          返回示例

          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****
          
          {
              "success":true,
              "result":{
                  "status":"FINISHED",
                  "origin":"/temp/appidh4zi9dnr9y-webroot-20190415212326.zip",
                  "target":"/temp",
                  "errorInfo":null
              }
          }

          在线删除

          描述

          在线删除

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          path String RequestBody参数 要删除的文件路径
          1.文件路径必须以反斜杆 "/" 打头,例如 /temp.txt 。
          2./backup, /conf, /database, /dblogs, /ftplogs, /others, /temp, /weblogs, /webroot为保留目录,目录本身不可删除。例如,如果输入"/backup",则会删除该目录下的所有文件,但是"backup"目录本身不会被删除。
          3.输入的目录中尽量不要使用中文,否则可能无法正常删除。
          4.删除文件后不可恢复,请谨慎操作。

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?deleteFile 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
          
          {
                  "path" :"/temp/appidh4zi9dnr9y-webroot-20190415212326.zip"
          }

          返回示例

          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****

          文件锁定或者解锁

          描述

          文件锁定或者解锁

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机
          path String RequestBody参数 文件完整路径
          type String RequestBody参数 压锁定:"LOCK",解锁:'UNLOCK'

          请求备注

          返回

          返回头域

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

          返回参数

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          PUT  /v1/host/qyaww53j55?filefrozen
          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
          
          {
                 "path" :"/temp/",
                 "type" :"LOCK"
          }

          返回示例

          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****

          查询文件锁定/解锁任务状态

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 免费域名前缀/管理账号,在同域下唯一标识一台主机

          请求备注

          返回

          返回头域

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

          返回参数

          参数名称 类型 描述
          success Boolean 请求是否成功,成功:true;失败false
          status String 状态 RUNNING FINISHED
          path String 源文件地址
          endtime String 压缩地址

          返回备注

          返回错误

          公共错误码

          示例

          请求示例

          GET  /v1/host/qyaww53j55?checkunpack 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

          返回示例

          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****
          
          {
              "success":true,
              "result":{
                  "status":"FINISHED",
                  "path":"/webroot/",
                  "endTime":"2019-04-15 21:36:32"
              }
          }

          主机启动

          描述

          启动指定主机,接口调用成功后实例进入RUNNING状态。

          请求

          请求结构

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

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          action String Query参数 对站点执行的动作,本接口中该参数取值start

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共错误码

          示例

          请求示例

          PUT /v1/host/web/qyaww53j55?start HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          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****

          主机停止

          描述

          停止指定主机,接口调用成功后实例进入STOPPED状态。

          请求

          请求结构

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

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          action String Query参数 对站点执行的动作,本接口中该参数取值stop

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共错误码

          示例

          请求示例

          PUT /v1/host/web/qyaww53j55?stop HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          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****

          获取主机启停状态

          描述

          获取主机的启停状态。

          请求

          请求结构

          GET /v{version}/host/web/{account} HTTP/1.1
          Host: bch.bj.baidubce.com
          Authorization: authorization string
          ...

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共错误码

          示例

          请求示例

          GET /v1/host/web/qyaww53j55 HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          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****
          {
              "status": "RUNNING"
          }

          数据库信息

          描述

          获取数据库信息。

          请求

          请求结构

          GET /v{version}/host/database/{account} HTTP/1.1
          Host: bch.bj.baidubce.com
          Authorization: authorization string

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机

          返回

          返回头域

          公共头域

          返回参数

          参数名称 类型 描述
          dbName String 数据库名称
          domainName String 数据库域名
          port int 数据库端口
          dbAccount String 数据库用户名
          description String 数据库描述
          charset String 数据库字符集
          capacity long 数据库磁盘容量
          usage long 数据库磁盘用量
          status String 数据库状态
          phpMyadminUrl String 数据库管理平台访问地址

          返回错误

          公共的错误码

          示例

          请求示例

          GET /v1/host/database/qyaww53j55 HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          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****
          {
              "name": "b_ufab3aitpz3nuz",
              "hostname": "b-ufab3aitpz3nuz.bch.rds.gz.baidubce.com",
              "port": 3306,
              "username": "b_ufab3aitpz3nuz",
              "description": "openapi-test",
              "charset": "utf-8",
              "status": "STARTED",
              "capacity": 1048576000,
              "usage": 0,
              "phpMyadminUrl": "http://pma.rds.gz.bce.baidu.com/phpmyadmin/index.php"
          }

          修改数据库密码

          描述

          重置mysql数据库的登录密码。

          请求

          请求结构

          PUT /v{version}/host/{account}?{action} HTTP/1.1
          Host: bch.bj.baidubce.com
          Authorization: authorization string
          ...
          {
              "password": dbPassword
          }

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          action String Query参数 对实例执行的动作,当前取值updateDbPwd
          password String RequestBody参数 更新的密码,密码限制为6-32位字符,由英文,数字或符号组成,符号仅限!@#$%^*()

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共的错误码

          示例

          请求示例

          PUT /v1/host/qyaww53j55?updateDbPwd HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
          
          {
              "password": "bch@database$"
          }

          返回示例

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

          修改主机的运行模式

          描述

          描述:调试模式和发布模式间转换。

          • 调试模式下,我们将关闭PHP缓存加速(OPCache)功能,同时将切换Error_Reporting模式为E_All,并打开display_errors和html_errors。
          • 发布模式下,我们将默认开启PHP缓存加速(OPCache)功能,同时将切换Error_Reporting模式为E_All&~E_Notice,并关闭了display_errors。

          请求

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机
          action String Query参数 对实例执行的动作,当前取值switchMode
          mode String RequestBody参数 mode取值为"DEBUG"或"ONLINE",代表调试模式和发布模式

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共的错误码

          示例

          请求示例

          PUT /v1/host/qyaww53j55?switchMode HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
          
          {
              "mode": "ONLINE"
          }

          返回示例

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

          获取主机运行模式

          描述

          描述:获取主机的运行模式。

          请求

          请求结构

          GET /v{version}/host/mode/{account} HTTP/1.1
          Host: bch.bj.baidubce.com
          Authorization: authorization string
          ...

          请求头域

          公共头域

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          account String URL参数 管理账号,在同域下唯一标识一台主机

          返回

          返回头域

          公共头域

          返回参数

          返回错误

          公共的错误码

          示例

          请求示例

          GET /v1/host/mode/qyaww53j55 HTTP/1.1
          Host: bch.bj.baidubce.com
          ContentType: application/json
          Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          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****
          {
              "mode": "DEBUG"
          }
          上一篇
          API总述
          下一篇
          附录