Listing Edge Sites

Function

This API is used to list edge sites.

This API supports fine-grained permissions for enterprise projects. For details, see ies:edgeSite:list.

URI

GET /v1/{domain_id}/edge-sites

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the URI.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	The number of records on each page.
marker	No	String	Pagination marker.
sort_key	No	Array of strings	Field for sorting.
sort_dir	No	Array of strings	Sorting order. Options: desc: descending order asc: ascending order
enterprise_project_id	No	Array of strings	Enterprise project ID. This parameter can be used to filter edge sites of an enterprise project. The value is 0 or a string that contains a maximum of 36 bytes in UUID format with hyphens (-). Value 0 indicates the default enterprise project. To obtain edge sites of all enterprise projects, set this parameter to all_granted_eps. If the parameter is not set, all edge sites are queried.
id	No	Array of strings	The edge site ID used for query. Sorting is supported.
name	No	Array of strings	The edge site name used for query (exact match). Sorting is supported.
availability_zone_id	No	Array of strings	Edge AZ ID used for query.
status	No	Array of strings	Edge site deployment status used for query.

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
edge_sites	Array of EdgeSiteDetail objects	Edge site list.
page_info	PageInfo object	Pagination information.

**Table 5** EdgeSiteDetail
Parameter	Type	Description
id	String	Edge site ID.
domain_id	String	ID of the account that the edge site belongs to.
name	String	Edge site name.
description	String	Edge site description.
region_id	String	ID of the region to which the edge site belongs.
project_id	String	ID of the project that the edge site belongs to.
availability_zone_id	String	AZ ID of the edge site.
status	String	Edge site deployment status. Options: - initial: To be deployed - deploying: Deploying - available: Available - unavailable: Unavailable
location	LocationDetail object	Location details.
enterprise_project_id	String	ID of the enterprise project that the edge site belongs to.
created_at	String	Time when an edge site was registered.
updated_at	String	Time when an edge site was updated.

**Table 6** LocationDetail
Parameter	Type	Description
name	String	Location name (discarded). This parameter is invalid even if it is transferred and will not be returned for new sites.
description	String	Location description.
zone_code	String	Area where the location is located.
address	String	Deployment location.
condition	Condition object	Location conditions.

**Table 7** Condition
Parameter	Type	Description
environment	Integer	Equipment room environment. Options: 0: None 1: This is a modular data center. 2: The data center has earned national or industry-level certifications.
space	Integer	Rack space. Options: 0: There is no space available. 1: There is room for more than three racks. 2: There is room for up to three racks.
transport	Integer	Rack transportation conditions. Options: 0: The height or width of the transportation passages or doors in the equipment room does not meet requirements. 1: The passages, freight elevators, or doors in the equipment room allow racks to be transported on their rollers. 2: The passages, freight elevators, or doors in the equipment room do not allow racks to be transported on their rollers. There are steps along the way.
installation	String	Rack installation. Options: UNCLEAR: Unknown UNSUPPORT: Devices need to be installed in existing racks. SUPPORT: New racks can be added to a rack group.

**Table 8** PageInfo
Parameter	Type	Description
next_marker	String	Marker of the next page.
current_count	Integer	The number of records on the current page.

Example Request

Listing edge sites

GET https://{ies_endpoint}/v1/{domain_id}/edge-sites?id=cc89b1e5-521d-4a85-be83-e6f7217fc63e

Example Response

Status code: 200

successful operation

{
  "edge_sites" : [ {
    "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e",
    "domain_id" : "2b76febbe5d34eac85d26435c1f15809",
    "name" : "Test site",
    "description" : "The test site is located in Anhui.",
    "region_id" : "cn-north-4",
    "project_id" : "060576838600d5762f2dc000470eb164",
    "availability_zone_id" : null,
    "status" : "initial",
    "location" : {
      "description" : "Location information",
      "zone_code" : "CN",
      "address" : "Yaohai District in Hefei, Anhui",
      "condition" : {
        "environment" : 0,
        "space" : 0,
        "transport" : 0,
        "installation" : "SUPPORT"
      }
    },
    "enterprise_project_id" : "06fb8917-442d-4d4d-bcdb-79eb3e7b7b5d",
    "created_at" : "2022-04-15T07:59:20.641Z",
    "updated_at" : null
  } ],
  "page_info" : {
    "current_count" : 1
  }
}