查询边缘业务列表 - ListEdgeCloud

功能介绍

查询边缘业务列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/edgeclouds

表1 Query参数
参数	是否必选	参数类型	描述
id	否	String	边缘业务ID。
limit	否	Integer	查询返回边缘业务列表当前页面的数量。取值范围：0~1000。
name	否	String	边缘业务名称。
offset	否	Integer	偏移量。当前偏移量，默认为0。

请求参数

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

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
count	Integer	边缘业务数量。
edgeclouds	Array of EdgeCloud objects	边缘业务列表。

表4 EdgeCloud
参数	参数类型	描述
id	String	边缘业务ID。
name	String	边缘业务名称。取值范围：只能由中文字符、大小写英文字母、数字及中划线、下划线组成，且长度为[1-32]个字符。
description	String	边缘业务描述。最大支持255字节。
coverage	CoverageResp object	边缘业务覆盖策略
failed_num	Integer	创建失败的虚拟机
status	String	边缘业务状态。取值范围： creating/scheduling/updating：部署中 inService：运行中 failed：创建失败 deleting：删除中 delFailed：删除失败
success_num	Integer	成功创建的虚拟机
edge_regions	Integer	边缘业务支持的边缘区域数目。

表5 CoverageResp
参数	参数类型	描述
coverage_policy	String	区域调度策略，只支持centralize/discrete。 centralize：代表城市集中策略，指定该策略，边缘业务创建时会保证将所有实例都发放在同一个站点。 discrete：代表城市分散，指定该策略，边缘业务创建时，尽量保证所有实例都分散发放在不同站点。
coverage_level	String	区域分布层级，只支持area/prov/city/site。 area:大区，用户的资源会在指定大区下发放。 prov:省份，用户的资源会在指定省份下发放。 city:城市，用户的资源会在指定城市下发放。 site:站点级别。约束：站点层级，coverage_policy上仅支持'centralize'，coverage_sites中'site'字段仅支持使用ID(站点ID，通过“查询边缘站点列表”获取)，不支持name。
coverage_sites	Array of CoverageSiteResp objects	区域及购买数量列表。

表6 CoverageSiteResp
参数	参数类型	描述
site	String	站点名称。具体信息可通过调用“查询边缘站点列表”来查询(注意：本字段区分大小写)。
demands	Array of DemandResp objects	租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。
i18n_site	String	覆盖区域的国际化信息。

表7 DemandResp
参数	参数类型	描述
demand_count	Integer	站点需要发放的资源(组)总数。说明：实际发放实例数量为count*demand_count。
pool_id_v6	String	指定IPv6线路，使用该线路下的子网分配IPv6端口。如果该线路下没有关联启用IPv6的子网，则创建新的子网。
ipv6_bandwidth_enable	Boolean	使用IPv6带宽。边缘实例是否开启IPv6公网访问能力。如果该IPv6线路下没有带宽，则创建新的带宽。

请求示例

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

响应示例

状态码：200

{
  "count" : 1,
  "edgeclouds" : [ {
    "id" : "27101e92-49a7-11eb-8a8a-fa1640495574",
    "name" : "edgecloud1",
    "coverage" : {
      "coverage_policy" : "centralize",
      "coverage_level" : "city",
      "coverage_sites" : [ {
        "site" : "xi'an",
        "i18n_site" : "西安市",
        "demands" : [ {
          "demand_count" : 1
        } ]
      } ]
    },
    "success_num" : 0,
    "failed_num" : 1,
    "status" : "failed",
    "edge_regions" : 1
  } ]
}