DescribeHyperNode - Platform For AI - Alibaba Cloud Documentation Center

Queries the details of a hyper node.

Operation description

Queries the details of a specified hyper node.

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:DescribeHyperNode

get

*HyperNode

acs:eflo:{#regionId}:{#accountId}:hypernode/{#HyperNodeId}

None

Request syntax

POST  HTTP/1.1

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The schema of the response body.
RequestId	string	The request ID.	D6058705-1C45-35C9-9461-02504897D4D0
NodeGroupName	string	The name of the node group.	lisan-nodegroup
ClusterId	string	The cluster ID.	i119982311660892626523
ClusterName	string	The cluster name.	Standard_Cluster
ZoneId	string	The zone ID.	cn-wulanchabu-c
CreateTime	string	The time when the hyper node was created.	2022-11-30T02:00:00.852Z
NodeGroupId	string	The node group ID.	ng-ec3c96ff0aa4c60d
MachineType	string	The machine type.	efg1.nvga1
ExpireTime	string	The expiration time.	2125-06-24T16:52:44.318000
HpnZone	string	The cluster number.	A1
ResourceGroupId	string	The resource group ID.	rg-acfmxno4vh5****
FileSystemMountEnabled	boolean	Indicates whether file storage mounting is supported.	True
HyperNodeId	string	The ID of the hyper node.	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.	457db5ca-241d-11ed-9fd7-acde48001122
Status `deprecated`	string	The state.	InProgress
ImageName	string	The image name.	Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230
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).	192.168.22.2
UserData	string	The user-defined script.	#!/bin/bash uptime echo "aaaaaaa" >> /tmp/ttttttest.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 input/output operations per second (IOPS) per disk. PL1: A maximum of 50,000 random read/write IOPS per disk.	PL0
Type	string	The disk type. Valid values: system: system disk. data: data disk.	system
OperatingState	string	The state of the node.	Using
Status `deprecated`	string	The state of the node.	Operating
Hostname	string	The hostname.	alywlcb-lingjun-gpu-0025
OperatingState	string	The state of the hyper node.	Using

Examples

Success response

JSON format

{
  "RequestId": "D6058705-1C45-35C9-9461-02504897D4D0",
  "NodeGroupName": "lisan-nodegroup",
  "ClusterId": "i119982311660892626523",
  "ClusterName": "Standard_Cluster",
  "ZoneId": "cn-wulanchabu-c",
  "CreateTime": "2022-11-30T02:00:00.852Z",
  "NodeGroupId": "ng-ec3c96ff0aa4c60d",
  "MachineType": "efg1.nvga1",
  "ExpireTime": "2125-06-24T16:52:44.318000",
  "HpnZone": "A1",
  "ResourceGroupId": "rg-acfmxno4vh5****",
  "FileSystemMountEnabled": true,
  "HyperNodeId": "e01-cn-zvp2tgykr08",
  "Nodes": [
    {
      "NodeId": "e01-cn-zvp2tgykr0b",
      "ImageId": "i190297201669099844192",
      "Hostname": "457db5ca-241d-11ed-9fd7-acde48001122",
      "Status": "InProgress",
      "ImageName": "Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230",
      "Networks": {
        "BondName": "bond0",
        "Ip": "192.168.22.2"
      },
      "UserData": "#!/bin/bash\nuptime\necho \"aaaaaaa\" >> /tmp/ttttttest.sh",
      "Disks": [
        {
          "DiskId": "d-bp1564bcc2306uui4zpk",
          "Category": "DOWNLINK_PACKET",
          "Size": 5,
          "PerformanceLevel": "PL0",
          "Type": "system"
        }
      ],
      "OperatingState": "Using"
    }
  ],
  "Status": "Operating",
  "Hostname": "alywlcb-lingjun-gpu-0025",
  "OperatingState": "Using"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.