云硬盘列表
云硬盘列表
1. 描述
获取云硬盘列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/volume/list
3. 请求参数
| Name | Type | Description | Required |
|---|---|---|---|
| projectId | String | 项目ID | 是 |
| nameOrSn | String | 名称或SN | 否 |
| curPage | Integer | 当前页码，默认值1 | 否 |
| perPage | Integer | 每页显示条数，默认值10 | 否 |
4. 请求示例
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/volume/list HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectId": "xxxxxxxxxxx",
"curPage":1,
"perPage":10
}
5. 返回结果
5.1. 返回正确结果示例
{
"requestId": "060e114f-af9e-4291-af55-485c9743cec6",
"success": true,
"code": 200,
"message": null,
"model": null,
"pager": {
"curPage": 1,
"perPage": 10,
"totalRecords": 1,
"totalPages": 1,
"pageData": [
{
"id": "38cea0f1-b09a-460c-b136-8a10f5a5c052",
"name": "api",
"sn": "VOL-218KP2Y",
"regionSn": "CN-EAST-1",
"azSn": "CN-EAST-1-A",
"created": "2019-05-20 17:56:32",
"size": 100,
"description": null,
"volumeTypeId": "hdd.common.2",
"volumeTypeName": "普通云盘II型"
}
],
"pageOffset": 0,
"more": false,
"queryConditions": {
"projectId": "8a83a0966a8cbe93016aa0cf036f0c4a"
},
"orderBys": {},
"maxResult": 10
}
}
5.2. 返回错误结果示例
{
"requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
"success": false,
"code": 400,
"message": "Required attribute 'projectId' not specified",
"errorCode": "Invalid argument"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。