本接口用于获取符合指定查询条件的边缘实例的列表。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数，请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListInstances | 公共参数。该参数表示接口名称。取值：ListInstances。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值：2021-04-30。 |
countries | String | 否 | CN | 国家。 |
regions | String | 否 | CentralChina | 区域。区域之间用半角逗号（,）分隔。 |
cities | String | 否 | 430600 | 城市代码。城市之间用半角逗号（,）分隔。 |
isps | String | 否 | CTCC | 运营商。运营商之间用半角逗号（,）分隔。 |
status | String | 否 | running | 边缘实例的状态。实例状态之间用半角逗号（,）分隔。取值范围：
|
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 | 边缘实例名称。名称之间用半角逗号（,）分隔。 |
vpc_identities | String | 否 | vpc-sbjngs**** | 私有网络 ID。ID 之间用半角逗号（,）分隔。 |
page | Integer | 否 | 1 | 边缘实例列表的页码。 |
limit | Integer | 否 | 10 | 分页查询时设置的每页行数。 |
order_by | Integer | 否 | 1 | 查询出来的边缘实例的排列顺序，按照创建时间排序。取值范围：
|
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
instances | 请参见返回示例 | 边缘实例信息。 | |
total_count | Integer | 1 | 边缘实例个数。 |
GET https://veenedge.volcengineapi.com/?Action=ListInstances&Version=2021-04-30 &cluster_names=**cm02 &<其他公共参数>
{
"ResponseMetadata": {
"RequestId": "202407081154011AF64F50C662692B****",
"Action": "ListInstances",
"Version": "2021-04-30",
"Service": "veenedge",
"Region": "cn-north-1"
},
"Result": {
"instances": [
{
"instance_identity": "veen210541172832123****",
"instance_uuid": "5c10aae4-c961-5f21-a42b-44298f0****",
"instance_name": "",
"load_type": "virtual_machine",
"cloud_server_identity": "cloudserver-mtcsppb9q****",
"cloud_server_name": "测试LB7",
"vpc_identity": "vpc-qfj78n****",
"namespace": "ns-210006****",
"subnet_cidr": "172.**.***.64/26",
"cluster": {
"cluster_name": "****cm02",
"country": "CN",
"region": "Northeast",
"province": "LN",
"city": "210200",
"isp": "CMCC",
"level": "2",
"alias": "**移动02"
},
"spec": "veEN.G1.large",
"spec_display": "通用型 | 2C8G",
"cpu": "2",
"mem": "8",
"status": "running",
"creator": "ve**",
"image": {
"image_identity": "imagelgnzqa****",
"image_name": "centos-7.2-amd64",
"system_arch": "Linux",
"system_type": "CentOS",
"system_bit": "64位",
"system_version": "7.2",
"property": "PublicBaseImage",
"disable_vga": false,
"image_boot_mode": "BIOS",
"gpu_version_info": {
"driver_version": "",
"cuda_version": "",
"cudnn_version": ""
}
},
"storage": {
"system_disk": {
"storage_type": "CloudBlockSSD",
"capacity": "40"
},
"data_disk": {
"storage_type": "CloudBlockSSD",
"capacity": "20"
},
"data_disk_list": [
{
"storage_type": "CloudBlockSSD",
"capacity": "20"
}
]
},
"network": {
"internal_interface": {
"ip_addr": "172.**.**.77",
"mask": "26",
"ip6_addr": "",
"mask6": "",
"ips": [
{
"addr": "172.**.**.77",
"mask": "26",
"isp": "",
"ip_version": "ipv4",
"primary": true
}
],
"mac_addr": "0a:58:**:**:71:4d",
"bandwidth_peak": "500"
},
"external_interface": {
"ip_addr": "120.**.**.4",
"mask": "24",
"ip6_addr": "",
"mask6": "",
"ips": [
{
"addr": "120.**.**.4",
"mask": "24",
"isp": "CMCC",
"ip_version": "ipv4"
}
],
"mac_addr": "0a:58:**:**:f4:04",
"bandwidth_peak": "5",
"bandwidth_package_id": 99**
},
"external_interfaces": [
{
"ip_addr": "120.**.**.4",
"mask": "24",
"ip6_addr": "",
"mask6": "",
"ips": [
{
"addr": "120.**.**.4",
"mask": "24",
"isp": "CMCC",
"ip_version": "ipv4"
}
],
"mac_addr": "0a:58:**:**:f4:04",
"bandwidth_peak": "5",
"bandwidth_package_id": 998
}
],
"default_isp": "",
"dns_type": "default",
"dns_list": [
"114.114.114.114",
"180.184.1.1"
],
"bandwidth_peak_update_status": "ready",
"limit_mode": "shared"
},
"gpu": {
"gpus": []
},
"secret": {
"secret_type": 3,
"secret_data": "sshkey-h4nl4gd7b****"
},
"billing": {
"computing_billing_method": "MonthlyPeak",
"bandwidth_billing_method": "MonthlyP95"
},
"account": {
"account_identity": 210006****
},
"instance_desc": "",
"host_name": "",
"arch": "x86",
"monitor_agent": {
"agent_status": "stopped"
},
"project": "default",
"spec_feature": 0,
"subnet_identity": "subnet-p76xdmvwzr****",
"advanced_configuration": {
"delete_protection": false
},
"start_time": 1716454985,
"end_time": 0,
"create_time": 1716454939,
"update_time": 1716454985
}
],
"total_count": 1
}
}
如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。