查询用户节点列表-ListNodes
功能介绍
分页查询用户节点列表,注意:如果节点status_reason不为空,说明节点对应操作失败
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v2/{project_id}/nodes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询单页记录数量。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 20。 |
| marker | 否 | String | 参数解释: 分页标记,本次请求获取该标记后的资源,base64编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| cluster_id | 否 | String | 参数解释: 集群唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| hyper_group_id | 否 | String | 参数解释: 超节点组唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| hypernode_id | 否 | String | 参数解释: 超节点唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
| node_type | 否 | String | 参数解释 : 节点规格。 约束限制 : 不涉及。 取值范围 : 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值 : 不涉及。 |
| name | 否 | String | 参数解释 : 节点名称。 约束限制 : 不涉及。 取值范围 : 长度1-128,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值 : 不涉及。 |
| availability_zone_id | 否 | String | 参数解释 : 节点所属可用区。 约束限制 : 不涉及。 取值范围 : 长度1-128,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值 : 不涉及。 |
| status | 否 | String | 参数解释 : 节点状态。 约束限制 : 不涉及。 取值范围: 默认取值: 不涉及。 |
| tags | 否 | Array of strings | 参数解释 : 节点标签,格式为tags=key,value&tags=key1,value1。 约束限制 : 1~20个。 取值范围 : 不涉及。 默认取值 : 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| nodes | Array of NodeResponseBody objects | 参数解释 : 节点实例列表。 取值范围 : 不涉及。 |
| page_info | PageInfo object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释 : 节点ID。 取值范围 : 不涉及。 |
| name | String | 参数解释 : 实例名称。 取值范围 : 不涉及。 |
| node_type | String | 参数解释 : 节点规格ID。 取值范围 : 不涉及。 |
| keypair_name | String | 参数解释 : 密钥对名称。 取值范围 : 不涉及。 |
| availability_zone_id | String | 参数解释 : 可用区信息。 取值范围 : 不涉及。 |
| cluster_id | String | 参数解释 : 集群ID。 取值范围 : 不涉及。 |
| hyper_group_id | String | 参数解释 : 超节点组ID。 取值范围 : 不涉及。 |
| hypernode_id | String | 参数解释 : 服务器所属的超节点资源ID。 取值范围 : 不涉及。 |
| status | String | 参数解释: 节点状态。 取值范围: |
| status_reason | String | 参数解释 : 节点处于中间态或错误状态时的原因说明,正常状态时为空。 取值范围 : 不涉及。 |
| frozen_status | Array of strings | 参数解释: 冻结状态,非冻结状态时此状态值为空。 取值范围: |
| network_interfaces | Array of NetworkInterface objects | 参数解释 : VPC网口信息。 取值范围 : 不涉及。 |
| market_info | market_info object | 参数解释 : 计费信息。 取值范围 : 不涉及。 |
| created_at | String | 参数解释: 资源或操作的创建时间。 取值范围: 格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如:2026-05-22T06:30:45.123Z。 |
| updated_at | String | 参数解释: 资源或操作的更新时间。 取值范围: 格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如:2026-05-22T06:30:45.123Z。 |
| provider_resource_info | ProviderResourceInfo object | 参数解释 : 底层资源信息。 取值范围 : 不涉及。 |
| volumes | Array of Volume objects | 参数解释 : 节点服务器磁盘信息。 取值范围 : 不涉及。 |
| tags | Array of TagKv objects | 参数解释 : 租户标签。 取值范围 : 不涉及。 |
| image_id | String | 参数解释 : 服务器镜像ID。 取值范围 : 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| vpc_id | String | 参数解释 : 服务器所在虚拟私有云ID。 取值范围 : 不涉及。 |
| subnet_id | String | 参数解释 : 子网ID。 取值范围 : 不涉及。 |
| port_id | String | 参数解释 : 网卡ID。 取值范围 : 不涉及。 |
| is_primary | Boolean | 参数解释 : 是否主网卡。 取值范围 : |
| uboe_enable | Boolean | 参数解释 : 是否启用UBOE。 取值范围 : |
| public_ip | public_ip object | 参数解释 : 弹性公网IP信息。 取值范围 : 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释 : 弹性公网IP ID。 取值范围 : 不涉及。 |
| ip_address | String | 参数解释 : 弹性公网IP地址。 取值范围 : 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| charging_mode | String | 参数解释: 付费类型。 取值范围: |
| order_id | String | 参数解释 : 订单ID。 取值范围 : 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_type | String | 参数解释: 节点服务器类型。 取值范围: |
| instance_id | String | 参数解释 : 服务器所属的HPS对应的ECS资源ID。 取值范围 : 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| size | Integer | 参数解释 : EVS盘大小。 取值范围 : 1~32768。 |
| is_root | Boolean | 参数解释 : 是否系统盘。 取值范围 : |
| is_bind | Boolean | 参数解释 : 磁盘是否为创建时强绑定的磁盘,强绑定的磁盘不允许卸载。 取值范围 : |
| volume_type | String | 参数解释 : EVS盘类型。 取值范围 : 不涉及。 |
| volume_id | String | 参数解释 : EVS盘的ID。 取值范围 : 不涉及。 |
请求示例
查询节点列表请求示例。使用场景:用户需要查询节点列表,通过指定过滤条件查询。
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/nodes?limit=10 响应示例
状态码:200
查询成功,返回节点实例列表
ListNodes成功响应示例
{
"nodes" : [ {
"id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name" : "node-example",
"node_type" : "c7.large.2",
"keypair_name" : "my-keypair",
"availability_zone_id" : "cn-north-4a",
"cluster_id" : "12345678-1234-1234-1234-123456789abc",
"hyper_group_id" : "23456789-2345-2345-2345-234567890bcd",
"hypernode_id" : "34567890-3456-3456-3456-345678901cde",
"status" : "RUNNING",
"frozen_status" : [ ],
"network_interfaces" : [ {
"vpc_id" : "vpc-12345678",
"subnet_id" : "subnet-12345678",
"port_id" : "port-12345678",
"is_primary" : true,
"public_ip" : {
"id" : "eip-12345678",
"ip_address" : "123.123.123.123"
}
} ],
"market_info" : {
"charging_mode" : "prePaid",
"order_id" : "CS21090912345678"
},
"created_at" : "2024-01-01T00:00:00.000+08:00",
"updated_at" : "2024-01-01T00:00:00.000+08:00",
"provider_resource_info" : {
"instance_type" : "ECS",
"instance_id" : "45678901-4567-4567-4567-456789012def"
},
"volumes" : [ {
"size" : 40,
"is_root" : true,
"volume_type" : "SSD",
"volume_id" : "56789012-5678-5678-5678-567890123efa"
} ],
"image_id" : "67890123-6789-6789-6789-678901234fab"
} ],
"page_info" : {
"next_marker" : null,
"current_count" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功,返回节点实例列表 |
错误码
请参见错误码。