华为云用户手册

响应参数 状态码： 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

请求参数 表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。通过查询所有云硬盘详情获取。

响应参数 状态码： 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" } }

响应示例 状态码： 200 OK { "availabilityZoneInfo" : [ { "zoneState" : { "available" : true }, "zoneName" : "az-dc-1" } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 availabilityZoneInfo Array of AzInfo objects 查询请求返回的可用分区列表。 表4 AzInfo 参数 参数类型 描述 zoneName String 可用分区的名字。 zoneState ZoneState object 可用分区的状态。 表5 ZoneState 参数 参数类型 描述 available Boolean 可用分区是否可用。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

响应示例 状态码： 200 OK { "transfers" : [ { "id" : "cac5c677-73a9-4288-bb9c-b2ebfb547377", "name" : "first volume transfer", "volume_id" : "894623a6-e901-4312-aa06-4275e6321cce", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/1", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/1", "rel" : "bookmark" } ] }, { "id" : "f26c0dee-d20d-4e80-8dee-a8d91b9742a1", "name" : "second volume transfer", "volume_id" : "673db275-379f-41af-8371-e1652132b4c1", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/2", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/2", "rel" : "bookmark" } ] } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 transfers Array of VolumeTransferSummary objects 云硬盘过户记录列表概要。 表5 VolumeTransferSummary 参数 参数类型 描述 id String 云硬盘过户记录的ID。 links Array of Link objects 云硬盘过户记录的链接 name String 云硬盘过户记录的名称 volume_id String 云硬盘ID。 表6 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值：next 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表8 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

URI GET /v3/{project_id}/os-volume-transfer 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 返回结果个数限制，取值为大 于0的整数 offset 否 Integer 偏移量，偏移量为一个大于0小 于云硬盘过户记录总个数的整 数，表示查询该偏移量后面的 所有的云硬盘过户记录

响应示例 状态码： 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", "replication_status" : "disabled", "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "metadata" : { }, "tags" : { "key1" : "value1", "key2" : "value2" }, "status" : "available", "description" : "auto-created_from_restore_from_backup", "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 volume DiskDetail object 云硬盘详情。 表4 DiskDetail 参数 参数类型 描述 attachments Array of DiskAttachment objects 云硬盘的挂载信息。 availability_zone String 云硬盘所属的AZ信息。 bootable String 是否为可启动云硬盘。 consistencygroup_id String 所属一致性组ID。 count String 已查询出的云硬盘列表中云硬盘的 数量 created_at String 云硬盘创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX dedicated_storage_id String 云硬盘所属的专属存储池ID dedicated_storage_name String 云硬盘所属的专属存储池的名称 description String 云硬盘描述。 encrypted Boolean 是否为加密云硬盘。 enterprise_project_id String 云硬盘上绑定的企业项目ID。 当前云硬盘服务不支持该字段 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 metadata DiskMetadata object 元数据。 multiattach Boolean 创建共享云硬盘的信息 name String 云硬盘名称。 os-vendor-extended:lock_check_endpoint String 检查锁是否有效的回调链接 os-vendor-extended:lock_scene String 云硬盘的加锁类型 os-vendor-extended:lock_source_id String 云硬盘的锁归属的资源ID os-vendor-extended:lock_source_service String 云硬盘的锁归属的服务类型 os-vol-host-attr:host String 云硬盘所在的主机 os-vol-mig-status-attr:migstat String 预留属性 os-vol-mig-status-attr:name_id String 预留属性 os-vol-tenant-attr:tenant_id String 云硬盘所属的租户ID os-volume-replication:driver_data String 预留属性 os-volume-replication:extended_status String 预留属性 replication_status String 预留属性 service_type String 服务类型，结果为EVS、DSS、 DESS。 shareable String 是否为可共享云硬盘。 size Integer 云硬盘大小。 snapshot_id String 快照ID。 source_volid String 源云硬盘ID。 status String 云硬盘状态，请参见 云硬盘状态。 tags Object 云硬盘的标签。 如果云硬盘有标签，则会有该字段，否则该字段为空。 updated_at String 云硬盘更新时间。 user_id String 预留属性 volume_image_metadata Object 如果云硬盘是从镜像创建的则会有该字段，否则该字段为空。 说明： 关于“volume_image_metadata”字段的详细说明，具体请参见查询镜像详情。 volume_type String 云硬盘类型。 目前支持"SATA"，"SAS"，"GPSSD"和"SSD"四种。 "SATA"为普通IO云硬盘 "SAS"为高IO云硬盘 "GPSSD"为通用型SSD云硬盘 "SSD"为超高IO云硬盘 wwn String 云硬盘挂载时的唯一标识 表5 DiskAttachment 参数 参数类型 描述 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 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 表7 DiskMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 __system__encrypted String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。 full_clone String 从快照创建云硬盘时，字段的值为0表示使用link克隆方式。 hw:passthrough String metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 表9 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

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

