磁盘相关接口

创建CDS磁盘

  • 本接口用于创建CDS磁盘。支持从快照创建的方式,但系统盘快照不能用来创建CDS磁盘。
  • 请求参数中 cdsSizeInGB 和 snapshotId 必须选择其中一项来指定磁盘的大小或使用快照创建磁盘。
  • 当snapshotId 参数存在且不为空时,cdsSizeInGB参数如果未指定,默认使用快照大小创建CDS磁盘。如果指定了cdsSizeInGB参数,则参数值不能小于快照大小值。
  • 创建接口为异步接口,可通过查询磁盘详情接口查询磁盘状态

请求结构

POST /v{version}/volume?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
  "storageType": storageType,
  "cdsSizeInGB" : cdsSizeInGB,
  "purchaseCount" : purchaseCount,
      "billing":{
        "paymentTiming":paymentTiming,
        "reservation":{
            "reservationLength":reservationLength,
            "reservationTimeUnit":reservationTimeUnit
          } 
        },
     "zoneName": zoneName
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见幂等性
purchaseCount int RequestBody参数 批量创建的CDS磁盘的个数,必须为大于0的整数,单次创建不能超过5个。可选参数,缺省为1
cdsSizeInGB int RequestBody参数 CDS磁盘容量,必须为大于0的整数,单位为GB,大小为0~32765GB。当参数snapshotId为空或不存在时该参数必需。
storageType StorageType RequestBody参数 CDS磁盘存储类型,包括hp1(高性能云磁盘)和std1(普通云磁盘)两种类型,默认hp1。
billing Billing RequestBody参数 订单、计费相关参数
snapshotId String RequestBody参数 快照ID,支持从快照创建磁盘。当此参数存在时且不为空时,cdsSizeInGB参数将被忽略,此时非必需。
zoneName String RequestBody参数 指定可用区信息,默认为空,由系统自动选择。
snapshotId String RequestBody参数 快照ID,支持从快照创建磁盘

返回头域

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

返回参数

参数名称 类型 描述
volumeIds List 磁盘ID,符合BCE规范,必须是一个定长字符串,且只允许包含大小写字母、数字、连字号(-)和下划线(_)。

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.SystemSnapshotForbiddenOperation System snapshot can not be used to create volume. 403 系统快照不允许创建磁盘

请求示例

POST http://bcc.bj.baidubce.com/v2/volume?clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "storageType": "std1",
  "cdsSizeInGB" : 5,
  "purchaseCount" : 2,
      "billing":{
        "paymentTiming":"Prepaid",
        "reservation":{
            "reservationLength":1,
            "reservationTimeUnit":"Month"
          } 
        }
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
    Server: BWS

{
        "volumeIds": [
            "v-NSuv0ssl",
            "v-MPO0YONO"
         ]
     }

查询磁盘列表

  • 该接口用于查询所有的磁盘列表,不包含本地磁盘。

请求结构

