GetClusterVolumes - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the information about the volumes that are mounted to the specified E-HPC cluster in the user account.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:GetClusterVolumes	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-gh5WKb****

Response parameters

Parameter	Type	Description	Example
	object
RegionId	string	The ID of the region.	cn-hangzhou
RequestId	string	The ID of the request.	8BCFD52E-0336-4490-AE7D-F560F106****
Volumes	object []	The array of the file system mounted to the E-HPC cluster.
JobQueue	string	The queue of the job.	workq
VolumeId	string	The ID of the file system.	0e754****
RemoteDirectory	string	The remote mount directory.	/test
VolumeMountpoint	string	The address of the mount target.	0e754****-kal90.cn-hangzhou.nas.aliyuncs.com
LocalDirectory	string	The local mount directory.	/ehpcdata
VolumeType	string	The type of the file system. Valid values: NAS	NAS
MustKeep	boolean	Indicates whether the resource can be unmounted.	true
Location	string	The type of cluster. Valid values: OnPremise: The cluster is deployed on a hybrid cloud. PublicCloud: The cluster is deployed on a public cloud.	PublicCloud
VolumeProtocol	string	The storage protocol type of the file system. Valid values: NFS SMB	NFS
Roles	object []	The array of the node on which the file system is mounted.
Name	string	The type of the node on which the file system is mounted. Valid values: Compute: compute node Manager: management node Login: logon node	Compute

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	Invalid param: %s	-
404	ClusterNotFound		The specified instance does not exist.
406	NasError		Failed to request the NAS interface.
406	DbError		Database request failed.
406	PartFailure		Part of the batch operation failed.
407	NotAuthorized		The request is not authorized by RAM.
500	UnknownError		An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

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