获取云存储列表 - ListVolumes

功能介绍

获取云存储列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/cae/volumes

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
resource_type	是	String	参数解释：资源类型，当前只支持“obs”和“sfs”。取值范围： obs：存储桶 sfs：文件系统默认取值：不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。
X-Enterprise-Project-ID	否	String	企业项目ID。创建环境时，环境会绑定企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。
X-Environment-ID	是	String	环境ID。获取环境ID，通过获取环境列表来获取环境信息。请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
api_version	String	API版本，固定值“v1”，该值不可修改。
kind	String	API类型，固定值“Volume”，该值不可修改。
items	Array of Volume objects	云存储列表。

表5 Volume
参数	参数类型	描述
id	String	云存储ID。
resource_info	Map<String,String>	存储资源详情。
resource_name	String	云存储名称。
resource_type	String	参数解释：资源类型，当前只支持“obs”和“sfs”。取值范围： obs：存储桶 sfs：文件系统默认取值：不涉及。
resource_sub_type	String	参数解释：存储资源子类型。取值范围： parallel_file_system：并行文件系统 object_bucket：存储桶 sfs3.0：通用文件系统默认取值：不涉及。
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"
  } ]
}