Registering an Edge Site

Function

This API is used to register an edge site.

An edge site is associated with a Huawei Cloud region.
This API supports fine-grained permissions for enterprise projects. For details, see ies:edgeSite:create.

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:create	Write	edgeSite *	-	-	-
ies:edgeSite:create	Write	-	g:EnterpriseProjectId	-	-

URI

POST /v1/{domain_id}/edge-sites

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

Request Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
edge_site	Yes	CreateEdgeSite object	Edge site parameters

**Table 4** CreateEdgeSite
Parameter	Mandatory	Type	Description
name	Yes	String	Edge site name. The name can contain a maximum of 64 bytes. Only letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-) are allowed.
region_id	Yes	String	Region ID of the edge site. The ID can contain a maximum of 64 bytes. Only letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-) are allowed.
project_id	No	String	ID of the project that the edge site belongs to.
description	No	String	Edge site description. The description can contain a maximum of 255 bytes and cannot contain angle brackets (<>).
location	Yes	CreateLocation object	Location information.
enterprise_project_id	No	String	Enterprise project ID.

**Table 5** CreateLocation
Parameter	Mandatory	Type	Description
name	No	String	Location name (discarded). This parameter will not be stored persistently and will not be returned for new sites.
address	No	String	Province or state of the site.
zone_code	No	String	Area where the site is located.
condition	Yes	Condition object	Conditions at the location.
description	No	String	Location description. The description can contain a maximum of 255 bytes and cannot contain angle brackets (<>).

**Table 6** Condition
Parameter	Mandatory	Type	Description
environment	No	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	No	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	No	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	No	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.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
edge_site	EdgeSiteDetail object	Edge site information

**Table 8** 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 9** 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 10** 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.

Example Requests

Example request for creating an edge site in cn-north-4 (Beijing 4) in Yaohai District in Hefei, Anhui, China. It is uncertain whether the equipment room meets the requirements. Rack expansion is not planned. The height or width of the transportation passage and equipment room door does not meet the requirements. New racks can be integrated into the existing rack group.

POST https://{ies_endpoint}/v1/{domain_id}/edge-sites

{
  "edge_site" : {
    "name" : "Test site",
    "description" : "Location: Anhui",
    "region_id" : "cn-north-4",
    "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
      }
    }
  }
}

Example Responses

Status code: 200

successful operation

{
  "edge_site" : {
    "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,
    "enterprise_project_id" : "0",
    "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"
      }
    },
    "created_at" : "2022-04-15T07:59:20.641Z",
    "updated_at" : null
  }
}