Querying Site Information

Function

Queries site information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/sites

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
availability_zone_id	No	String	AZ.
site_type	No	String	Site type. The value can be CENTER or IES.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
site_infos	Array of SiteInfo objects	Site information list.
total_count	Integer	Total number of sites.

**Table 5** SiteInfo
Parameter	Type	Description
site_id	String	Site ID.
site_name	String	Site name.
site_type	String	Configuration status. CENTER: center initialization IES: edge initialization
project_id	String	Project ID.
status	String	Site status.
create_time	String	Creation time.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/fb2e5ec048384c8f9469d22db0037908/sites

Example Responses

Status code: 200

Queries site information.

{
  "site_infos" : [ {
    "site_id" : "22033f05-b7e1-44c4-a45f-630aa8acc42c",
    "site_name" : "Huawei Cloud Central Site",
    "az_code" : "cn-north-7a,cn-north-7b,cn-north-7c",
    "site_type" : "CENTER",
    "project_id" : "902b906e372241fe9b4e2e7280d64613",
    "status" : "openSuccess"
  } ]
}

Status Codes

Status Code	Description
200	Queries site information.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.