You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /
  • 边缘计算节点

获取节点列表及详情

最近更新时间：2023.10.08 19:44:29

首次发布时间：2023.08.24 19:59:30

我的收藏

本接口用于查询符合条件的节点信息列表。

请求方式

POST

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。

名称

类型

是否必选

示例值

描述

Action

String

是

ListEdgeNodes

公共参数。该参数表示接口名称。本接口取值为
ListEdgeNodes。

Version

String

是

2022-05-12

公共参数。该参数表示接口版本。 本接口取值为2022-05-12。

Filter

ListEdgeNodesFilter

否

{
    "ClusterIds": [
      "ccfc8stfqtofs*******"
    ],
    "Statuses": [],
    "NodePoolTypes": [
      "edge-machine-set"
    ]
 }

filter中包含众多字段，查看结构体定义。

PageNumber

Integer

否

1

分页查询时的起始页码，从 1 开始，默认为 1。

PageSize

Integer

否

10

分页查询时每页显示的记录数，取值：

  • 最小值：1
  • 最大值：100
  • 默认值：10

请求示例

POST https://veecp.volcengineapi.com/?Action=ListEdgeNodes&Version=2021-03-03&<其他公共参数>
{
  "Filter": {
    "ClusterIds": [
      "ccd17msvqtofom766039g"
    ]
  },
  "PageNumber": 1,
  "PageSize": 100,
}

返回参数

名称

类型

示例值

描述

Items

[]EdgeNode

[
            {
                "Id": "ncho6uo5o*******",
                "Name": "",
                "ClusterId": "ccd0e1rnq*******",
                "NodePoolId": "pcd0ev1vq*******",
                "Status": {
                    "Phase": "Creating",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateTime": "2023-05-26T08:35:43Z",
                "UpdateTime": "2023-05-26T08:35:43Z",
                "CreateClientToken": "",
                "Profile": "Edge",
                "EdgeNodeType": "PrivateEdgeNode",
                "ProviderId": "",
                "InstanceId": "ncho6uo5o*******"
            },
            {
                "Id": "ncho6undou*******",
                "Name": "",
                "ClusterId": "ccd0e1rnq*******",
                "NodePoolId": "pcd0ilsv********",
                "Status": {
                    "Phase": "Creating",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateTime": "2023-05-26T08:35:41Z",
                "UpdateTime": "2023-05-26T08:35:41Z",
                "CreateClientToken": "",
                "Profile": "Edge",
                "EdgeNodeType": "PrivateEdgeNode",
                "ProviderId": "",
                "InstanceId": "ncho6undou**********"
            }
        ]

符合条件的节点列表。

TotalCount

int32

1

符合条件的节点总数

PageNumber

int32

1

分页总数

PageSize

int32

10

当前页码

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061514*********",
        "Action": "ListEdgeNodes",
        "Version": "2021-03-03",
        "Service": "veecp_openapi",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "ncho6uo5o*******",
                "Name": "",
                "ClusterId": "ccd0e1rnq*******",
                "NodePoolId": "pcd0ev1vq*******",
                "Status": {
                    "Phase": "Creating",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateTime": "2023-05-26T08:35:43Z",
                "UpdateTime": "2023-05-26T08:35:43Z",
                "CreateClientToken": "",
                "Profile": "Edge",
                "EdgeNodeType": "PrivateEdgeNode",
                "ProviderId": "",
                "InstanceId": "ncho6uo5o*******"
            },
            {
                "Id": "ncho6undou*******",
                "Name": "",
                "ClusterId": "ccd0e1rnq*******",
                "NodePoolId": "pcd0ilsv********",
                "Status": {
                    "Phase": "Creating",
                    "Conditions": [
                        {
                            "Type": "Ok"
                        }
                    ]
                },
                "CreateTime": "2023-05-26T08:35:41Z",
                "UpdateTime": "2023-05-26T08:35:41Z",
                "CreateClientToken": "",
                "Profile": "Edge",
                "EdgeNodeType": "PrivateEdgeNode",
                "ProviderId": "",
                "InstanceId": "ncho6undou**********"
            }
        ],
        "TotalCount": 2,
        "PageNumber": 0,
        "PageSize": 0
    }
}

错误码

本接口无特有错误码，其他错误码请参见错误码。