华为云用户手册

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 rollback RollbackInfo object 快照回滚信息。 表6 RollbackInfo 参数 参数类型 描述 volume_id String 回滚的目标云硬盘UUID。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表8 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 rollback 是 RollbackSnapshotOption object 快照回滚信息。 表4 RollbackSnapshotOption 参数 是否必选 参数类型 描述 name 否 String 回滚的目标云硬盘名称。 volume_id 是 String 回滚的目标云硬盘UUID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-set_bootable 是 CinderUpdateVolumeBootableOption object 标记设置云硬盘启动盘操作 表4 CinderUpdateVolumeBootableOption 参数 是否必选 参数类型 描述 bootable 是 Boolean 是否启动盘标识。false：不启动true：启动 缺省值：true

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-extend 是 CinderResizeVolumeOption object 标记扩容云硬盘操作 表4 CinderResizeVolumeOption 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后的云硬盘大小，单位为GiB。 扩容后的云硬盘容量范围：大于原有云硬盘容量~云硬盘最大容量（数据盘为32768GiB；系统盘为1024GiB）

响应参数 状态码： 300 表1 响应Body参数 参数 参数类型 描述 versions Array of Versions objects 版本信息。 表2 Versions 参数 参数类型 描述 id String 接口版本的ID links Array of Link objects 接口版本信息的URI描述信息 media-types Array of MediaTypes objects 接口版本的请求消息类型信息 min_version String 接口版本的最小版本号 status String 接口版本的状态 updated String 接口版本更新时间 version String 接口版本的版本号信息 表3 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 表4 MediaTypes 参数 参数类型 描述 base String 文本类型 type String 返回类型 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表6 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 300 版本号详情列表。 { "versions" : [ { "min_version" : "", "media-types" : [ { "type" : "application/vnd.openstack.volume+json;version=1", "base" : "application/json" }, { "type" : "application/vnd.openstack.volume+xml;version=1", "base" : "application/xml" } ], "links" : [ { "rel" : "describedby", "href" : "http://docs.openstack.org/", "type" : "text/html" }, { "rel" : "self", "href" : "https://evs.localdomain.com/v1" } ], "id" : "v1.0", "updated" : "2014-06-28T12:20:21Z", "version" : "", "status" : "SUPPORTED" }, { "min_version" : "", "media-types" : [ { "type" : "application/vnd.openstack.volume+json;version=1", "base" : "application/json" }, { "type" : "application/vnd.openstack.volume+xml;version=1", "base" : "application/xml" } ], "links" : [ { "rel" : "describedby", "href" : "http://docs.openstack.org/", "type" : "text/html" }, { "rel" : "self", "href" : "https://evs.localdomain.com/v2" } ], "id" : "v2.0", "updated" : "2014-06-28T12:20:21Z", "version" : "", "status" : "SUPPORTED" }, { "min_version" : "3.0", "media-types" : [ { "type" : "application/vnd.openstack.volume+json;version=1", "base" : "application/json" }, { "type" : "application/vnd.openstack.volume+xml;version=1", "base" : "application/xml" } ], "links" : [ { "rel" : "describedby", "href" : "http://docs.openstack.org/", "type" : "text/html" }, { "rel" : "self", "href" : "https://evs.localdomain.com/v3" } ], "id" : "v3.0", "updated" : "2016-02-08T12:20:21Z", "version" : "3.0", "status" : "CURRENT" } ] } 状态码： 400 Bad Request { "error" : { "code" : "string", "message" : "string" } }

API风格说明 当前EVS服务对外的API存在以下两种风格： EVS服务自定义规范的API，以下简称为EVS自定义API。 顺从OpenStack社区标准原生规范的API，以下简称为OpenStack Cinder API。 两者风格不同，功能相近。OpenStack Cinder API主要用于满足您在开源生态工具方面的对接需求。针对某些功能，EVS自定义API在OpenStack Cinder API基础上，做了功能增强。 支持创建包周期的云硬盘 支持扩容包周期的云硬盘 支持企业项目管理

