文档首页/ 智能边缘云 IEC/ API参考/ API/ 边缘实例/ 查询边缘实例列表

更新时间：2024-01-02 GMT+08:00

查看PDF

查询边缘实例列表

功能介绍

查询边缘实例列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/cloudservers

表1 Query参数
参数	是否必选	参数类型	描述
id	否	String	边缘实例ID
area	否	String	边缘实例所在大区。
city	否	String	边缘实例所在城市。
edgecloud_id	否	String	边缘业务ID。
limit	否	Integer	查询返回边缘实例列表当前页面的数量。每页默认值是25，最多返回1000台边缘实例的信息，如果数据量过大建议设置成100。
name	否	String	查询条件，边缘实例名称。
offset	否	Integer	页码。当前页面数，默认为0。取值大于等于0，取值为0时返回第1页
province	否	String	边缘实例所在省份。
site_id	否	String	站点ID。
status	否	String	边缘实例的状态。取值范围：ACTIVE、BUILD、DELETED、ERROR、HARD_REBOOT、MIGRATING、PAUSED、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、SHELVED、SHELVED_OFFLOADED、SOFT_DELETED、SUSPENDED、VERIFY_RESIZE。非上面范围的status字段将返回空列表。说明：当边缘实例处于中间状态时，查询范围如下： ACTIVE，查询范围：ACTIVE，REBOOT，HARD_REBOOT，REBUILD，MIGRATING SHUTOFF，查询范围：SHUTOFF，RESIZE，REBUILD ERROR，查询范围：ERROR，REBUILD VERIFY_RESIZE，查询范围：VERIFY_RESIZE，REVERT_RESIZE

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
err_sites	Array of strings	异常站点。
count	Integer	边缘实例列表的总数。
servers	Array of Instance objects	边缘实例列表。

表4 Instance
参数	参数类型	描述
id	String	边缘实例ID。
name	String	边缘实例名称。
status	String	边缘实例状态。取值范围： BUILD、ACTIVE、FAILED、DELETED
updated	String	边缘实例修改时间。 UTC时间，格式：yyyy-mm-ddTss:ss:ssZ，例如：2021-04-25T03:21:39Z
hostId	String	边缘实例所在主机的主机ID。
addresses	Map<String,Array<InstanceAddress>>	边缘实例对应的网络地址信息，详情请参见表addresses字段数据结构说明。
created	String	边缘实例创建时间。时间格式：yyyy-mm-ddTss:ss:ssZ，例如：2021-04-25T02:46:23Z
tags	Array of strings	边缘实例标签。主要用来存储边缘业务ID。
locked	Boolean	边缘实例是否为锁定状态。 true：锁定 false：未锁定
description	String	边缘实例的描述信息。
tenant_id	String	边缘实例所属租户ID，即项目ID，和project_id表示相同的概念，格式为UUID。
sys_tags	Array of SysTags objects	边缘实例系统标签。
flavor	FlavorInstance object	边缘实例规格信息。
metadata	Map<String,String>	边缘实例元数据。
security_groups	Array of InstanceSecurityGroup objects	边缘实例所属安全组列表。
progress	Integer	边缘实例进度。
OS-EXT-STS:power_state	Integer	扩展属性，边缘实例电源状态。
OS-EXT-STS:vm_state	String	扩展属性，边缘实例当前状态。
OS-EXT-STS:task_state	String	边缘实例任务状态。
OS-DCF:diskConfig	String	扩展属性， diskConfig的类型。 MANUAL，镜像空间不会扩展。 AUTO，系统盘镜像空间会自动扩展为与flavor大小一致。
OS-EXT-AZ:availability_zone	String	扩展属性，边缘实例所在可用区名称。
OS-SRV-USG:launched_at	String	边缘实例启动时间。时间格式例如：2019-05-22T03:23:59.000000
OS-SRV-USG:terminated_at	String	边缘实例删除时间。时间格式例如：2019-05-22T03:23:59.000000
OS-EXT-SRV-ATTR:root_device_name	String	边缘实例系统盘的设备名称。
OS-EXT-SRV-ATTR:ramdisk_id	String	若使用AMI格式镜像，则表示ramdisk image的UUID；否则，留空。
OS-EXT-SRV-ATTR:kernel_id	String	若使用AMI格式的镜像，则表示kernel image的UUID；否则，留空。
OS-EXT-SRV-ATTR:launch_index	Integer	批量创建场景，边缘实例的启动顺序。
OS-EXT-SRV-ATTR:reservation_id	String	批量创建场景，边缘实例的预留ID。
OS-EXT-SRV-ATTR:hostname	String	边缘实例的主机名。
OS-EXT-SRV-ATTR:user_data	String	创建边缘实例时指定的user_data。
OS-EXT-SRV-ATTR:host	String	边缘实例所在主机的主机名称。
OS-EXT-SRV-ATTR:hypervisor_hostname	String	扩展属性，边缘实例所在虚拟化主机名。
os-extended-volumes:volumes_attached	Array of VolumesAttached objects	挂载到边缘实例上的磁盘。
geolocation	GeoLocation object	边缘实例所属的地理位置信息。包含了城市、省份、区域、国家的中英文信息。
edgecloud_id	String	边缘实例所属边缘业务的ID。
edgecloud_name	String	边缘实例所属边缘业务的名称
domain_id	String	帐号ID。
key_name	String	使用的密钥对名称。
OS-EXT-SRV-ATTR:instance_name	String	扩展属性，边缘实例别名。