GET /v{version}/volume?marker={marker}&maxKeys={maxKeys}&instanceId={instanceId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys int Query参数 每页包含的最大数量,最大数量通常不超过1000。缺省值为1000
instanceId String Query参数 实例id,可查询实例挂载的磁盘列表(包含系统盘)。如需查询用户创建的所有磁盘信息,不填写此参数。
zoneName String Query参数 可用区信息

返回头域

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

返回参数

参数名称 类型 描述
marker String 标记查询的起始位置
isTruncated boolean true表示后面还有数据,false表示已经是最后一页。
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现。
maxKeys int 每页包含的最大数量
volumes List<VolumeModel> 返回的磁盘信息列表

请求示例

GET /v2/volume?marker=v-8CM91d5U&maxKeys=1&instanceId=i-j7lMWiyX HTTP/1.1
Host: bcc.bj.baidubce.com
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
Cache-Control: no-cache
Content-Length: 17527
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:38:06 GMT
Server: BWS

    {
        "nextMarker": "v-w7RKfn2d",
        "marker": "v-8CM91d5U",
        "maxKeys": 1,
        "volumes": [
          {
            "id": "v-8CM91d5U",
            "createTime": "2015-06-25T12:48:29Z",
            "expireTime": null,
            "name": "instance-0svq10tr-1",
            "diskSizeInGB": 20,
            "status": "InUse",
            "type": "Cds",
            "storageType": "std1",
            "desc": "",
            "paymentTiming": "Postpaid",
            "attachments": [
                {
                    "volumeId": "v-3zmCcxbR",
                    "instanceId": "i-j7lMWiyX",
                    "device": "/dev/vdb"
                    "serial":"062b3f5d-b8a5-4c29-9"
                }
             ],
            "zoneName": "cn-bj-a"
            }
        ],
        "truncated": true
    }

查询磁盘详情

  • 该接口用于根据磁盘ID查询单个磁盘的详细信息。

请求结构

GET /v{version}/volume/{volumeId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待查询的磁盘ID

返回头域

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

返回参数

参数名称 类型 描述
volume VolumeModel 返回的磁盘信息

请求示例

GET /v2/volume/v-8CM91d5U HTTP/1.1
Host: bcc.bj.baidubce.com
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
Content-Type: application/json;charset=UTF-8
Server: BWS
{
    "volume": {
        "id": "v-8CM91d5U",
        "createTime": "2015-06-25T12:48:29Z",
        "expireTime": null,
        "name": "instance-0svq10tr-1",
        "diskSizeInGB": 20,
        "status": "InUse",
        "type": "Cds",
        "storageType": "std1",
        "desc": "",
        "paymentTiming":"Postpaid",
        "attachments": [
                   {
                       "volumeId": "v-3zmCcxbR",
                       "instanceId": "i-j7lMWiyX",
                       "device": "/dev/vdb"
                       "serial":"062b3f5d-b8a5-4c29-9"
                    }
                 ],
        "zoneName": "cn-bj-a"
      }
  }

挂载CDS磁盘

  • 该接口用于将指定磁盘挂载在指定虚拟机实例下。

注意:

cds磁盘需要挂载在与其处于相同zone下的指定虚拟机实例上,否则将返回403错误。

  • 只有磁盘状态为 Available 且实例状态为 Running 或 Stopped 时才允许挂载,否则调用此接口将返回 409 错误。

请求结构

PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
  "instanceId":instanceId
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 磁盘ID
action String Query参数 对磁盘的执行动作,当前取值attach
instanceId String Request Body参数 待挂载的虚拟机实例ID

返回头域

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

返回参数

参数名称 类型 描述
volumeAttachment VolumeAttachmentModel 磁盘挂载虚机的信息

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.InstanceStatusCannotAttach Instance only when it is running or stopped state can mount to it. 409 挂载磁盘,虚机状态不允许
Volume.DistNotAvailable Volume status is not available, can not be attached to instance. 409 磁盘状态不可用
Volume.DiskAttachedQuotaExceededLimit The attached disk number to an instance exceeds limit. 413 cds磁盘挂载超额

请求示例

PUT /v2/volume/v-3zmCcxbR?attach HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "instanceId":"i-j7lMWiyX"
}

返回示例

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

{
    "volumeAttachment": {
        "volumeId": "v-3zmCcxbR",
        "instanceId": "i-j7lMWiyX",
        "device": "/dev/vdb"
        "serial":"062b3f5d-b8a5-4c29-9"
    }
}

卸载CDS磁盘

  • 该接口用于将指定的磁盘从实例中卸载。
  • 只有实例状态为 Running 或 Stopped 时,磁盘才可以执行此操作,否则将提示 409 错误。
  • 如果 volumeId 的磁盘不挂载在 instanceId 的实例上,该操作失败,提示 404 错误。

请求结构

PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
"instanceId" : instanceId
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待卸载的磁盘对应的ID
action String Query参数 对磁盘的执行动作,当前取值detach
instanceId String Request Body参数 所挂载的实例ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskNotAttachedInstance Volume is not mounted in this instance, please make sure and try again. 400 磁盘未绑定实例
Volume.InstanceStatusCannotDetach Instance only when it is running or stopped state can unmount from it. 409 卸载磁盘,虚机状态不允许

请求示例

PUT /v2/volume/v-bSlHQpKA?detach HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "instanceId":"i-2fCSL4Y6"
}

返回示例

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