响应示例 状态码： 200 OK { "transfers" : [ { "id" : "cac5c677-73a9-4288-bb9c-b2ebfb547377", "created_at" : "2015-02-25T03:56:53.081642", "name" : "first volume transfer", "volume_id" : "894623a6-e901-4312-aa06-4275e6321cce", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/1", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/1", "rel" : "bookmark" } ] }, { "id" : "f26c0dee-d20d-4e80-8dee-a8d91b9742a1", "created_at" : "2015-03-25T03:56:53.081642", "name" : "second volume transfer", "volume_id" : "673db275-379f-41af-8371-e1652132b4c1", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/2", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/2", "rel" : "bookmark" } ] } ] } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

URI GET /v2/{project_id}/os-volume-transfer/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 返回结果个数限制。 最小值1，最大值1000，默认为1000。返回的结果中记录数不超过limit值。 offset 否 Integer 偏移量，偏移量为一个大于0小于云硬盘过户记录总个数的整数，表示查询该偏移量后面的所有的云硬盘过户记录。

响应示例 状态码： 200 OK { "id" : "36ba39af-3579-4e6e-adfc-b764349c0f77", "links" : [ { "href" : "https://volume.region.xxx.xxx-tsi.de/v2/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77", "rel" : "self" }, { "href" : "https://volume.region.xxx.xxx-tsi.de/3cfb09080bd944d0b4cdd72ef26857bd/volumes/36ba39af-3579-4e6e-adfc-b764349c0f77", "rel" : "bookmark" } ], "name" : "newVolume", "status" : "in-use", "attachments" : [ { "server_id" : "c3d3250c-7ce5-42cc-b620-dd2b63d19ca5", "attachment_id" : "011a2bdb-a033-4479-845b-50bd8ed7f4d4", "attached_at" : "2017-05-23T11:27:38.604815", "volume_id" : "36ba39af-3579-4e6e-adfc-b764349c0f77", "device" : "/dev/sdf", "id" : "36ba39af-3579-4e6e-adfc-b764349c0f77" } ], "description" : "new volume", "multiattach" : false, "shareable" : false, "size" : 10, "metadata" : { "hw:passthrough" : "false" }, "bootable" : "false", "availability_zone" : "az-dc-1", "created_at" : "2017-05-23T09:49:44.481299", "volume_type" : "SATA" } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 attachments Array of Attachment objects 是否挂载信息。 availability_zone String 云硬盘所属AZ。 bootable String 是否为可启动云硬盘。 created_at String 创建云硬盘的时间。 id String 云硬盘ID。 links Array of Link objects 云硬盘uri自描述信息 metadata VolumeMetadata object 云硬盘的元数据。 multiattach Boolean 是否为可共享云硬盘。 name String 云硬盘名称 os-vol-host-attr:host String 预留属性。 os-vol-tenant-attr:tenant_id String 云硬盘所属的项目ID。 shareable String 是否为共享云硬盘。 size Integer 云硬盘大小。 snapshot_id String 快照ID。 source_volid String 预留字段。 status String 云硬盘状态。 volume_image_metadata Object 云硬盘镜像的元数据。 说明： 关于“volume_image_metadata”字段的详细说明，具体请参见："查询镜像详情"。 volume_type String 云硬盘类型。 description String 云硬盘描述。 os-volume-replication:extended_status String 预留属性。 表6 Attachment 参数 参数类型 描述 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 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 表8 VolumeMetadata 参数 参数类型 描述 __system__cmkid String metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。 请求获取密钥ID的方法请参考："查询密钥列表"。 __system__encrypted String metadata中的表示加密功能的字段，0代表不加密，1代表加密。 不指定该字段时，云硬盘的加密属性与数据源保持一致，如果不是从数据源创建的场景，则默认不加密。 full_clone String 从快照创建云硬盘时的创建方式。 0表示使用链接克隆方式。 1表示使用全量克隆方式。 hw:passthrough String true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD (虚拟块存储设备 , Virtual Block Device)类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型。 orderID String metadata中的表示云硬盘计费类型的字段。 当该字段有值时，表示该云硬盘的计费类型为包周期计费，否则计费类型为按需计费。 状态码： 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参数 参数 是否必选 参数类型 描述 volume 是 UpdateVolumeOption object 待修改的云硬盘信息 表4 UpdateVolumeOption 参数 是否必选 参数类型 描述 description 否 String 新的云硬盘的描述，name和description不能同时为null。最大支持85个字符。 name 否 String 新的云硬盘的名字，name和description不能同时为null。最大支持64个字符。