表5 InstanceAddress
参数	参数类型	描述
OS-EXT-IPS-MAC:mac_addr	String	MAC地址。
OS-EXT-IPS:port_id	String	IP地址对应的端口ID。
OS-EXT-IPS:type	String	IP地址类型。 fixed：代表私有IP地址。 floating：代表浮动IP地址。
addr	String	IP地址。
version	String	IP地址版本。 “4”：代表IPv4。 “6”：代表IPv6。

表6 SysTags
参数	参数类型	描述
key	String	系统标签的Key值。
value	String	系统标签的value值。

表7 FlavorInstance
参数	参数类型	描述
id	String	边缘实例规格的ID。
name	String	边缘实例规格的名称。
disk	String	边缘实例规格对应要求系统盘大小。当前未使用该参数，缺省值为0。
ram	String	边缘实例规格对应的内存大小，单位为MB。
vcpus	String	边缘实例规格对应的CPU核数。

表8 InstanceSecurityGroup
参数	参数类型	描述
name	String	安全组名称或者UUID。
id	String	实例使用安全组规则的ID。

表9 VolumesAttached
参数	参数类型	描述
id	String	磁盘ID，格式为UUID。
bootIndex	String	启动标识。 “0”代表系统盘非“0”为数据盘。
delete_on_termination	String	删边缘实例时是否一并删除该磁盘。 true：是 false：否
device	String	硬盘挂载盘符，即磁盘挂载点。

**表10** GeoLocation
参数	参数类型	描述
id	String	地理位置信息ID。
area	String	所在大区。
city	String	所在城市。
country	String	所在的国家。
i18n_area	String	区域的国际化名称。
i18n_city	String	城市的国际化名称。
i18n_country	String	国家的国际化名称。
i18n_province	String	省份的国际化名称。
province	String	所在省份。

请求示例

GET https://{endpoint}/v1/cloudservers

响应示例

状态码： 200