释放CDS磁盘

  • 该接口用于释放未挂载的CDS磁盘,系统盘不能释放。
  • 磁盘释放后不可恢复。缺省情况下,该磁盘的所有快照将保留,但会删除与磁盘的关联关系。
  • 只有磁盘状态为 Available 或 Expired 或 Error 时才可以执行此操作,否则将提示 409 错误。
  • 如果 volumeId 的磁盘不存在,将提示 404 错误。

请求结构

DELETE /v{version}/volume/{volumeId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待释放的磁盘ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskStatusCannotBeDeleted Volume in current status can not be deleted. 409 磁盘当前状态不能被删除
Volume.SystemDiskCannotBeDeleted System disk can not be deleted. 403 系统盘不能被删除

请求示例

DELETE /v2/volume/v-3zmCcxbR HTTP/1.1
Host: bcc.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
Content-Type: application/json;charset=UTF-8
Server: BWS

释放CDS磁盘(新)

描述

  • 该接口用于释放未挂载的CDS磁盘,系统盘不能释放。
  • 磁盘释放后不可恢复。用户可指定是否删除磁盘关联的快照,缺省情况下,该磁盘的所有快照将保留,但会删除与磁盘的关联关系。
  • 只有磁盘状态为 Available 或 Expired 或 Error 时才可以执行此操作,否则将提示 409 错误。
  • 如果 volumeId 的磁盘不存在,将提示 404 错误。
  • 与老接口功能上的区别在于,可以控制是否删除与磁盘关联的快照。

请求结构

POST /v{version}/volume/{volumeId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
  "autoSnapshot": "on",
  "manualSnapshot": "on"
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待释放的磁盘ID
autoSnapshot String Request body参数 取值为"on"时,会删除磁盘关联的自动快照
manualSnapshot String Request body参数 取值为"on"时,会删除磁盘关联的手动快照

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskStatusCannotBeDeleted Volume in current status can not be deleted. 409 磁盘当前状态不能被删除
Volume.SystemDiskCannotBeDeleted System disk can not be deleted. 403 系统盘不能被删除

请求示例

POST /v2/volume/v-3zmCcxbR HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "autoSnapshot": "on",
  "manualSnapshot": "on"
}

返回示例

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

磁盘扩容

为指定磁盘扩容,修改CDS磁盘容量大小。

说明:

CDS磁盘只能进行扩容操作。

  • 只有Available状态的磁盘,才能进行扩容操作。
  • 异步接口,可通过查询磁盘详情接口查询磁盘扩容状态status是否恢复。

请求结构

PUT /v{version}/volume/{volumeId}?{action}&clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "newCdsSizeInGB" : newCdsSizeInGB
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 磁盘ID
action String Query参数 本接口取值resize
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性
newCdsSizeInGB int Request Body参数 新扩容CDS磁盘的容量大小,必须为大于当前CDS容量的整数,单位为GB,大小为0~32765GB且为5的整数倍。当快照参数snapshotId为空或不存在时该参数必需。

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskIdIsEmpty Volume id must be provided. 400 磁盘id不允许为空
Volume.DiskSizeInvalid Disk size in invalid. 400 cds 大小不合法 400
NoSuchObject The specified object is not found or resource do not exist. 404 资源不存在
OperationDenied Operation not available. 409 不可操作
Volume.DiskQuotaExceededLimit Number of volumes exceeds limit. 413 cds磁盘超额

请求示例

PUT /v2/volume/v-3zmCcxbR?resize&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
        "newCdsSizeInGB" : 10
}

返回示例

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

回滚磁盘

用指定磁盘自身的快照回滚磁盘内容。

  • 磁盘状态必须为 Available 才可以执行此操作。
  • 指定快照ID(snapshotId) 必须是由指定磁盘ID(volumeId) 创建的快照。
  • 若是回滚系统盘,实例状态必须为 Running 或 Stopped 才可以执行此操作。

注意:

回滚系统盘快照,自本次快照以来的系统盘数据将全部丢失,不可恢复。

请求结构

PUT /v2/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "snapshotId": snapshotId
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待回滚的磁盘ID,系统盘则为实例ID
action String Query参数 对磁盘执行的操作,当前取值:rollback
snapshotId String Request Body参数 用于回滚指定磁盘的快照ID,必须为 volumeId 所创建的快照

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数无效
SnapshotOperationForbidden snapshot operation forbidden. 403 快照操作 deny
NoSuchObject The specified object is not found or resource do not exist. 404 资源不存在
OperationDenied Operation not available. 409 不可操作

