获取节点池列表及详情--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取节点池列表及详情

最近更新时间：2024.12.04 14:07:17首次发布时间：2023.08.24 19:59:29

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

请求说明

请求方式：POST
请求地址：https://veecp.volcengineapi.com/?Action=

ListEdgeNodePools&Version=2021-03-03

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	ListEdgeNodePools	公共参数。该参数表示接口名称。本接口取值为 `ListEdgeNodePools`。
Version	String	是	2021-03-03	公共参数。该参数表示接口版本。本接口取值为`2021-03-03`。
Filter	ListEdgeNodePoolsFilter	否	详见请求示例	filter中包含众多字段，查看结构体定义。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	PageSize	Integer	否	10

请求示例

POST https://veecp.volcengineapi.com/?Action=ListEdgeNodePools&Version=2021-03-03&<其他公共参数>
{
  "Filter": {
    "ClusterIds": [
      "ccfc8stfqtofshjoqcl0g"
    ],
    "Statuses": [],
    "NodePoolTypes": [
      "edge-machine-set"
    ]
  },
  "PageNumber": 1,
  "PageSize": 10
}

返回参数

参数	类型	示例值	描述
Items	[]EdgeNodePool	详见返回示例	节点池列表
TotalCount	int32	1	符合条件的节点池总数
PageNumber	int32	1	分页总数
PageSize	int32	10	当前页码

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306151450**********",
        "Action": "ListEdgeNodePools",
        "Version": "2021-03-03",
        "Service": "veecp_openapi",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "pci3e27fqt*******",
                "Name": "",
                "ClusterId": "",
                "KubernetesConfig": {
                    "Labels": [],
                    "Taints": []
                },
                "Status": {
                    "Phase": "Creating",
                    "Conditions": [
                        {
                            "Type": "Progressing"
                        }
                    ]
                },
                "NodeStatistics": {
                    "TotalCount": 0,
                    "CreatingCount": 0,
                    "RunningCount": 0,
                    "UpdatingCount": 0,
                    "DeletingCount": 0,
                    "FailedCount": 0,
                    "StoppingCount": 0,
                    "StoppedCount": 0,
                    "StartingCount": 0
                },
                "CreateTime": "2023-06-12T09:10:53Z",
                "UpdateTime": "2023-06-12T09:10:53Z",
                "CreateClientToken": "",
                "UpdateClientToken": "",
                "Profile": "Edge",
                "Type": "edge-machine-set",
                "ElasticConfig": {
                    "CloudServerIdentity": "",
                    "AutoScaleConfig": {
                        "Enabled": false,
                        "DesiredReplicas": 0,
                        "MinReplicas": 0,
                        "MaxReplicas": 0,
                        "Priority": 0
                    },
                    "InstanceArea": {
                        "AreaName": "",
                        "Isp": "",
                        "ClusterName": "",
                        "DefaultIsp": "",
                        "ExternalNetworkMode": ""
                    }
                }
            }
        ],
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

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