Queries the information of volumes in a specified cluster.

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 GetClusterVolumes

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

ClusterId String Yes ehpc-hz-gh5WKb****

The ID of the cluster.

Response parameters

Parameter Type Example Description
RegionId String cn-hangzhou

The ID of the region.

RequestId String 8BCFD52E-0336-4490-AE7D-F560F1065F9B

The ID of the request.

Volumes Array of VolumeInfo

The array of shared volumes that are attached to the E-HPC cluster.

VolumeInfo
JobQueue String workq

The queue of the job.

LocalDirectory String /ehpcdata

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
MustKeep Boolean true

Indicates whether the resource can be unmounted.

RemoteDirectory String /test

The remote mount directory.

Roles Array of RoleInfo

The array of node roles that are attached to the new NAS file system.

RoleInfo
Name String Compute

The name of the node role that is attached to a NAS file system. Valid values:

  • Compute: compute node
  • Manager: management node
  • Login: logon node
VolumeId String 0e754****

The ID of the file system.

VolumeMountpoint String 0e754****-kal90.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 volume. Only NAS is supported.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=GetClusterVolumes
&ClusterId=ehpc-hz-gh5WKb****
&<Common request parameters>

Sample success responses

XML format

<GetClusterVolumesResponse>
      <Volumes>
            <VolumeInfo>
                  <VolumeProtocol>NFS</VolumeProtocol>
                  <LocalDirectory>/ehpcdata</LocalDirectory>
                  <RemoteDirectory>/</RemoteDirectory>
                  <VolumeId>0e754****</VolumeId>
                  <VolumeType>NAS</VolumeType>
                  <JobQueue>workq</JobQueue>
                  <MustKeep>true</MustKeep>
                  <VolumeMountpoint>0e754****-kal90.cn-hangzhou.nas.aliyuncs.com&lt;</VolumeMountpoint>
                  <Location>PublicCloud</Location>
            </VolumeInfo>
            <VolumeInfo>
                  <Roles>
                        <RoleInfo>
                              <Name>Compute</Name>
                        </RoleInfo>
                  </Roles>
            </VolumeInfo>
      </Volumes>
      <RequestId>8BCFD52E-0336-4490-AE7D-F560F1065F9B</RequestId>
      <RegionId>cn-hangzhou</RegionId>
</GetClusterVolumesResponse>

JSON format

{
    "Volumes":{
        "VolumeInfo":[
            {
                "VolumeProtocol":"NFS",
                "LocalDirectory":"/ehpcdata",
                "RemoteDirectory":"/",
                "VolumeId":"0e754****",
                "VolumeType":"NAS",
                "JobQueue":"workq",
                "MustKeep":"true",
                "VolumeMountpoint":"0e754****-kal90.cn-hangzhou.nas.aliyuncs.com<",
                "Location":"PublicCloud"
            },
            {
                "Roles":{
                    "RoleInfo":[
                        {
                            "Name":"Compute"
                        }
                    ]
                }
            }
            ]
    },
"RequestId":"8BCFD52E-0336-4490-AE7D-F560F1065F9B",
"RegionId":"cn-hangzhou"
}

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.