请求示例

PUT /v2/volume/v-3zmCcxbR?rollback HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "snapshotId": "s-8CM91d5U"
}

返回示例

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

磁盘续费

为指定磁盘续费,延长该磁盘过期时间。

  • 磁盘扩缩容期间不能进行续费操作。
  • 异步接口。

请求结构

PUT /v2/volume/{volumeId}?{action}&clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "billing":{
        "reservation":{
            "reservationLength": reservationLength,
            "reservationTimeUnit": reservationTimeUnit
        }
    }
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 磁盘ID
action String Query参数 本接口中该参数取值purchaseReserved
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性
billing Billing RequestBody参数 订单信息

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数无效
SnapshotOperationForbidden snapshot operation forbidden. 403 快照操作 deny
NoSuchObject The specified object is not found or resource do not exist. 404 资源不存在
OperationDenied Operation not available. 409 不可操作

请求示例

PUT /v2/volume/v-3zmCcxbR?purchaseReserved&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "billing":{
        "reservation":{
            "reservationLength":1,
            "reservationTimeUnit":"Month"
        }
    }
}

返回示例

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

磁盘重命名

描述

  • 该接口用于修改指定磁盘名称。

请求结构

PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "name" : name
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待卸载的磁盘对应的ID
action String Query参数 对磁盘的执行动作,当前取值rename
name String Request Body参数 磁盘新的名称,自定义镜像名称,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskNameInvalid Volume name is invalid. 400 磁盘名称不符合规则。

请求示例

PUT /v2/volume/v-bSlHQpKA?rename HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "name":"volume-new-name"
}

返回示例

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

修改磁盘属性

描述

  • 该接口用于修改指定磁盘名称、描述信息

请求结构

PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "cdsName": "volume-new-name",
    "desc": "volume-new-desc"
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待修改磁盘ID
action String Query参数 对磁盘的执行动作,当前取值modify
cdsName String Request Body参数 磁盘新的名称,自定义镜像名称,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。
desc String Request Body参数 磁盘新的描述信息

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.DiskNameInvalid Volume name is invalid. 400 磁盘名称不符合规则。

请求示例

PUT /v2/volume/v-bSlHQpKA?modify HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "cdsName": "volume-new-name",
    "desc": "volume-new-desc"
}

返回示例

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

磁盘计费变更

描述

  • 该接口用于变更磁盘计费方式,仅支持后付费转预付费、预付费转后付费两种方式
  • 变更为预付费需要指定购买时长

请求结构

PUT /v{version}/volume/{volumeId}?{action} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "billing": {
        "reservation": {
            "reservationLength": reservationLength
        }
    }
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
volumeId String URL参数 待变更计费磁盘ID
action String Query参数 对磁盘的执行动作,当前取值modifyChargeType
billing Billing RequestBody参数 订单信息,变更为预付费需要指定参数billing.reservation.reservationLength,变更后付费不需要指定

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Volume.VolumeTypeNotSupport Volume type not support to_postpay. 403 磁盘类型不支持 "转后付费"
Volume.PaymentTypeNotSupportToPostpay Payment type not support to_postpay 403 付费方式不支持 "转后付费"
Volume.AutoRenewNotSupportToPostpay Auto renew instance not support to_postpay operation. 403 开通自动续费的实例不支持 "转后付费"
Volume.ExpiredResourceNotSupportToPostpay Expired resource not support to_postpay operation. 403 已到期资源不支持 "转后付费"
Volume.VolumeTypeNotSupportToPrepay Volume type not support to_prepay. 403 磁盘类型不支持 "转预付费"
Volume.PrepaidInstanceOperationForbidden Postpaid instances are not supported for this operation. 409 付费方式不支持 "转预付费"
Volume.DiskStatusNotSupportBillingChange The volume status not support billing change. 409 磁盘状态不允许计费变更

请求示例

PUT /v2/volume/v-bSlHQpKA?modifyChargeType HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "billing": {
        "reservation": {
            "reservationLength": 1
        }
    }
}

返回示例

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