华为云用户手册

请求示例 创建一个云硬盘快照，当源云硬盘处于挂载状态时，不能强制创建快照。 POST https://{endpoint}/v2/{project_id}/snapshots { "snapshot" : { "name" : "snap-001", "description" : "Daily backup", "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "force" : false, "metadata" : { } } }

响应示例 状态码： 202 Accepted { "snapshot" : { "status" : "creating", "description" : "Daily backup", "created_at" : "2013-02-25T03:56:53.081642", "metadata" : { }, "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "size" : 1, "id" : "ffa9bc5e-1172-4021-acaf-cdcd78a9584d", "name" : "snap-001", "updated_at" : "2013-02-25T03:56:53.081642" } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 正常返回时返回的任务ID。 说明： 如果需要查询job的状态，请参考查询job的状态。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表7 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-extend 是 ResizeDiskOption object 标记扩容云硬盘操作 表4 ResizeDiskOption 参数 是否必选 参数类型 描述 new_size 是 Integer 扩容后的云硬盘容量，单位为GiB。扩容后的容量不能小于原有云硬盘容量，且不能大于云硬盘最大容量。 云硬盘最大容量： 数据盘：32768GiB 系统盘：1024GiB

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 metadata 是 Metadata object 需要更新的元数据信息，请参见metadata参数说明。 metadata中的key和value长度不大于255个字节。 表4 Metadata 参数 是否必选 参数类型 描述 __system__encrypted 否 String metadata中的表示加密功能的字段。 0代表不加密。 1代表加密。 该字段不存在时，云硬盘默认为不加密 __system__cmkid 否 String metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 hw:passthrough 否 String metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型 full_clone 否 String 从快照创建云硬盘时，字段的值为0表示使用link克隆方式

请求示例 POST https://{endpoint}/v3/{project_id}/volumes/{volume_id}/action { "os-volume_upload_image" : { "image_name" : "sxmatch2", "force" : true, "container_format" : "bare", "disk_format" : "vhd", "__os_type" : "linux" } }

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 os-volume_upload_image Image object 标记将云硬盘导出为镜像的操作。 表6 Image 参数 参数类型 描述 container_format String 云硬盘导出镜像的容器类型。 目前支持ami、ari、aki、ovf、bare。默认是bare。 disk_format String 云硬盘导出镜像的格式。 目前支持vhd、zvhd、zvhd2、raw、qcow2。默认是vhd。 display_description String 云硬盘描述信息。 id String 云硬盘ID。 image_id String 云硬盘导出镜像的ID。 image_name String 云硬盘导出镜像的名称 size Integer 云硬盘容量。 status String 云硬盘导出镜像后的状态，正常值为 “uploading”。 updated_at String 云硬盘更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX volume_type VolumeType object 云硬盘类型的信息。 表7 VolumeType 参数 参数类型 描述 id String 云硬盘类型的ID。 name String 云硬盘类型名称。 extra_specs VolumeTypeExtraSpecs object 云硬盘类型的规格。 description String 云硬盘类型的描述信息。 qos_specs_id String 预留属性。 is_public Boolean 预留属性。 表8 VolumeTypeExtraSpecs 参数 参数类型 描述 RESKEY:availability_zones String 支持当前云硬盘类型的可用区列表，列表的元素以逗号分隔。 若没有该参数，则表示当前云硬盘类型支持所有可用区。 availability-zone String 预留属性。 os-vendor-extended:sold_out_availability_zones String 当前云硬盘类型已售罄的可用区列表，列表的元素以逗号分隔。 volume_backend_name String 预留属性。 HW:availability_zone String 预留属性。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表10 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-volume_upload_image 是 CinderExportToImageOption object 标记将云硬盘导出为镜像的操作。 表4 CinderExportToImageOption 参数 是否必选 参数类型 描述 container_format 否 String 云硬盘导出镜像的容器类型。 目前支持ami、ari、aki、ovf、bare。默认是bare。 缺省值：bare 枚举值： ami ari aki ovf bare disk_format 否 String 云硬盘导出镜像的格式。 目前支持vhd、zvhd、zvhd2、raw、qcow2。默认是vhd。 缺省值：vhd 枚举值： vhd zvhd zvhd2 raw qcow2 force 否 Boolean 强制导出镜像的标示，默认值是false。 当force标记为false时，云硬盘处于正在使用状态时，不能强制导出镜像。 当force标记为true时，即使云硬盘处于正在使用状态时，仍可以导出镜像。 image_name 是 String 云硬盘导出镜像的名称。 名称的长度范围为1～128位。 名称只能包含以下字符：大写字母、小写字母、中文、数字、特殊字符包含“-”、“.”、“_”和空格。 __os_type 否 String 云硬盘导出镜像的系统类型。目前只支持“windows”和“linux”，默认值是“linux”。说明：只有云硬盘的volume_image_metadata信息中无“__os_type”字段且云硬盘状态为“available”时，设置的__os_type才会生效。如果不传递该参数，则使用默认的“linux”值作为镜像的系统类型。 缺省值：linux 枚举值： windows linux

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 云硬盘（EVS）的支持自定义策略授权项如下所示： API版本信息查询，包含API版本信息查询接口对应的授权项，如查询接口版本信息。 云硬盘，包括云硬盘接口对应的授权项，如创建云硬盘、查询云硬盘列表、删除云硬盘、更新云硬盘等接口。 云硬盘Actions，包含云硬盘Actions接口对应的授权项，如扩容云硬盘、将云硬盘导出为镜像、设置云硬盘只读标示等接口。 云硬盘快照，包含云硬盘快照接口对应的授权项，如创建云硬盘快照、查询云硬盘快照列表、更新云硬盘快照、删除云硬盘快照等接口。 云硬盘标签，包含云硬盘标签接口对应的授权项，如通过键删除云硬盘标签、为指定云硬盘批量添加标签、为指定云硬盘批量删除标签、查询云硬盘标签接口。 云硬盘过户，包含云硬盘过户接口对应的授权项，如创建云硬盘过户、查询云硬盘过户记录列表概要、接受云硬盘过户、删除云硬盘过户等接口。

云硬盘过户 本章节仅列出了云硬盘v2接口的授权信息。对于v3接口，如果提供的功能与v2接口一样，则授权信息也一致。 例如：创建云硬盘时，v2接口为POST /v2/{project_id}/cloudvolumes，对应的v3接口为POST /v3/{project_id}/cloudvolumes，两个接口支持的授权信息一致。 授权项列表中，“√”表示支持，“×”表示暂不支持。 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 创建云硬盘过户（OpenStack Cinder） POST /v2/{project_id}/os-volume-transfer evs:transfers:create √ × 查询云硬盘过户记录列表概要（OpenStack Cinder） GET /v2/{project_id}/os-volume-transfer evs:transfers:list √ × 查询云硬盘过户记录列表详情（OpenStack Cinder） GET /v2/{project_id}/os-volume-transfer/detail evs:transfers:list √ × 查询单个云硬盘过户记录详情（OpenStack Cinder） GET /v2/{project_id}/os-volume-transfer/{transfer_id} evs:transfers:get √ × 接受云硬盘过户（OpenStack Cinder） POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept evs:transfers:accept √ × 删除云硬盘过户（OpenStack Cinder） DELETE /v2/{project_id}/os-volume-transfer/{transfer_id} evs:transfers:delete √ × 父主题： 权限和授权项

响应示例 状态码： 200 标签列表。 { "tags" : [ { "value" : "value1", "key" : "key1" }, { "value" : "value2", "key" : "key2" } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 标签列表。 表4 Tag 参数 参数类型 描述 key String 标签键。同一资源的key值不能重复。 最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 标签值。 最大长度43个字符。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表6 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

请求示例 创建一个云硬盘过户，云硬盘id为c86b9af4-151d-4ead-b62c-5fb967af0e37，云硬盘过户记录的名称为first volume。 POST https://{endpoint}/v2/{project_id}/os-volume-transfer { "transfer" : { "volume_id" : "c86b9af4-151d-4ead-b62c-5fb967af0e37", "name" : "first volume" } }

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 transfer CreateVolumeTransferDetail object 云硬盘过户信息。 表6 CreateVolumeTransferDetail 参数 参数类型 描述 auth_key String 云硬盘过户的身份认证密钥。 created_at String 云硬盘过户记录的创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX id String 云硬盘过户记录的ID。 links Array of Link objects 云硬盘过户记录的链接。 name String 云硬盘过户记录的名称。 volume_id String 云硬盘ID。 表7 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表9 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 202 Accepted { "transfer" : { "id" : "1a7059f5-8ed7-45b7-8d05-2811e5d09f24", "created_at" : "2015-02-25T03:56:53.081642", "name" : "first volume", "volume_id" : "c86b9af4-151d-4ead-b62c-5fb967af0e37", "auth_key" : "9266c59563c84664", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/3", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/3", "rel" : "bookmark" } ] } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 transfer 是 CreateVolumeTransferOption object 标记创建云硬盘过户操作 表4 CreateVolumeTransferOption 参数 是否必选 参数类型 描述 name 是 String 云硬盘过户记录的名称。最大支持64个字符。 volume_id 是 String 云硬盘ID。通过查询所有云硬盘详情获取。

请求示例 回滚快照到云硬盘，目标云硬盘的名称为test-001，UUID为5aa119a8-d25b-45a7-8d1b-88e127885635。 POST https://{endpoint}/v2/{project_id}/cloudsnapshots/{snapshot_id}/rollback { "rollback" : { "name" : "test-001", "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635" } }

响应参数 状态码： 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 版本号详情列表。 { "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" } }

响应参数 状态码： 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 出现错误时，返回的错误消息。

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 出现错误时，返回的错误消息。

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

响应参数 状态码： 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 出现错误时，返回的错误消息。

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

请求参数 表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