获取云存储列表 - ListVolumes
功能介绍
获取云存储列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/cae/volumes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取项目ID请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
参数解释： 资源类型，当前只支持“obs”和“sfs”。 取值范围：
默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。
|
|
X-Enterprise-Project-ID |
否 |
String |
企业项目ID。
说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。
|
|
X-Environment-ID |
是 |
String |
环境ID。
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
api_version |
String |
API版本，固定值“v1”，该值不可修改。 |
|
kind |
String |
API类型，固定值“Volume”，该值不可修改。 |
|
items |
Array of Volume objects |
云存储列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
云存储ID。 |
|
resource_info |
Map<String,String> |
存储资源详情。 |
|
resource_name |
String |
云存储名称。 |
|
resource_type |
String |
参数解释： 资源类型，当前只支持“obs”和“sfs”。 取值范围：
默认取值： 不涉及。 |
|
resource_sub_type |
String |
参数解释： 存储资源子类型。 取值范围：
默认取值： 不涉及。 |
|
access |
String |
用户access key。 |
|
time |
String |
创建时间。 |
请求示例
获取云存储列表。
GET https://{endpoint}/v1/{project_id}/cae/volumes
响应示例
状态码：200
请求成功。
{
"api_version" : "v1",
"kind" : "Volume",
"items" : [ {
"id" : "a061934d-52e3-4b36-aea7-6c51879f84c9",
"resource_name" : "test",
"resource_sub_type" : "parallel_file_system",
"resource_info" : {
"capacity" : "0.00MB",
"obsType" : "STANDARD",
"region" : "region"
},
"access" : "xxx",
"time" : "2023-02-08T09:31:39.858115Z"
}, {
"id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59",
"resource_name" : "test-nacos",
"resource_sub_type" : "object_bucket",
"resource_info" : {
"capacity" : "0.00MB",
"obsType" : "STANDARD",
"region" : "region"
},
"access" : "xxx",
"time" : "2023-02-08T09:31:49.232412Z"
}, {
"id" : "ece8ebcd-3f1e-4175-98ea-369036acbfce",
"resource_name" : "test-nginx",
"resource_sub_type" : "parallel_file_system",
"resource_info" : {
"capacity" : "0.00MB",
"obsType" : "STANDARD",
"region" : "region"
},
"access" : "xxx",
"time" : "2023-02-15T03:24:08.146911Z"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
错误码
请参见错误码。
