华为云用户手册

  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 volume CreateVolumeDetail object 待创建的云硬盘信息。 表6 CreateVolumeDetail 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 name String 云硬盘名称。 status String 云硬盘状态,具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 挂载信息。 availability_zone String 云硬盘所属AZ。 bootable String 是否为启动云硬盘。 true:表示为启动云硬盘。 false:表示为非启动云硬盘。 encrypted Boolean 当前云硬盘服务不支持该字段。 created_at String 创建云硬盘的时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX description String 云硬盘描述。 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云硬盘 当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。 replication_status String 预留属性。 consistencygroup_id String 所属一致性组ID。 source_volid String 源云硬盘ID。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID。 metadata VolumeMetadata object 元数据。 size Integer 云硬盘大小,单位为GiB。 user_id String 使用云硬盘用户ID。 updated_at String 云硬盘更新时间。 shareable Boolean 是否为可共享云硬盘。 说明: 该字段已经废弃,请使用multiattach。 multiattach Boolean 是否为共享云硬盘。 true:表示为共享云硬盘。 false:表示为非共享云硬盘。 storage_cluster_id String 预留属性。 表7 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 表8 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 表9 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类型。 状态码: 400 表10 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表11 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 snapshot 是 CinderUpdateSnapshotOption object 待更新的快照信息。 表4 CinderUpdateSnapshotOption 参数 是否必选 参数类型 描述 name 否 String 云硬盘快照名称。最大支持64个字符。 说明: 对云硬盘创建备份时,同时会创建以autobk_snapshot_为名称前缀的快照, 云硬盘控制台对此类快照会有操作限制。因此建议不要创建以 autobk_snapshot_为名称前缀的快照,避免影响快照的正常使用。 description 否 String 云硬盘快照描述。最大支持85个字符。
  • 响应示例 状态码: 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参数 参数 是否必选 参数类型 描述 os-update_readonly_flag 是 CinderUpdateVolumeReadonlyOption object 标记设置云硬盘只读标识操作 表4 CinderUpdateVolumeReadonlyOption 参数 是否必选 参数类型 描述 readonly 是 Boolean 是否只读标识。 true:表示只读。 false:表示非只读。 缺省值:true
  • 响应示例 状态码: 200 OK { "volume" : { "attachments" : [ ], "availability_zone" : "az-dc-1", "bootable" : "false", "consistencygroup_id" : null, "created_at" : "2016-05-25T02:38:40.392463", "description" : "create for api test", "encrypted" : false, "id" : "8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66", "rel" : "bookmark" } ], "metadata" : { "volume_owner" : "openapi" }, "name" : "openapi_vol01", "replication_status" : "disabled", "multiattach" : false, "size" : 40, "snapshot_id" : null, "source_volid" : null, "status" : "creating", "updated_at" : null, "user_id" : "39f6696ae23740708d0f358a253c2637", "volume_type" : "SATA" } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘URI自描述信息。 name String 云硬盘名称。 status String 云硬盘状态,具体请参见云硬盘状态。 attachments Array of VolumeAttachment objects 挂载信息。 availability_zone String 云硬盘所属AZ。 bootable String 是否为启动云硬盘。 true:表示为启动云硬盘。 false:表示为非启动云硬盘。 encrypted Boolean 当前云硬盘服务不支持该字段。 created_at String 创建云硬盘的时间。 时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX description String 云硬盘描述。 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云硬盘 当指定的云硬盘类型在availability_zone内不存在时,则创建云硬盘失败。 replication_status String 预留属性。 consistencygroup_id String 所属一致性组ID。 source_volid String 源云硬盘ID。 当前云硬盘服务不支持该字段。 snapshot_id String 快照ID。 metadata VolumeMetadata object 元数据。 size Integer 云硬盘大小,单位为GiB。 user_id String 使用云硬盘用户ID。 updated_at String 云硬盘更新时间。 shareable Boolean 是否为可共享云硬盘。 说明: 该字段已经废弃,请使用multiattach。 multiattach Boolean 是否为共享云硬盘。 true:表示为共享云硬盘。 false:表示为非共享云硬盘。 storage_cluster_id String 预留属性。 表6 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 缺省值:next 表7 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 表8 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类型。 状态码: 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参数 参数 是否必选 参数类型 描述 action 是 String 操作标识,当前支持的取值如下: 删除标签:delete 缺省值:delete 枚举值: delete tags 是 Array of DeleteTagsOption objects 标签列表。 表4 DeleteTagsOption 参数 是否必选 参数类型 描述 key 是 String 标签键。
  • 请求示例 删除一个指定云硬盘的两个标签,一个标签key为key1,另一个标签key为key2。 POST https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}/tags/action { "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2" } ] }
  • 响应示例 状态码: 200 OK { "snapshot": { "status": "available", "os-extended-snapshot-attributes:progress": "100%", "description": "daily backup", "created_at": "2013-02-25t04:13:17.000000", "metadata": {}, "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635", "os-extended-snapshot-attributes:project_id": "0c2eba2c5af04d3f9e9d0d410b371fde", "size": 1, "id": "2bb856e1-b3d8-4432-a858-09e4ce939389", "name": "snap-001", "updated_at": null, } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应示例 状态码: 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", "os-volume-replication:extended_status" : null, "snapshot_id" : null, "volume_image_metadata" : null, "metadata" : { }, "status" : "error_restoring", "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" } } 状态码: 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 出现错误时,返回的错误消息。
  • 请求示例 查询云硬盘id为e92ba908-82f8-4728-b8cc-82f2f56bd461、40g42920-4243-420f-8bb2-a0bd7660fbd8、b1fd8dcc-dd67-4edf-b89e-87c3485112ec的云硬盘详情,从第1条记录开始查询,返回结果中的记录数不超过100个,返回结果按云硬盘大小排序。 GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?ids=['e92ba908-82f8-4728-b8cc-82f2f56bd461', '40g42920-4243-420f-8bb2-a0bd7660fbd8', 'b1fd8dcc-dd67-4edf-b89e-87c3485112ec']&offset=0&limit=100&sort_key=size&sort_dir=asc 查询id为3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c的云服务器下的所有共享数据盘详情,返回结果按照升序排列。 GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?server_id=3ffcbe9d-e5bf-45f4-aa0a-670b54bda66c&multiattach=true&sort_dir=asc
  • 响应示例 状态码: 200 OK { "count" : 1, "volumes" : [ { "attachments" : [ ], "availability_zone" : "az-dc-1", "bootable" : "false", "created_at" : "2016-05-25T02:42:10.856332", "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "bookmark" } ], "metadata" : { }, "name" : "zjb_u25_test", "os-vol-host-attr:host" : "pod01.xxx#SATA", "volume_image_metadata" : { }, "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f", "replication_status" : "disabled", "multiattach" : false, "size" : 1, "status" : "available", "updated_at" : "2016-05-25T02:42:22.341984", "user_id" : "b0524e8342084ef5b74f158f78fc3049", "volume_type" : "SATA", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "next" } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • URI GET /v2/{project_id}/cloudvolumes/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见"获取项目ID"。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 通过云硬盘ID进行分页查询,默认为查询第一页数据。marker={{id}}表示查询该云硬盘id后的所有云硬盘的信息(查询结果不包含该id的云硬盘信息)。 name 否 String 磁盘名称。 limit 否 Integer 返回结果个数限制。默认值为1000。 最小值:1 最大值:1000 缺省值:1000 sort_key 否 String 返回结果按该关键字排序,支持id,status,size,created_at等关键字,默认为“created_at”。 offset 否 Integer 偏移量。 说明:查询云硬盘列表时使用,与limit配合使用。假如共有30个云硬盘,设置offset为11,limit为10,即为从第12个云硬盘开始查询,一次最多可读取10个云硬盘。 sort_dir 否 String 返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc status 否 String 云硬盘状态,取值可参考:"云硬盘状态" 。 metadata 否 String 云硬盘元数据。 availability_zone 否 String 可用区信息。 multiattach 否 Boolean 是否为共享云硬盘。 true:表示为共享云硬盘。 false:表示为非共享云硬盘。 service_type 否 String 服务类型,仅支持EVS、DSS、DESS。 dedicated_storage_id 否 String 专属存储池ID,可过滤出该专属存储池下的所有云硬盘,必须精确匹配。 dedicated_storage_name 否 String 专属存储池的名字,可过滤出该专属存储池下的所有云硬盘,支持模糊匹配。 volume_type_id 否 String 云硬盘类型id。通过"查询云硬盘类型列表"可以查到,即volume_types参数说明表格中的“id” id 否 String 云硬盘ID。 ids 否 String 云硬盘id列表,格式为ids=['id1','id2',...,'idx'],返回“ids”中有效id的云硬盘详情,无效的id会被忽略。 支持查询最多60个id对应的云硬盘详情。 如果“id”和“ids”查询参数同时存在,“id”会被忽略。 enterprise_project_id 否 String 指定企业项目id进行过滤。 传入“all_granted_eps”,代表查询权限范围内的所有企业项目下的云硬盘。 说明: 关于企业项目ID的获取及企业项目特性的详细信息,请参考:"企业管理用户指南"。 server_id 否 String 云服务器id。 bootable 否 Boolean 是否为启动盘/系统盘,true表示为启动盘/系统盘,false表示为数据盘
  • 请求示例 POST https://{endpoint}/v3/{project_id}/cloudvolumes { "volume" : { "count" : 1, "availability_zone" : "az-dc-1", "description" : "test_volume_1", "size" : 120, "name" : "test_volume_1", "volume_type" : "SSD", "metadata" : { "__system__encrypted" : "1", "__system__cmkid" : "37b0d52e-c249-40d6-83cb-2b93f22445bd" } } }
  • 响应示例 状态码: 200 云硬盘的信息。 { "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", "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 OK { "volumes" : [ { "id" : "e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/e6cf4401-15f6-44bd-ae2b-cff4dc9523e6", "rel" : "bookmark" } ], "name" : "hallo5" }, { "id" : "4c5e8203-f70e-4717-90cd-4a8f636888d1", "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/cd631140887d4b6e9c786b67a6dd4c02/volumes/4c5e8203-f70e-4717-90cd-4a8f636888d1", "rel" : "bookmark" } ], "name" : "hallo4" } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 volumes Array of DiskSummary objects 查询请求返回的云硬盘列表。 表5 DiskSummary 参数 参数类型 描述 id String 云硬盘ID。 links Array of Link objects 云硬盘uri自描述信息。 name String 云硬盘的名称。最大支持85个字符。 表6 Link 参数 参数类型 描述 href String 对应的快捷链接。 rel String 快捷链接标记名称。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误码。错误码和其对应的含义请参考错误码说明。 表8 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • URI GET /v2/{project_id}/cloudvolumes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 取值为上一页数据的最后一条记录的id,返回值为该项后面的项。取值为上一页数据的最后一条记录的id,返回值为该项后面的项。 name 否 String 云硬盘名称。 status 否 String 云硬盘状态。 limit 否 Integer 返回结果个数限制。默认值为1000。 缺省值:1000 availability_zone 否 String AZ信息。 sort_key 否 String 返回结果按该关键字排序(支持id,status,size,created_at等关键字,默认为“created_at”)。 缺省值:created_at 枚举值: id status size created_at sort_dir 否 String 降序或升序,分别对应desc和asc,默认为“desc”。 缺省值:desc
  • 响应参数 状态码: 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 出现错误时,返回的错误消息。
  • 响应示例 状态码: 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 标签列表。 { "tags" : { "key_0" : [ "value_0" ], "key_1" : [ "value_1", "value_2", "value_3", "value_4" ] } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • URI DELETE /v3/{project_id}/volumes/{volume_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见"获取项目ID"。 volume_id 是 String 云硬盘ID 表2 Query参数 参数 是否必选 参数类型 描述 cascade 否 Boolean 删除云硬盘关联的所有快照,默认值为false。 缺省值:false
  • 响应示例 状态码: 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" } }
  • 请求示例 POST https://{endpoint}/v3/{project_id}/snapshots { "snapshot" : { "name" : "snap-001", "description" : "Daily backup", "volume_id" : "5aa119a8-d25b-45a7-8d1b-88e127885635", "force" : false, "metadata" : { } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 volume_type VolumeType object 查询请求返回的云硬盘类型。 表4 VolumeType 参数 参数类型 描述 id String 云硬盘类型的ID。 name String 云硬盘类型名称。 extra_specs VolumeTypeExtraSpecs object 云硬盘类型的规格。 description String 云硬盘类型的描述信息。 qos_specs_id String 预留属性。 is_public Boolean 预留属性。 表5 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 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 响应示例 状态码: 200 OK { "volume_type" : { "extra_specs" : { "availability-zone" : "az-dc-1", "volume_backend_name" : "SATA", "RESKEY:availability_zones" : "az-dc-1,az-dc-2", "os-vendor-extended:sold_out_availability_zones" : "az-dc-2" }, "name" : "SATA", "is_public" : true, "id" : "ea6e3c13-aac5-46e0-b280-745ed272e662", "description" : null } } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 os-detach 是 CinderDetachVolumeOption object 标记卸载云硬盘操作 表4 CinderDetachVolumeOption 参数 是否必选 参数类型 描述 attachment_id 否 String 挂载ID。如果云硬盘只有一个挂载点, 那该参数是可选的,如果云硬盘有多个 挂载点,那么该参数是必选的。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 volume_types Array of VolumeType objects 查询请求返回的云硬盘类型列表。 表4 VolumeType 参数 参数类型 描述 id String 云硬盘类型的ID。 name String 云硬盘类型名称。 extra_specs VolumeTypeExtraSpecs object 云硬盘类型的规格。 description String 云硬盘类型的描述信息。 qos_specs_id String 预留属性。 is_public Boolean 预留属性。 表5 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 表6 响应Body参数 参数 参数类型 描述 error Error object 出现错误时,返回的错误信息。 表7 Error 参数 参数类型 描述 code String 出现错误时,返回的错误码。 错误码和其对应的含义请参考错误码说明。 message String 出现错误时,返回的错误消息。
  • 响应示例 状态码: 200 OK { "volume_types" : [ { "extra_specs" : { "availability-zone" : "az-dc-1", "volume_backend_name" : "SAS", "RESKEY:availability_zones" : "az-dc-1,az-dc-2", "os-vendor-extended:sold_out_availability_zones" : "az-dc-2" }, "description" : null, "name" : "SAS", "id" : "6c81c680-df58-4512-81e7-ecf66d160638", "is_public" : true }, { "extra_specs" : { "availability-zone" : "az-dc-1", "volume_backend_name" : "SATA", "RESKEY:availability_zones" : "az-dc-1,az-dc-2", "os-vendor-extended:sold_out_availability_zones" : "az-dc-2" }, "description" : null, "name" : "SATA", "qos_specs_id" : "585f29d6-7147-42e7-bfb8-ca214f640f6f", "is_public" : true, "id" : "ea6e3c13-aac5-46e0-b280-745ed272e662" }, { "extra_specs" : { "availability-zone" : "az-dc-1", "volume_backend_name" : "SSD", "RESKEY:availability_zones" : "az-dc-1,az-dc-2", "os-vendor-extended:sold_out_availability_zones" : "az-dc-2" }, "description" : null, "name" : "SSD", "qos_specs_id" : "39b0c29a-308b-4f86-b478-5d3d02a43837", "is_public" : true, "id" : "6f2dee9e-82f0-4be3-ad89-bae605a3d24f" } ] } 状态码: 400 Bad Request { "error" : { "message" : "XXXX", "code" : "XXX" } }
共100000条