响应示例 状态码： 200 OK { "transfer" : { "id" : "cac5c677-73a9-4288-bb9c-b2ebfb547377", "created_at" : "2015-02-25T03:56:53.081642", "name" : "first volume transfer", "volume_id" : "894623a6-e901-4312-aa06-4275e6321cce", "links" : [ { "href" : "https://localhost/v2/firstproject/os-volume-transfer/1", "rel" : "self" }, { "href" : "https://localhost/firstproject/os-volume-transfer/1", "rel" : "bookmark" } ] } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-attach 是 CinderAttachVolumeOption object 标记挂载云硬盘操作 表4 CinderAttachVolumeOption 参数 是否必选 参数类型 描述 host_name 否 String 挂载的主机名。最大支持64个字符。 instance_uuid 是 String 挂载的主机uuid。 mode 否 String 挂载模式，只支持可读可写rw模式和只读ro模式。 mountpoint 是 String 挂载点。

响应示例 状态码： 200 OK { "quota_set" : { "gigabytes_SAS" : { "reserved" : 0, "limit" : -1, "in_use" : 21 }, "volumes_SATA" : { "reserved" : 0, "limit" : -1, "in_use" : 8 }, "gigabytes" : { "reserved" : 0, "limit" : 42790, "in_use" : 2792 }, "backup_gigabytes" : { "reserved" : 0, "limit" : 5120, "in_use" : 51 }, "snapshots_SAS" : { "reserved" : 0, "limit" : -1, "in_use" : 0 }, "volumes_SSD" : { "reserved" : 0, "limit" : -1, "in_use" : 28 }, "snapshots" : { "reserved" : 0, "limit" : 10, "in_use" : 6 }, "id" : "cd631140887d4b6e9c786b67a6dd4c02", "volumes_SAS" : { "reserved" : 0, "limit" : -1, "in_use" : 2 }, "snapshots_SSD" : { "reserved" : 0, "limit" : -1, "in_use" : 0 }, "volumes" : { "reserved" : 0, "limit" : -1, "in_use" : 108 }, "gigabytes_SATA" : { "reserved" : 0, "limit" : -1, "in_use" : 168 }, "backups" : { "reserved" : 0, "limit" : 100, "in_use" : 10 }, "gigabytes_SSD" : { "reserved" : 0, "limit" : -1, "in_use" : 1085 }, "snapshots_SATA" : { "reserved" : 0, "limit" : -1, "in_use" : 0 } } } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quota_set QuotaList object 查询请求返回的配额信息。 表5 QuotaList 参数 参数类型 描述 backup_gigabytes QuotaDetailBackupGigabytes object 备份容量，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 backups QuotaDetailBackups object 备份个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 gigabytes QuotaDetailGigabytes object 总容量，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 id String 项目ID。 snapshots QuotaDetailSnapshots object 快照个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 volumes QuotaDetailVolumes object 云硬盘个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 gigabytes_SATA QuotaDetailGigabytesSATA object SATA云硬盘类型预留的容量大小，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 snapshots_SATA QuotaDetailSnapshotsSATA object SATA云硬盘类型预留快照个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 volumes_SATA QuotaDetailVolumesSATA object SATA云硬盘类型预留的云硬盘个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 gigabytes_SAS QuotaDetailGigabytesSAS object SAS类型云硬盘预留的size大小，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 snapshots_SAS QuotaDetailSnapshotsSAS object SAS类型云硬盘预留快照个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 volumes_SAS QuotaDetailVolumesSAS object SAS类型云硬盘预留的云硬盘个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 gigabytes_SSD QuotaDetailGigabytesSSD object SSD类型云硬盘预留的size大小，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 snapshots_SSD QuotaDetailSnapshotsSSD object SSD类型云硬盘预留快照个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 volumes_SSD QuotaDetailVolumesSSD object SSD类型云硬盘预留的云硬盘个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 gigabytes_GPSSD QuotaDetailGigabytesGPSSD object GPSSD类型云硬盘预留的size大小，单位为GiB，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 snapshots_GPSSD QuotaDetailSnapshotsGPSSD object GPSSD类型云硬盘预留快照个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 volumes_GPSSD QuotaDetailVolumesGPSSD object GPSSD类型云硬盘预留的云硬盘个数，键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 per_volume_gigabytes QuotaDetailPerVolumeGigabytes object 每个云硬盘的容量配额限制。键值对，包含：reserved（预留）、limit（最大）和in_use（已使用）。 表6 QuotaDetailBackupGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表7 QuotaDetailBackups 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表8 QuotaDetailGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表9 QuotaDetailSnapshots 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表10 QuotaDetailVolumes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表11 QuotaDetailGigabytesSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表12 QuotaDetailSnapshotsSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表13 QuotaDetailVolumesSATA 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表14 QuotaDetailGigabytesSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表15 QuotaDetailSnapshotsSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表16 QuotaDetailVolumesSAS 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表17 QuotaDetailGigabytesSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表18 QuotaDetailSnapshotsSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表19 QuotaDetailVolumesSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表20 QuotaDetailGigabytesGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表21 QuotaDetailSnapshotsGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表22 QuotaDetailVolumesGPSSD 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 表23 QuotaDetailPerVolumeGigabytes 参数 参数类型 描述 in_use Integer 已使用的数量。 limit Integer 最大的数量。 reserved Integer 预留属性。 状态码： 400 表24 响应Body参数 参数 参数类型 描述 error Error object 出现错误时，返回的错误信息。 表25 Error 参数 参数类型 描述 code String 出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时，返回的错误消息。

URI GET /v2/{project_id}/os-quota-sets/{target_project_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 target_project_id 是 String 目标的项目ID。与project_id保持一致即可。 表2 Query参数 参数 是否必选 参数类型 描述 usage 是 String 是否查询配额详细信息。当前只支持传True。 枚举值： True

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 qos_modify 是 ModifyVolumeQoSOption object 标记修改云硬盘QoS操作。 表4 ModifyVolumeQoSOption 参数 是否必选 参数类型 描述 iops 是 Integer 修改后的云硬盘iops，只支持GPSSD2、ESSD2类型的云硬盘。 说明： 了解GPSSD2、ESSD2类型的iops大小范围，请参见 云硬盘类型及性能介绍里面的云硬盘性能数据表。 throughput 否 Integer 修改后的云硬盘吞吐量，单位是MiB/s，GPSSD2类型云盘必须填写，其他类型不能填写。 说明： 了解GPSSD2类型的吞吐量大小范围，请参见 云硬盘类型及性能介绍里面的云硬盘性能数据表。

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

响应示例 状态码： 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 /v2/{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信息。

响应示例 状态码： 200 OK { "status" : "RUNNING", "entities" : { "volume_id" : "bdf1bb37-f20f-4266-9a04-f43e0a127376" }, "job_id" : "4010a32d535527910153552b492c0002", "job_type" : "createVolume", "begin_time" : "2016-03-08T07:40:13.219Z", "end_time" : "" } 状态码： 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }