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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ies:edgeSite:list	List	edgeSite *	-	-	-
ies:edgeSite:list	List	-	g:EnterpriseProjectId	-	-

URI

GET /v1/{domain_id}/edge-sites

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID in the path.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Page size.
marker	No	String	Pagination identifier.
sort_key	No	Array of strings	Sorting field.
sort_dir	No	Array of strings	Sorting order. The options are as follows: desc: descending order asc: ascending order
enterprise_project_id	No	Array of strings	Enterprise project ID. This parameter can be used to query the edge sites associated with an enterprise project. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. To query the edge sites associated with all enterprise projects of the user, set this parameter to all_granted_eps. If the parameter is not set, all edge sites will be queried.
id	No	Array of strings	Search by edge site ID. Sorting is supported.
name	No	Array of strings	Search by edge site name (exact matching). Sorting is supported.
availability_zone_id	No	Array of strings	Search by edge AZ ID.
status	No	Array of strings	Search by edge site deployment status (exact matching).

Request Parameters

**Table 3** Request header parameters
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	Edge site account ID
name	String	Edge site name
description	String	Edge site description
region_id	String	Edge site region ID
project_id	String	Edge site project ID
availability_zone_id	String	Edge site AZ ID
status	String	Edge site deployment status
location	LocationDetail object	Details about the location.
enterprise_project_id	String	ID of the enterprise project that the edge site belongs to.
created_at	String	Time when an edge site was created
updated_at	String	Time when an edge site was updated

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

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

**Table 8** PageInfo
Parameter	Type	Description
next_marker	String	Next page marker.
current_count	Integer	Number of records on the current page.

Example Requests

Listing

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

Example Responses

Status code: 200

successful operation

{
  "edge_sites" : [ {
    "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e",
    "domain_id" : "2b76febbe5d34eac85d26435c1f15809",
    "name" : "Test site",
    "description" : "Location: Anhui",
    "region_id" : "cn-north-4",
    "project_id" : "060576838600d5762f2dc000470eb164",
    "availability_zone_id" : null,
    "status" : "initial",
    "location" : {
      "description" : "Site location",
      "zone_code" : "CN",
      "address" : "Location of the test site: 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
  }
}