调用ListNodes查询指定集群中的节点列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:ListNodes | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 待查询的集群 ID。 您可以通过调用 ListClusters 获取集群 ID。 | ehpc-hz-FYUr32**** |
| Role | string | 否 | 节点类型。取值范围：
| Manager |
| HostName | string | 否 | 节点名称，支持模糊查询，支持 MySQL 的正则表达式。 | test-HostName |
| PageNumber | integer | 否 | 显示的页码，起始值为 1。 | 1 |
| PageSize | integer | 否 | 每页显示的条数。取值范围：1~100 默认值：10 | 10 |
| Sequence | string | 否 | 节点列表排序方式。取值范围：
默认值：Forward 说明
和 SortBy 同时使用，如 SortBy 设置为 AddedTime，Sequence 设置为 Forward，表示按节点加入时间正序查询。
| Forward |
| SortBy | string | 否 | 节点列表排序方式。取值范围：
| AddedTime |
| Filter | string | 否 | 节点状态过滤选项。 取值格式为：{"status":"node_status"}，请将其中 node_status 替换为节点的状态。节点的取值范围为：
| {"status":"running"} |
| PrivateIpAddress | string | 否 | 私网 IP 地址。 | 172.16.**.** |
| HostNamePrefix | string | 否 | 主机名前缀。查询具有指定前缀的节点。 | compute |
| HostNameSuffix | string | 否 | 主机名后缀。查询具有指定后缀的节点。 | 01 |
返回参数
示例
正常返回示例
JSON格式
{
"PageSize": 1,
"RequestId": "89A1AC0F-4A6C-4F3D-98F9-BEF9A823****",
"PageNumber": 1,
"TotalCount": 1,
"Nodes": {
"NodeInfo": [
{
"VpcId": "vpc-bp1gnu8br4ay7beb2w****",
"Status": "running",
"HtEnabled": true,
"Expired": false,
"ImageOwnerAlias": "system",
"LockReason": "financial",
"HostName": "test-HostName",
"InstanceType": "ecs.c5.large",
"PublicIpAddress": "172.16.**.**",
"SpotStrategy": "NoSpot",
"CreatedByEhpc": true,
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-bp1e47optm9g58zcu****",
"IpAddress": "172.16.**.**",
"ExpiredTime": "2020-06-09T06:22:02.000Z",
"Version": "1.0.78",
"ZoneId": "cn-hangzhou-b",
"AddTime": "2020-06-09T06:22:02.000Z",
"ImageId": "centos_7_06_64_20G_alibase_20190711.vhd",
"Location": "PublicCloud",
"Id": "i-bp15707mys2rsy0j****",
"CreateMode": "manual",
"Roles": {
"Role": [
"[“Compute”]"
]
},
"TotalResources": {
"Gpu": 0,
"Cpu": 1,
"Memory": 1024
},
"UsedResources": {
"Gpu": 0,
"Cpu": 0,
"Memory": 0
},
"StateInSched": "active"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 | 请求失败，服务暂时不可用 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-12-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||||
|