文档

ListVolumes - 列出用户的存储卷

更新时间:
一键部署

调用ListVolumes查询文件系统列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListVolumesREAD
  • acs:ehpc:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
PageNumberinteger

当前页码。

起始值:1

默认值:1

1
PageSizeinteger

每页显示的行数。取值范围:1~50

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

本页条数。

1
RequestIdstring

请求ID。

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目总数。

1
Volumesobject []

挂载到E-HPC集群的文件系统信息数组。

VolumeIdstring

文件系统ID。

bc8a****
ClusterNamestring

集群名称。

cluster1
RemoteDirectorystring

文件系统挂载的远程目录。

/test1
VolumeMountpointstring

挂载点地址。

bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com
VolumeTypestring

挂载到集群的文件系统类型,目前仅支持NAS。

NAS
VolumeProtocolstring

存储协议类型。可能值:

  • NFS
  • SMB
NFS
RegionIdstring

地域ID。

cn-hangzhou
ClusterIdstring

集群ID。

ehpc-hz-FYUr32****
AdditionalVolumesobject []

新增文件系统挂载的信息列表。

JobQueuestring

作业所属队列。

all.q
VolumeIdstring

文件系统ID。

86y3****
RemoteDirectorystring

文件系统挂载的远程目录。

/test
VolumeMountpointstring

挂载点地址。

86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com
Rolestring

挂载的节点类型。可能值:

  • Manager:管控节点
  • Login:登录节点
  • Compute:计算节点
Compute
LocalDirectorystring

本地挂载目录。

/testopt
VolumeTypestring

新增的文件系统类型,目前仅支持NAS。

NAS
Locationstring

集群所在位置。可能值:

  • OnPremise:混合云集群。
  • PublicCloud:公有云集群。
PublicCloud
VolumeProtocolstring

存储协议类型。可能值:

  • NFS
  • SMB
NFS

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "TotalCount": 1,
  "Volumes": {
    "VolumeInfo": [
      {
        "VolumeId": "bc8a****",
        "ClusterName": "cluster1",
        "RemoteDirectory": "/test1",
        "VolumeMountpoint": "bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com",
        "VolumeType": "NAS",
        "VolumeProtocol": "NFS",
        "RegionId": "cn-hangzhou",
        "ClusterId": "ehpc-hz-FYUr32****",
        "AdditionalVolumes": {
          "VolumeInfo": [
            {
              "JobQueue": "all.q",
              "VolumeId": "86y3****",
              "RemoteDirectory": "/test",
              "VolumeMountpoint": "86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com",
              "Role": "Compute",
              "LocalDirectory": "/testopt",
              "VolumeType": "NAS",
              "Location": "PublicCloud",
              "VolumeProtocol": "NFS"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
406NasErrorNAS API request failed.NAS接口请求失败
406DbErrorA database service error occurred.数据库请求失败
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