All Products
Search
Document Center

Elastic High Performance Computing:ListVolumes

Last Updated:Mar 03, 2024

Queries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListVolumesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number of the page to return.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

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

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

1
RequestIdstring

The request ID.

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

The page number.

1
TotalCountinteger

The total number of returned entries.

1
Volumesobject []

The information of file systems that are mounted on E-HPC clusters.

VolumeIdstring

The ID of the file system.

bc8a****
ClusterNamestring

The instance name.

cluster1
RemoteDirectorystring

The remote directory on which the file system is mounted.

/test1
VolumeMountpointstring

The domain name of the mount target.

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

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

NAS
VolumeProtocolstring

The type of the storage protocol. Valid values:

  • NFS
  • SMB
NFS
RegionIdstring

The region ID.

cn-hangzhou
ClusterIdstring

The cluster ID.

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

The information of additional file systems mounted on E-HPC clusters.

JobQueuestring

The queue to which the job belongs.

all.q
VolumeIdstring

The ID of the file system.

86y3****
RemoteDirectorystring

The remote directory on which the file system is mounted.

/test
VolumeMountpointstring

The domain name of the mount target.

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

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

  • Manager: management node
  • Login: logon node
  • Compute: compute node
Compute
LocalDirectorystring

The local mount directory.

/testopt
VolumeTypestring

The type of the additional file system. Only NAS is supported.

NAS
Locationstring

The location where the cluster is deployed. Valid values:

  • OnPremise: The node is deployed on a hybrid cloud.
  • PublicCloud: The cluster is deployed on a public cloud.
PublicCloud
VolumeProtocolstring

The type of the storage protocol. Valid values:

  • NFS
  • SMB
NFS

Examples

Sample success responses

JSONformat

{
  "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"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
406NasErrorNAS API request failed.Failed to request the NAS interface.
406DbErrorA database service error occurred.Database request failed.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.