Queries file systems.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListVolumes

The operation that you want to perform. Set the value to ListVolumes.

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50

Default value: 10

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The number of the page to return.

PageSize Integer 1

The number of entries returned per page.

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

TotalCount Integer 1

The total number of entries.

Volumes Array of VolumeInfo

The array of file systems that are mounted to the E-HPC cluster.

VolumeInfo
AdditionalVolumes Array of VolumeInfo

The array of file systems that are newly mounted to the E-HPC cluster.

VolumeInfo
JobQueue String all.q

The queue to which the job belongs.

LocalDirectory String /testopt

The on-premises mount directory.

Location String PublicCloud

The location where the cluster is deployed. Valid values:

  • OnPremise: hybrid cloud cluster
  • PublicCloud: public cloud cluster
RemoteDirectory String /test

The remote directory to which the file system is mounted.

Role String Compute

The type of the node to which the file system is mounted. Valid values:

  • Manager: management node
  • Login: logon node
  • Compute: compute node
VolumeId String 86y3****

The ID of the file system.

VolumeMountpoint String 86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com

The address of the mount target.

VolumeProtocol String NFS

The type of the storage protocol. Valid values:

  • NFS
  • SMB
VolumeType String NAS

The newly added type of the file system. Only NAS is supported.

ClusterId String ehpc-hz-FYUr32****

The ID of the cluster.

ClusterName String cluster1

The name of the cluster.

RegionId String cn-hangzhou

The ID of the region.

RemoteDirectory String /test1

The remote directory to which the file system is mounted.

VolumeId String bc8a****

The ID of the file system.

VolumeMountpoint String bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com

The address of the mount target.

VolumeProtocol String NFS

The type of the storage protocol. Valid values:

  • NFS
  • SMB
VolumeType String NAS

The type of the file system that is mounted to the cluster. Only NAS is supported.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListVolumes
&<Common request parameters>

Sample success responses

XML format

<ListVolumesResponse>
      <TotalCount>1</TotalCount>
      <Volumes>
            <VolumeInfo>
                  <VolumeProtocol>nfs</VolumeProtocol>
                  <RemoteDirectory>/test1</RemoteDirectory>
                  <VolumeId>bc8a****</VolumeId>
                  <VolumeType>NAS</VolumeType>
                  <ClusterId>ehpc-hz-FYUr32****</ClusterId>
                  <ClusterName>cluster1</ClusterName>
                  <RegionId>cn-hangzhou</RegionId>
                  <VolumeMountpoint>bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
            </VolumeInfo>
            <VolumeInfo>
                  <AdditionalVolumes>
                        <VolumeInfo>
                              <Role>Compute</Role>
                              <VolumeProtocol>NFS</VolumeProtocol>
                              <LocalDirectory>/testopt</LocalDirectory>
                              <RemoteDirectory>/</RemoteDirectory>
                              <VolumeId>bc8a****</VolumeId>
                              <VolumeType>NAS</VolumeType>
                              <JobQueue>all.q</JobQueue>
                              <VolumeMountpoint>bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
                              <Location> </Location>
                        </VolumeInfo>
                  </AdditionalVolumes>
            </VolumeInfo>
      </Volumes>
      <PageSize>1</PageSize>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <PageNumber>1</PageNumber>
</ListVolumesResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.