DATASOURCE::EHPC::Nodes - Resource Orchestration Service

DATASOURCE::EHPC::Nodes is used to query nodes in an Elastic High Performance Computing (E-HPC) cluster.

Syntax

{
  "Type": "DATASOURCE::EHPC::Nodes",
  "Properties": {
    "Role": String,
    "HostNameSuffix": String,
    "PrivateIpAddress": String,
    "ClusterId": String,
    "HostNamePrefix": String,
    "HostName": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Role	String	No	Yes	The type of nodes that you want to query.	Valid values: Manager: management node Login: logon node Compute: compute node
HostNameSuffix	String	No	Yes	The suffix of the hostname.	You can query nodes that have the specified suffix.
PrivateIpAddress	String	No	Yes	The private IP address.	None.
ClusterId	String	Yes	Yes	The ID of the cluster.	You can call the ListClusters operation to query the cluster ID.
HostNamePrefix	String	No	Yes	The prefix of the hostname.	None.
HostName	String	No	Yes	The hostname of the node.	Limits: Fuzzy match is supported. MySQL regular expressions are supported.

Return values (Fn::GetAtt)

NodeIds: the IDs of nodes.
NodeIds: the list of nodes.

Property	Type	Description	Constraint
NodeIds	List	The IDs of nodes.	None.
Nodes	List	The list of nodes.	None.
NodeId	String	The ID of the node.	None.
ImageOwnerAlias	String	The type of the image.	None.
StateInSched	String	The status of the node.	The status of the node varies based on the scheduler type.
ZoneId	String	The ID of the zone.	None.
VSwitchId	String	The ID of the vSwitch.	None.
Expired	Boolean	Indicates whether the subscription node has expired.	Valid values: true: The subscription node has expired. false: The subscription node has not expired.
AddTime	String	The time when the node was added to the cluster.	The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
PublicIpAddress	String	The public IP address.	None.
IpAddress	String	The IP address of the node.	None.
VpcId	String	The ID of the virtual private cloud (VPC).	None.
CreateMode	String	The mode in which the node was created.	None.
Version	String	The version of the client.	None.
UsedResources	Map	The total amount of resources that are used by the compute node.	Sample code: `{ "Gpu" : 0, "Cpu" : 0, "Memory" : 0 }`
TotalResources	Map	The total amount of resources that are used by the node.	Sample code: `{ "Gpu" : 0, "Cpu" : 1, "Memory" : 1024`
ImageId	String	The ID of the image.	None.
HtEnabled	Boolean	Indicates whether hyper-threading is enabled.	Valid values: true false
RegionId	String	The ID of the region.	None.
LockReason	String	The reason why the node is locked.	Valid values: financial: The node is locked due to overdue payments. security: The node is locked due to security reasons. recycling: The node is locked because the node is a preemptible node and waiting to be released. dedicatedhostfinancial: The node is locked due to overdue payments of the dedicated host.
InstanceType	String	The instance type of the node.	None.
HostName	String	The name of the node.	None.
SpotStrategy	String	The bidding policy for the compute node.	None.
Location	String	The location of the node.	Valid values: OnPremise: The node is deployed in your data center. PublicCloud: The node is deployed in the Alibaba Cloud public cloud.
Roles	List	The type of the node.	Valid values: Scheduler: primary scheduler SchedulerBackup: secondary scheduler Account: primary domain server AccountBackup: secondary domain server Login: logon node Compute: compute node Note Schedulers and domain servers are management nodes.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": "The ID of the cluster."
    }
  },
  "Resources": {
    "Nodes": {
      "Type": "DATASOURCE::EHPC::Nodes",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "NodeIds": {
      "Description": "The list of node IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Nodes",
          "NodeIds"
        ]
      }
    },
    "Nodes": {
      "Description": "The list of nodes.",
      "Value": {
        "Fn::GetAtt": [
          "Nodes",
          "Nodes"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Type: String
    Description: The ID of the cluster.
Resources:
  Nodes:
    Type: DATASOURCE::EHPC::Nodes
    Properties:
      ClusterId:
        Ref: ClusterId
Outputs:
  NodeIds:
    Description: The list of node IDs.
    Value:
      Fn::GetAtt:
        - Nodes
        - NodeIds
  Nodes:
    Description: The list of nodes.
    Value:
      Fn::GetAtt:
        - Nodes
        - Nodes