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

获取边缘实例列表

最近更新时间：2023.08.16 16:39:05

首次发布时间：2022.02.25 18:58:31

我的收藏

本接口用于列出指定的边缘服务或所有边缘服务下的边缘实例。

请求方法

GET

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

是

ListInstances

公共参数。该参数表示接口名称。取值：ListInstances。

Version

String

是

2021-04-30

公共参数。该参数表示接口版本。取值：2021-04-30。

countries

String

否

CN

国家。

regions

String

否

CentralChina

区域。区域之间用半角逗号（,）分隔。
您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

cities

String

否

430600

城市代码。城市之间用半角逗号（,）分隔。
您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

isps

String

否

CTCC

运营商。运营商之间用半角逗号（,）分隔。
您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

status

String

否

running

边缘实例的状态。实例状态之间用半角逗号（,）分隔。取值范围：

  • opening：创建中。
  • starting：启动中。
  • running：运行中。
  • stopping：停止中。
  • stop：已停止。
  • rebooting：重启中。
  • terminating：删除中。
  • open_fail：创建失败。

cluster_names

String

否

nbct01

节点名称的列表。名称之间用半角逗号（,）分隔。

ips

String

否

172.31.**.**

IP 地址列表。IP 之间用半角逗号（,）分隔。

cidrs

String

否

172.**.**.128/26

子网 CIDR 地址列表。CIDR 地址之间用半角逗号（,）分隔。

cloud_server_identities

String

否

cloudserver-8bvl8r6xcn****

边缘服务 ID 列表。ID 之间用半角逗号（,）分隔。

spec_names

String

否

veEN.R1.large

边缘实例规格名称。实例规格之间用半角逗号（,）分隔。

instance_identities

String

否

veen1020125208252511****

边缘实例 ID。ID 之间用半角逗号（,）分隔。

instance_uuids

String

否

67a7f071-6403-5a9e-826a-3e68cf9e****,67a7f071-6403-5a9e-826a-3e68cf9e****

边缘实例 UUID。UUID 之间用半角逗号（,）分隔。

instance_names

String

否

name1,name2

边缘实例名称。名称之间用半角逗号（,）分隔。

fuzzy_ip_with_dots

String

否

123.23

IPv4 地址。支持模糊查询。IP 地址采用点分十进制格式。

vpc_identities

String

否

vpc-sbjngs****

私有网络 ID。ID 之间用半角逗号（,）分隔。

page

Integer

否

1

边缘实例列表的页码。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

limit

Integer

否

10

分页查询时设置的每页行数。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

order_by

Integer

否

1

查询出来的边缘实例的排列顺序，按照创建时间排序。取值范围：

  • 1（默认值）：按照降序排列。
  • 2：按照升序排列。

返回数据

名称

类型

示例值

描述

instances

[]VEENInstance

请参见返回示例

边缘实例信息。

total_count

Integer

1

边缘实例个数。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListInstances&Version=2021-04-30
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305301920046A3E6C1C4C7069DE****",
        "Action": "ListInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "instances": [
            {
                "instance_identity": "veen2011039290250111****",
                "instance_uuid": "22ea5c05-c55e-5a24-a785-ec0e2e47****",
                "instance_name": "",
                "load_type": "virtual_machine",
                "cloud_server_identity": "cloudserver-hgvbfwkpnsq****",
                "cloud_server_name": "cloud-test",
                "vpc_identity": "vpc-js85b4***",
                "namespace": "ns-210008****",
                "subnet_cidr": "172.**.**.128/26",
                "cluster": {
                    "cluster_name": "****-lyct02",
                    "country": "CN",
                    "region": "CentralChina",
                    "province": "HA",
                    "city": "410300",
                    "isp": "CTCC",
                    "level": "3",
                    "alias": "洛阳电信02"
                },
                "node_name": "node05.****02",
                "spec": "veEN.G1.large",
                "spec_display": "通用型 | 2C8G",
                "cpu": "2",
                "mem": "8",
                "status": "running",
                "creator": "creator_name",
                "image": {
                    "image_identity": "imagepnjk4y****",
                    "image_name": "centos-7.3-amd64",
                    "system_arch": "Linux",
                    "system_type": "CentOS",
                    "system_bit": "64位",
                    "system_version": "7.3",
                    "property": "PublicBaseImage",
                    "disable_vga": false,
                    "image_boot_mode": "BIOS"
                },
                "storage": {
                    "system_disk": {
                        "storage_type": "CloudBlockSSD",
                        "capacity": "50"
                    },
                    "data_disk": {
                        "storage_type": "CloudBlockSSD",
                        "capacity": "20"
                    },
                    "data_disk_list": [
                        {
                            "storage_type": "CloudBlockSSD",
                            "capacity": "20"
                        }
                    ]
                },
                "network": {
                    "internal_interface": {
                        "ip_addr": "172.**.**.130",
                        "mask": "26",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "addr": "172.**.**.130",
                                "mask": "26",
                                "isp": "",
                                "ip_version": "ipv4",
                                "primary": true
                            }
                        ],
                        "mac_addr": "0a:58:ac:**:**:82",
                        "bandwidth_peak": "20"
                    },
                    "external_interface": {
                        "ip_addr": "1.**.**.118",
                        "mask": "26",
                        "ip6_addr": "",
                        "mask6": "",
                        "ips": [
                            {
                                "addr": "1.**.**.118",
                                "mask": "26",
                                "isp": "CTCC",
                                "ip_version": "ipv4"
                            }
                        ],
                        "mac_addr": "0a:58:01:**:**:76",
                        "bandwidth_peak": "20"
                    },
                    "external_interfaces": [
                        {
                            "ip_addr": "1.**.**.118",
                            "mask": "26",
                            "ip6_addr": "",
                            "mask6": "",
                            "ips": [
                                {
                                    "addr": "1.**.**.118",
                                    "mask": "26",
                                    "isp": "CTCC",
                                    "ip_version": "ipv4"
                                }
                            ],
                            "mac_addr": "0a:58:01:**:**:76",
                            "bandwidth_peak": "20"
                        }
                    ],
                    "default_isp": "",
                    "dns_type": "default",
                    "dns_list": [
                        "114.114.114.114",
                        "223.6.6.6"
                    ]
                },
                "gpu": {
                    "gpus": []
                },
                "secret": {
                    "secret_type": 2
                },
                "instance_desc": "",
                "host_name": "",
                "arch": "x86",
                "start_time": 1684487383,
                "end_time": 0,
                "create_time": 1684487351,
                "update_time": 1684496628
            }
        ],
        "total_count": 1
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。