GetHyperNode - Platform For AI - Alibaba Cloud Documentation Center

Queries the details of a hypernode.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:GetHyperNode

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
HyperNodeId	string	Yes	The ID of the hypernode.	e01-cn-zvp2tgykr08

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
NodeGroupName	string	The name of the node group.	emr-default
ClusterId	string	The cluster ID.	i112138561737531371671
ClusterName	string	The name of the cluster.	Standard_Cluster
ZoneId	string	The zone ID.	cn-wulanchabu-c
CreateTime	string	The time when the hypernode was created.	2022-11-30T02:00:00.852Z
NodeGroupId	string	The ID of the node group.	ng-ec3c96ff0aa4c60d
MachineType	string	The machine type.	efg2.C48cNHmcn
ExpireTime	string	The expiration time.	2026-05-14T00:00:00
HpnZone	string	The cluster number.	A1
ResourceGroupId	string	The resource group ID.	rg-acfmwfm33rlt6zi
FileSystemMountEnabled	boolean	Indicates whether file storage mounting is supported.	True
HyperNodeId	string	The ID of the hypernode.	e01-cn-zvp2tgykr08
Nodes	array<object>	The list of nodes.
	array<object>	The list of nodes.
NodeId	string	The node ID.	e01-cn-zvp2tgykr0b
ImageId	string	The image ID.	i190297201669099844192
Hostname	string	The hostname.	alywlcb-lingjun-gpu-0025
Status	string	The status.	InProgress
ImageName	string	The image name.	Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428
Networks	object	The network information.
BondName	string	The name of the network interface on the machine.	bond0
Ip	string	The IP address of the machine in the virtual private cloud (VPC).	172.17.231.113
UserData	string	The user-defined script.	#!/bin/bash uptime echo "aaaaaaa" >> /tmp/ttttt20250110141010.sh
Disks	array<object>	The disk information.
	object	The disk information.
DiskId	string	The disk ID.	d-bp1564bcc2306uui4zpk
Category	string	The packet classification. Valid values: DOWNLINK_PACKET: Downlink packet. UPLINK_PACKET: Uplink packet.	DOWNLINK_PACKET
Size	integer	The disk size. Unit: GiB.	5
PerformanceLevel	string	When you create an enhanced SSD (ESSD) to use as a system disk, set the performance level of the disk. Valid values: PL0: A maximum of 10,000 random read/write IOPS per disk. PL1: A maximum of 50,000 random read/write IOPS per disk.	PL0
Type	string	The disk type. Possible values: system: system disk. data: data disk.	system
Status	string	The status of the node.	Using
Hostname	string		alywlcb-lingjun-gpu-0025

Examples

Success response

JSON format

{
  "RequestId": "2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1",
  "NodeGroupName": "emr-default",
  "ClusterId": "i112138561737531371671",
  "ClusterName": "Standard_Cluster",
  "ZoneId": "cn-wulanchabu-c",
  "CreateTime": "2022-11-30T02:00:00.852Z",
  "NodeGroupId": "ng-ec3c96ff0aa4c60d",
  "MachineType": "efg2.C48cNHmcn",
  "ExpireTime": "2026-05-14T00:00:00",
  "HpnZone": "A1",
  "ResourceGroupId": "rg-acfmwfm33rlt6zi",
  "FileSystemMountEnabled": true,
  "HyperNodeId": "e01-cn-zvp2tgykr08",
  "Nodes": [
    {
      "NodeId": "e01-cn-zvp2tgykr0b",
      "ImageId": "i190297201669099844192",
      "Hostname": "alywlcb-lingjun-gpu-0025",
      "Status": "InProgress",
      "ImageName": "Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428",
      "Networks": {
        "BondName": "bond0",
        "Ip": "172.17.231.113"
      },
      "UserData": "#!/bin/bash\nuptime\necho \"aaaaaaa\" >> /tmp/ttttt20250110141010.sh",
      "Disks": [
        {
          "DiskId": "d-bp1564bcc2306uui4zpk",
          "Category": "DOWNLINK_PACKET",
          "Size": 5,
          "PerformanceLevel": "PL0",
          "Type": "system"
        }
      ]
    }
  ],
  "Status": "Using",
  "Hostname": "alywlcb-lingjun-gpu-0025"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.