{
  "count" : 1,
  "servers" : [ {
    "status" : "ACTIVE",
    "updated" : "2020-12-29T03:46:26Z",
    "hostId" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
    "addresses" : {
      "4a6d9663-475f-11eb-aa7c-fa16406a65c4" : [ {
        "version" : "4",
        "addr" : "172.16.0.204",
        "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:4e:dd:c9",
        "OS-EXT-IPS:port_id" : "1b1377d5-f74d-478c-9970-68d8b7b6d894",
        "OS-EXT-IPS:type" : "fixed"
      }, {
        "version" : "4",
        "addr" : "188.181.56.44",
        "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:4e:dd:c9",
        "OS-EXT-IPS:port_id" : "1b1377d5-f74d-478c-9970-68d8b7b6d894",
        "OS-EXT-IPS:type" : "floating"
      } ]
    },
    "id" : "d10f846a-d7a4-4ee7-9552-19f656d898e6",
    "name" : "IEC-ZS01-res-ga2n-0001",
    "created" : "2020-12-29T03:45:56Z",
    "tags" : [ "__type_iec=__type_iec", "area=south", "province=guangdong", "city=zhongshan", "operator=chinaunicom", "edgecloud=528cb435-4988-11eb-8603-fa1640aee23e", "resourceID=5403ddae-4988-11eb-8603-fa1640aee23e" ],
    "description" : "",
    "locked" : false,
    "tenant_id" : "",
    "sys_tags" : [ {
      "key" : "_sys_enterprise_project_id",
      "value" : "0"
    } ],
    "flavor" : {
      "disk" : "0",
      "vcpus" : "2",
      "ram" : "4096",
      "id" : "kc1.large.2",
      "name" : "kc1.large.2"
    },
    "metadata" : {
      "charging_mode" : "0",
      "vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4",
      "EcmResStatus" : "",
      "image_name" : "CentOS 7.0 64bit",
      "os_bit" : "64",
      "lock_check_endpoint" : "",
      "lock_source" : "",
      "lock_source_id" : "",
      "lock_scene" : "",
      "eip_type" : ""
    },
    "security_groups" : [ {
      "name" : "stock_sg_changsha568"
    } ],
    "key_name" : "",
    "progress" : 0,
    "OS-EXT-STS:power_state" : 1,
    "OS-EXT-STS:vm_state" : "active",
    "OS-EXT-STS:task_state" : "",
    "OS-DCF:diskConfig" : "MANUAL",
    "OS-EXT-AZ:availability_zone" : "edgecloud-site3",
    "OS-SRV-USG:launched_at" : "2020-12-29T03:46:10.000000",
    "OS-SRV-USG:terminated_at" : "",
    "OS-EXT-SRV-ATTR:root_device_name" : "/dev/vda",
    "OS-EXT-SRV-ATTR:ramdisk_id" : "",
    "OS-EXT-SRV-ATTR:kernel_id" : "",
    "OS-EXT-SRV-ATTR:launch_index" : 0,
    "OS-EXT-SRV-ATTR:reservation_id" : "r-cm8o05kr",
    "OS-EXT-SRV-ATTR:hostname" : "iec-zs01-res-ga2n-0001",
    "OS-EXT-SRV-ATTR:user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiR1RnFESEIkdXV1THhibEIuNjRtMGVWS3lvbzAuUjdhNExuNmYxdDU1dTJZcHViM2ZZVExyUHRhNG5DNUk3RTVtdGtyUFQwMkNMbmtPS1FrTHM4ZmhycUFqcmZISjEnIHwgY2hwYXNzd2QgLWU7",
    "OS-EXT-SRV-ATTR:host" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
    "OS-EXT-SRV-ATTR:instance_name" : "instance-0000afd6",
    "OS-EXT-SRV-ATTR:hypervisor_hostname" : "11145fe342232beffd5e161599261a4ca047d6b7d138648959fe432b",
    "os-extended-volumes:volumes_attached" : [ {
      "id" : "80230eb5-55ef-4d82-aa0a-e0c5bdc1c627",
      "delete_on_termination" : "true",
      "bootIndex" : "0",
      "device" : "/dev/vda"
    } ],
    "edgecloud_id" : "528cb435-4988-11eb-8603-fa1640aee23e",
    "edgecloud_name" : "iec-nazt",
    "geolocation" : {
      "id" : "6813be76-7322-11ea-9ce0-286ed488d287",
      "city" : "zhongshan",
      "i18n_city" : "中山市",
      "province" : "guangdong",
      "i18n_province" : "广东",
      "area" : "south",
      "i18n_area" : "华南地区",
      "country" : "china",
      "i18n_country" : "中国"
    },
    "domain_id" : "2b76febbe5d34eac85d26435c1f15809"
  } ]
}

状态码

状态码	描述
200	OK

错误码

请参见错误码。

父主题： 边缘实例

上一篇：边缘实例

下一篇：创建边缘实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询边缘实例列表

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线