调用ListNodesByQueue查询集群指定队列中的节点信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListNodesByQueue

系统规定参数。取值:ListNodesByQueue

ClusterId String ehpc-hz-FYUr32****

集群ID。

QueueName String workq

队列名称。

PageNumber Integer 1

显示的页码,起始值为1。

PageSize Integer 10

每页显示的行数。取值范围:1~50

默认值:10

返回数据

名称 类型 示例值 描述
PageSize Integer 1

本页条数。

RequestId String B405FF19-2D5F-4489-A84C-BC15CC1B24BD

请求ID。

PageNumber Integer 1

当前页码。

TotalCount Integer 1

列表条目总数。

Nodes Array of NodeInfo

节点列表信息。

NodeInfo
VpcId String vpc-bp1gnu8br4ay7beb2w****

专有网络ID。

Status String untracking

节点状态。可能值:

  • uninit:未初始化
  • init:初始化中
  • ready:空闲
  • running:运行中
  • exception:异常
  • untracking:未加入集群
HtEnabled Boolean true

是否启用HT。

Expired Boolean false

包年包月节点是否到期。如果是按量付费节点,则为false。

ImageOwnerAlias String system

镜像类型,可能值:

  • system:公共镜像
  • self:自定义镜像
  • others:共享镜像
  • marketplace:镜像市场镜像
LockReason String financial

节点被锁定类型,可能值:

  • financial:因欠费被锁定。
  • security:因安全原因被锁定。
  • recycling:抢占式实例的待释放锁定状态。
  • dedicatedhostfinancial:因为专有宿主机欠费导致ECS实例被锁定。

默认返回为空字符串。

HostName String compute0

节点名称。

PublicIpAddress String 10.34.**.**

节点的公网IP地址。

SpotStrategy String NoSpot

实例的抢占策略。可能值:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
CreatedByEhpc Boolean true

是否由E-HPC创建的节点。

RegionId String cn-hangzhou

地域ID。

VSwitchId String vsw-bp1e47optm9g58zcu****

交换机ID。

IpAddress String 172.168.**.**

节点私网IP地址。

ExpiredTime String 2020-09-18T13:24:29.000Z

包年包月节点到期时间。如果是按量付费节点,则此项为空。

Version String 1.0.64

集群所使用的客户端版本号。

ZoneId String cn-hangzhou-b

可用区ID。

AddTime String 2019-09-18T13:24:29.000Z

节点加入集群的时间。

ImageId String centos_7_02_64_20G_alibase_20170818****

镜像ID。

Location String PublicCloud

节点所在位置。可能值:

  • OnPremise:混合云集群。
  • PublicCloud:公有云集群。
Id String i-bp13p7vlcb1uihfv****

节点实例ID。

CreateMode String manual

节点创建方式。可能值:

  • manual:手动扩容
  • autoscale:自动扩容
TotalResources Object

资源总量。

Gpu Integer 0

GPU资源总量。单位:卡

Cpu Integer 1

CPU资源总量。单位:核

Memory Integer 1024

内存资源总量。单位:GB

UsedResources Object

计算节点资源使用量,其他类型节点返回值为空。

Gpu Integer 0

GPU资源总量。单位:卡

Cpu Integer 1

CPU资源总量。单位:核

Memory Integer 1

内存资源总量。单位:GB

StateInSched String active

从调度器查看到的节点状态,不同调度器状态不同。

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListNodesByQueue
&ClusterId=ehpc-hz-FYUr32****
&QueueName=workq
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNodesByQueueResponse>
    <PageSize>1</PageSize>
    <RequestId>B405FF19-2D5F-4489-A84C-BC15CC1B24BD</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Nodes>
        <VpcId>vpc-bp1gnu8br4ay7beb2w****</VpcId>
        <Status>untracking</Status>
        <HtEnabled>true</HtEnabled>
        <Expired>false</Expired>
        <ImageOwnerAlias>system</ImageOwnerAlias>
        <LockReason>financial</LockReason>
        <HostName>compute0</HostName>
        <PublicIpAddress>10.34.**.**</PublicIpAddress>
        <SpotStrategy>NoSpot</SpotStrategy>
        <CreatedByEhpc>true</CreatedByEhpc>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>
        <IpAddress>172.168.**.**</IpAddress>
        <ExpiredTime>2020-09-18T13:24:29.000Z</ExpiredTime>
        <Version>1.0.64</Version>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <AddTime>2019-09-18T13:24:29.000Z</AddTime>
        <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>
        <Location>PublicCloud</Location>
        <Id>i-bp13p7vlcb1uihfv****</Id>
        <CreateMode>manual</CreateMode>
        <TotalResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1024</Memory>
        </TotalResources>
        <UsedResources>
            <Gpu>0</Gpu>
            <Cpu>1</Cpu>
            <Memory>1</Memory>
        </UsedResources>
        <StateInSched>active</StateInSched>
    </Nodes>
</ListNodesByQueueResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 1,
  "RequestId" : "B405FF19-2D5F-4489-A84C-BC15CC1B24BD",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Nodes" : [ {
    "VpcId" : "vpc-bp1gnu8br4ay7beb2w****",
    "Status" : "untracking",
    "HtEnabled" : true,
    "Expired" : false,
    "ImageOwnerAlias" : "system",
    "LockReason" : "financial",
    "HostName" : "compute0",
    "PublicIpAddress" : "10.34.**.**",
    "SpotStrategy" : "NoSpot",
    "CreatedByEhpc" : true,
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1e47optm9g58zcu****",
    "IpAddress" : "172.168.**.**",
    "ExpiredTime" : "2020-09-18T13:24:29.000Z",
    "Version" : "1.0.64",
    "ZoneId" : "cn-hangzhou-b",
    "AddTime" : "2019-09-18T13:24:29.000Z",
    "ImageId" : "centos_7_02_64_20G_alibase_20170818****",
    "Location" : "PublicCloud",
    "Id" : "i-bp13p7vlcb1uihfv****",
    "CreateMode" : "manual",
    "TotalResources" : {
      "Gpu" : 0,
      "Cpu" : 1,
      "Memory" : 1024
    },
    "UsedResources" : {
      "Gpu" : 0,
      "Cpu" : 1,
      "Memory" : 1
    },
    "StateInSched" : "active"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The specified parameter %s is invalid. 无效的参数:%s
400 NotEnabled You have not enabled this service 您的账户还未开通此服务
404 ClusterNotFound The specified cluster does not exist. 指定的集群不存在,请您检查该参数是否正确。
404 ManagerNotFound The manager nodes do not exist or their status is abnormal. 管理节点不存在或状态异常。
406 EcsError An error occurred while calling the ECS API operation. ECS API调用出错
406 DbError A database service error occurred. 数据库请求失败
406 RedisError A Redis service error occurred. Redis请求失败
406 AgentError The agent service request failed. 代理请求失败
406 AliyunError An Alibaba Cloud product error occurred. 阿里云产品错误
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权
500 UnknownError An unknown error occurred. 未知错误,请您稍后再试,若还出现相同的错误请提交工单处理。
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

访问错误中心查看更多错误码。