Use DATASOURCE::EHPC::Nodes in a call to query nodes in an E-HPC cluster - 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,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Role	String	No	Yes	The node type.	Valid values: Manager: management node Login: logon node Compute: compute node
HostNameSuffix	String	No	Yes	The suffix of the hostname.	You can query nodes whose hostnames contain the specified suffix.
PrivateIpAddress	String	No	Yes	The private IP address.	None.
ClusterId	String	Yes	Yes	The ID of the cluster that you want to query.	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 node name.	The following limits apply: Fuzzy search is supported. MySQL regular expressions are supported.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

NodeIds: the IDs of the nodes.
Nodes: details of the nodes.

Property	Type	Description	Constraint
NodeIds	List	The IDs of the nodes.	None.
Nodes	List	Details of the nodes.	None.
NodeId	String	The node ID.	None.
ImageOwnerAlias	String	The image type.	None.
StateInSched	String	The status of the node.	The status of the node varies based on the scheduler type.
ZoneId	String	The zone ID.	None.
VSwitchId	String	The vSwitch ID.	None.
Expired	Boolean	Indicates whether the subscription node has expired.	Valid values: true false
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 is created.	None.
Version	String	The client version of the cluster.	None.
UsedResources	Map	The number of resources that are used by the compute node.	Example: `{ "Gpu" : 0, "Cpu" : 0, "Memory" : 0 }`
TotalResources	Map	The total number of resources that are used by the node.	Example: `{ "Gpu" : 0, "Cpu" : 1, "Memory" : 1024`
ImageId	String	The image ID.	None.
HtEnabled	Boolean	Indicates whether hyper-threading is enabled.	Valid values: true false
RegionId	String	The region ID.	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 pending 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 node name.	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 a data center. PublicCloud: The node is deployed on the Alibaba Cloud public cloud.
Roles	List	The node type.	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

YAML

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

JSON

{
  "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"
        ]
      }
    }
  }
}