响应示例 状态码： 200 OK { "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "bookmark" } ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "az-dc-1#SSD", "encrypted" : false, "multiattach" : true, "updated_at" : "2016-02-03T02:19:29.895237", "os-volume-replication:extended_status" : null, "replication_status" : "disabled", "snapshot_id" : null, "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "volume_image_metadata" : null, "os-vol-mig-status-attr:migstat" : null, "metadata" : { }, "status" : "error_restoring", "description" : "auto-created_from_restore_from_backup", "source_volid" : null, "consistencygroup_id" : null, "os-vol-mig-status-attr:name_id" : null, "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "volume_type" : null } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 volume CinderVolumeDetail object 查询请求返回的云硬盘。 表4 CinderVolumeDetail 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘uri自描述信息。 name String 云硬盘名称。 status String 云硬盘状态，具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 是否挂载信息。 availability_zone String 云硬盘所属AZ。 source_volid String 源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID，如果是从快照创建，则有值。 description String 云硬盘描述。 bootable String 是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。 created_at String 云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX volume_type String 云硬盘类型。 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"，"ESSD2"七种。 "SATA"为普通IO云硬盘(已售罄) "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 "ESSD"为极速IO云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 metadata VolumeMetadata object 云硬盘的元数据。 如果元数据中不包含hw:passthrough字段，云硬盘默认为VBD类型。 如果元数据中不包含__system__encrypted字段，云硬盘默认为不加密。 size Integer 云硬盘大小，单位为GiB。 shareable Boolean 是否为可共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。 multiattach Boolean 是否为可共享云硬盘。 os-vol-tenant-attr:tenant_id String 云硬盘所属的租户ID。租户ID就是项目ID。 volume_image_metadata Object 云硬盘镜像的元数据。 关于“volume_image_metadata”字段的详细说明，具体请参见："查询镜像详情"。 os-vol-host-attr:host String 预留属性。 os-volume-replication:extended_status String 预留属性。 consistencygroup_id String 预留属性。 iops iops object 云硬盘的iops信息，云硬盘类型是ESSD2、GPSSD2才返回。 throughput throughput object 云硬盘的吞吐量信息，云硬盘类型是GPSSD2才返回。 updated_at String 云硬盘更新时间。 replication_status String 预留属性。 user_id String 预留属性。 encrypted Boolean 预留属性。 表5 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 表6 VolumeAttachment 参数 参数类型 描述 attached_at String 挂载的时间信息。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_id String 挂载信息对应的ID。 device String 挂载点 host_name String 云硬盘挂载到的云服务器云主机对应 的物理主机的名称。 id String 挂载的资源ID server_id String 云硬盘挂载到的云服务器云主机的 ID。 volume_id String 云硬盘ID 表7 VolumeMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 说明： 请参考 查询密钥列表，通过HTTPS请求获取密钥ID。 __system__encrypted String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。 full_clone String 从快照创建云硬盘时，如需使用link克隆方式，请指定该字段的值为0。 hw:passthrough String true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。 表8 iops 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值：false id String 云硬盘iops标识。 total_val Integer iops大小。 volume_id String 云硬盘ID。 表9 throughput 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值：false id String 云硬盘吞吐量标识。 total_val Integer 吞吐量大小。 volume_id String 云盘ID。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表11 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应参数 状态码： 202 表6 响应Body参数 参数 参数类型 描述 job_id String 任务ID，云硬盘为按需计费时返回该参数。 说明： 如果需要查询job的状态，请参考查询job的状态。 order_id String 订单ID，云硬盘为包周期计费时返回该参数。 说明： 如果您需要支付订单，请参考："支付包周期产品订单"。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表8 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

请求示例 扩容云硬盘，扩容后的云硬盘大小为100GiB，立即支付扩容费用，且从账户余额中自动扣费。 POST https://{endpoint}/v2.1/{project_id}/cloudvolumes/{volume_id}/action { "os-extend" : { "new_size" : 100 }, "bssParam" : { "isAutoPay" : "true" } }

功能介绍 对按需或者包周期云硬盘进行扩容。 在扩容包周期云硬盘的场景下： 如果您需要查看订单可用的优惠券，请参考"查询订单可用优惠券"。 如果您需要支付订单，请参考"支付包周期产品订单"。 如果您需要查询订单的资源开通详情，请参考"查询订单的资源开通详情"。 如果您需要退订该包周期资源，请参考“退订包周期资源”。 扩容接口采用异步通知的方式实现。扩容完成时，不会修改云盘分区和文件系统，您需要在扩容后自行分配存储空间。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 bssParam 否 BssParamForResizeVolume object 按需和包周期的扩展参数。 os-extend 是 OsExtend object 标记扩容云硬盘操作。 表4 BssParamForResizeVolume 参数 是否必选 参数类型 描述 isAutoPay 否 String 功能说明：是否立即支付。该参数只有在云硬盘为包周期的情况下有意义。默认值为false 取值范围： true：立即支付，从账户余额中自动扣费 false：不立即支付，创建订单暂不支付 缺省值：false 枚举值： false true 表5 OsExtend 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后的云硬盘大小，单位为GiB。扩容的大小必须大于原有云硬盘容量且小于云硬盘最大容量。 云硬盘最大容量： 数据盘：32768GiB 系统盘：1024GiB

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 snapshot SnapshotDetails object 快照信息 表6 SnapshotDetails 参数 参数类型 描述 id String 云硬盘快照ID。 status String 云硬盘快照状态。关于云硬盘快照状态参见云硬盘快照状态。 name String 云硬盘快照名称。 description String 云硬盘快照描述信息。 created_at String 云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX updated_at String 快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX metadata Object 云硬盘快照的元数据信息。 volume_id String 快照所属的云硬盘ID。 size Integer 云硬盘快照大小，单位为GiB。 os-extended-snapshot-attributes:project_id String 预留属性。 os-extended-snapshot-attributes:progress String 预留属性。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表8 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 200 OK { "snapshot" : { "status" : "available", "description" : "Daily backup", "created_at" : "2013-02-25T03:56:53.081642", "metadata" : { }, "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "size" : 1, "id" : "f9faf7df-fdc1-4093-9ef3-5cba06eef995", "name" : "snap-001", "updated_at" : "2013-02-25T03:56:53.081642" } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 snapshot 是 UpdateSnapshotOption object 快照信息。 表4 UpdateSnapshotOption 参数 是否必选 参数类型 描述 description 否 String 云硬盘快照描述。最大支持85个字符。 name 否 String 云硬盘快照名称。最大支持64个字符。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 extensions Array of Extension objects 扩展接口列表。 表4 Extension 参数 参数类型 描述 alias String 扩展的别名。 description String 描述 links Array of Link objects 云硬盘传递的链接 name String 云硬盘传递的名称。 updated String 最后的更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.+XX.XX，其中+XX.XX表示时区。 表5 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 200 OK { "extensions" : [ { "updated" : "2013-04-18T00:00:00+00:00", "name" : "SchedulerHints", "links" : [ ], "alias" : "OS-SCH-HNT", "description" : "Pass arbitrary key/value pairs to the scheduler." }, { "updated" : "2011-06-29T00:00:00+00:00", "name" : "Hosts", "links" : [ ], "alias" : "os-hosts", "description" : "Admin-only host administration." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeTenantAttribute", "links" : [ ], "alias" : "os-vol-tenant-attr", "description" : "Expose the internal project_id as an attribute of a volume." } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-extend 是 CinderResizeVolumeOption object 标记扩容云硬盘操作 表4 CinderResizeVolumeOption 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后的云硬盘大小，单位为GiB。 扩容后的云硬盘容量范围：大于原有云硬盘容量~云硬盘最大容量（数据盘为32768GiB；系统盘为1024GiB）

状态码 正常 错误码状态 描述 200 OK 201 Created 202 Accepted 204 No Content 异常 错误码状态 描述 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Timeout 409 Conflict 413 overLimit 415 badMediaType 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout 父主题： 附录

URI DELETE /v2/{project_id}/volumes/{volume_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 volume_id 是 String 云硬盘ID 表2 Query参数 参数 是否必选 参数类型 描述 cascade 否 Boolean 删除云硬盘关联的所有快照，默认值为false。 缺省值：false

响应示例 状态码： 200 OK { "volumes" : [ { "id" : "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "2bce4552-9a7d-48fa-8484-abbbf64b206e", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", "rel" : "bookmark" } ], "name" : "zjb_u25_test" }, { "id" : "3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "bookmark" } ], "name" : "zjb_u25_test" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3", "rel" : "next" } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 volumes Array of VolumeBody objects 查询请求返回的云硬盘列表。 volumes_links Array of Link objects 云硬盘列表查询位置标记。如果本次查询只返回部分列表信息时，会返回查询到的当前云硬盘mark标记的url，可以继续使用这个url查询剩余列表信息。 表5 VolumeBody 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 name String 云硬盘名称。 表6 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表8 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

URI GET /v3/{project_id}/volumes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页查询的起始资源id，取值为上一页最后一条查询记录的资源id。 name 否 String 云硬盘名称。最大支持64个字符。 limit 否 Integer 返回结果个数限制。 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 当租户所有的云硬盘数量大于50个时，为了提升您的查询效率，建议查询的时候使用limit参数，并且参数值最大设置为50。查询示例： GET /v2/xxx/volumes?limit=50，表示查询第1~50个云硬盘。GET /v2/xxx/volumes?offset=50&limit=50，表示查询第51~100个云硬盘。 sort_dir 否 String 返回结果按照降序或升序排列，默认为“desc”。 降序：desc 升序：asc sort_key 否 String 返回结果按该关键字排序，支持id，status，size，created_at等关键字，默认为“created_at”。 offset 否 Integer 偏移量 偏移量为一个大于0小于磁盘总个数的整数，表示查询该偏移量后面的所有的云硬盘。 status 否 String 云硬盘状态，具体请参见云硬盘状态。 metadata 否 String 云硬盘元数据。 availability_zone 否 String AZ信息。

云硬盘快照状态 云硬盘快照状态 说明 creating 云硬盘快照处于正在创建的过程中。 available 云硬盘快照创建成功，可以使用。 error 云硬盘快照在创建过程中出现错误。 deleting 云硬盘快照处于正在删除的过程中。 error_deleting 云硬盘快照在删除过程中出现错误 rollbacking 云硬盘快照处于正在回滚数据的过程中。 说明： 只支持快照回滚到源云硬盘，不支持快照回滚到其它指定云硬盘。 只有当云硬盘的状态处于“可用”或“回滚数据失败”状态才允许快照回滚到源云硬盘。 backing-up 通过OpenStack原生API，可以直接通过快照创建备份，快照状态就会变为backing-up。 通过API对磁盘创建备份过程中，系统会自动创建快照，该快照状态为backing-up。 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 extensions Array of Extension objects 扩展接口列表。 表4 Extension 参数 参数类型 描述 alias String 扩展的别名。 description String 描述 links Array of Link objects 云硬盘传递的链接 name String 云硬盘传递的名称。 updated String 最后的更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.+XX.XX，其中+XX.XX表示时区。 表5 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 200 OK { "extensions" : [ { "updated" : "2013-04-18T00:00:00+00:00", "name" : "SchedulerHints", "links" : [ ], "alias" : "OS-SCH-HNT", "description" : "Pass arbitrary key/value pairs to the scheduler." }, { "updated" : "2011-06-29T00:00:00+00:00", "name" : "Hosts", "links" : [ ], "alias" : "os-hosts", "description" : "Admin-only host administration." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeTenantAttribute", "links" : [ ], "alias" : "os-vol-tenant-attr", "description" : "Expose the internal project_id as an attribute of a volume." }, { "updated" : "2011-08-08T00:00:00+00:00", "name" : "Quotas", "links" : [ ], "alias" : "os-quota-sets", "description" : "Quota management support." }, { "updated" : "2011-08-24T00:00:00+00:00", "name" : "TypesManage", "links" : [ ], "alias" : "os-types-manage", "description" : "Types manage support." }, { "updated" : "2013-07-10T00:00:00+00:00", "name" : "VolumeEncryptionMetadata", "links" : [ ], "alias" : "os-volume-encryption-metadata", "description" : "Volume encryption metadata retrieval support." }, { "updated" : "2012-12-12T00:00:00+00:00", "name" : "Backups", "links" : [ ], "alias" : "backups", "description" : "Backups support." }, { "updated" : "2013-07-16T00:00:00+00:00", "name" : "SnapshotActions", "links" : [ ], "alias" : "os-snapshot-actions", "description" : "Enable snapshot manager actions." }, { "updated" : "2012-05-31T00:00:00+00:00", "name" : "VolumeActions", "links" : [ ], "alias" : "os-volume-actions", "description" : "Enable volume actions" }, { "updated" : "2013-10-03T00:00:00+00:00", "name" : "UsedLimits", "links" : [ ], "alias" : "os-used-limits", "description" : "Provide data on limited resources that are being used." }, { "updated" : "2012-05-31T00:00:00+00:00", "name" : "VolumeUnmanage", "links" : [ ], "alias" : "os-volume-unmanage", "description" : "Enable volume unmanage operation." }, { "updated" : "2011-11-03T00:00:00+00:00", "name" : "VolumeHostAttribute", "links" : [ ], "alias" : "os-vol-host-attr", "description" : "Expose host as an attribute of a volume." }, { "updated" : "2013-07-01T00:00:00+00:00", "name" : "VolumeTypeEncryption", "links" : [ ], "alias" : "encryption", "description" : "Encryption support for volume types." }, { "updated" : "2013-06-27T00:00:00+00:00", "name" : "AvailabilityZones", "links" : [ ], "alias" : "os-availability-zone", "description" : "Describe Availability Zones." }, { "updated" : "2013-08-02T00:00:00+00:00", "name" : "Qos_specs_manage", "links" : [ ], "alias" : "qos-specs", "description" : "QoS specs support." }, { "updated" : "2011-08-24T00:00:00+00:00", "name" : "TypesExtraSpecs", "links" : [ ], "alias" : "os-types-extra-specs", "description" : "Type extra specs support." }, { "updated" : "2013-08-08T00:00:00+00:00", "name" : "VolumeMigStatusAttribute", "links" : [ ], "alias" : "os-vol-mig-status-attr", "description" : "Expose migration_status as an attribute of a volume." }, { "updated" : "2012-08-13T00:00:00+00:00", "name" : "CreateVolumeExtension", "links" : [ ], "alias" : "os-image-create", "description" : "Allow creating a volume from an image in the Create Volume v1 API." }, { "updated" : "2014-01-10T00:00:00-00:00", "name" : "ExtendedServices", "links" : [ ], "alias" : "os-extended-services", "description" : "Extended services support." }, { "updated" : "2012-06-19T00:00:00+00:00", "name" : "ExtendedSnapshotAttributes", "links" : [ ], "alias" : "os-extended-snapshot-attributes", "description" : "Extended SnapshotAttributes support." }, { "updated" : "2012-12-07T00:00:00+00:00", "name" : "VolumeImageMetadata", "links" : [ ], "alias" : "os-vol-image-meta", "description" : "Show image metadata associated with the volume." }, { "updated" : "2012-03-12T00:00:00+00:00", "name" : "QuotaClasses", "links" : [ ], "alias" : "os-quota-class-sets", "description" : "Quota classes management support." }, { "updated" : "2013-05-29T00:00:00+00:00", "name" : "VolumeTransfer", "links" : [ ], "alias" : "os-volume-transfer", "description" : "Volume transfer management support." }, { "updated" : "2014-02-10T00:00:00+00:00", "name" : "VolumeManage", "links" : [ ], "alias" : "os-volume-manage", "description" : "Allows existing backend storage to be 'managed' by Cinder." }, { "updated" : "2012-08-25T00:00:00+00:00", "name" : "AdminActions", "links" : [ ], "alias" : "os-admin-actions", "description" : "Enable admin actions." }, { "updated" : "2012-10-28T00:00:00-00:00", "name" : "Services", "links" : [ ], "alias" : "os-services", "description" : "Services support." } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-update_readonly_flag 是 CinderUpdateVolumeReadonlyOption object 标记设置云硬盘只读标识操作。 表4 CinderUpdateVolumeReadonlyOption 参数 是否必选 参数类型 描述 readonly 是 Boolean 是否只读标识。 true：表示只读。 false：表示非只读。 缺省值：true

响应示例 状态码： 200 OK { "volume" : { "attachments" : [ ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "db-rabbitmq201#LVM_iSCSI", "encrypted" : false, "id" : "da4f9c7a-c275-4bc9-80c4-76c7d479a218", "size" : 1, "os-vol-tenant-attr:tenant_id" : "3dab0aaf682849678a94ec7b5a3af2ce", "metadata" : { }, "status" : "available", "display_name" : "test", "bootable" : "false", "created_at" : "2014-12-18T17:14:38.000000", "volume_type" : "SATA", "multiattach" : false } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 volume CinderVolumeDetail object 查询请求返回的云硬盘。 表3 CinderVolumeDetail 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘uri自描述信息。 name String 云硬盘名称。 status String 云硬盘状态，具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 是否挂载信息。 availability_zone String 云硬盘所属AZ。 source_volid String 源云硬盘ID，如果是从源云硬盘创建，则有值。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID，如果是从快照创建，则有值。 description String 云硬盘描述。 bootable String 是否为启动云硬盘。 true：表示为启动云硬盘。 false：表示为非启动云硬盘。 created_at String 云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX volume_type String 云硬盘类型。 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2"，"ESSD2"七种。 "SATA"为普通IO云硬盘(已售罄) "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 "ESSD"为极速IO云硬盘 "GPSSD2"为通用型SSD V2云硬盘 "ESSD2"为极速型SSD V2云硬盘 metadata VolumeMetadata object 云硬盘的元数据。 如果元数据中不包含hw:passthrough字段，云硬盘默认为VBD类型。 如果元数据中不包含__system__encrypted字段，云硬盘默认为不加密。 size Integer 云硬盘大小，单位为GiB。 shareable Boolean 是否为可共享云硬盘。 说明： 该字段已经废弃，请使用multiattach。 multiattach Boolean 是否为可共享云硬盘。 os-vol-tenant-attr:tenant_id String 云硬盘所属的租户ID。租户ID就是项目ID。 volume_image_metadata Object 云硬盘镜像的元数据。 关于“volume_image_metadata”字段的详细说明，具体请参见："查询镜像详情"。 os-vol-host-attr:host String 预留属性。 os-volume-replication:extended_status String 预留属性。 consistencygroup_id String 预留属性。 iops iops object 云硬盘的iops信息，云硬盘类型是ESSD2、GPSSD2才返回。 throughput throughput object 云硬盘的吞吐量信息，云硬盘类型是GPSSD2才返回。 updated_at String 云硬盘更新时间。 replication_status String 预留属性。 user_id String 预留属性。 encrypted Boolean 预留属性。 表4 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 表5 VolumeAttachment 参数 参数类型 描述 attached_at String 挂载的时间信息。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX attachment_id String 挂载信息对应的ID。 device String 挂载点 host_name String 云硬盘挂载到的云服务器云主机对应 的物理主机的名称。 id String 挂载的资源ID server_id String 云硬盘挂载到的云服务器云主机的 ID。 volume_id String 云硬盘ID 表6 VolumeMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 说明： 请参考 查询密钥列表，通过HTTPS请求获取密钥ID。 __system__encrypted String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。 full_clone String 从快照创建云硬盘时，如需使用link克隆方式，请指定该字段的值为0。 hw:passthrough String true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。 表7 iops 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值：false id String 云硬盘iops标识。 total_val Integer iops大小。 volume_id String 云硬盘ID。 表8 throughput 参数 参数类型 描述 frozened Boolean 冻结标签。 缺省值：false id String 云硬盘吞吐量标识。 total_val Integer 吞吐量大小。 volume_id String 云盘ID。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表10 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。