Querying Edge Sites

Function

Queries edge sites.

Debugging

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

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
workspace:sites:listEdgeSites	List	-	-	-	ies:edgeSite:list ies:edgeSite:getMetricData

URI

GET /v2/{project_id}/wks-edge-sites

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Queries edge sites by name.
availability_zone_id	No	String	Queries by edge AZ ID.
status	No	String	Queries by edge site deployment status.
limit	No	Integer	Number of records on each page. The value ranges from 0 to 1000 and defaults to 1000.
offset	No	Integer	Offset. The default value is 0.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
wks_edge_sites	Array of WksEdgeSiteDetail objects	Edge sites.
total_count	Integer	Total number of sites.

**Table 4** WksEdgeSiteDetail
Parameter	Type	Description
id	String	Edge site ID.
name	String	Edge site name.
description	String	Edge site description.
availability_zone_id	String	AZ ID of the edge site.
address	String	Deployment location.
status	String	Edge site deployment status. initial: to be deployed deploying: being deployed available unavailable
created_at	String	Time when the edge site is created.
updated_at	String	Time when the edge site is updated.
cpu_usage_rate	Double	CPU usage.
memory_usage_rate	Double	Memory usage.
capacity_usage_rate	Double	Storage usage.
site_info	SimpleSiteInfo object	Site information.

**Table 5** SimpleSiteInfo
Parameter	Type	Description
id	String	ID of the Workspace edge site.
status	String	Huawei Cloud Workspace service status. PREPARING: to be subscribed SUBSCRIBING: being subscribed SUBSCRIBED: subscribed SUBSCRIPTION_FAILED: subscription failed DEREGISTERING: being unsubscribed DEREGISTRATION_FAILED: unsubscription failed CLOSED: unsubscribed and not subscribed yet

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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 message.
error_detail	String	Error details.
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/wks-edge-sites

Example Responses

Status code: 200

Response to the request for querying edge sites.

{
  "wks_edge_sites" : [ {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "availability_zone_id" : "string",
    "address" : "string",
    "status" : "string",
    "created_at" : "string",
    "updated_at" : "string",
    "cpu_usage_rate" : 0,
    "memory_usage_rate" : 0,
    "capacity_usage_rate" : 0,
    "site_info" : {
      "id" : "string",
      "status" : "string"
    }
  } ],
  "total_count" : 0
}

Status Codes

Status Code	Description
200	Response to the request for querying edge sites.
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 about the error code, see the error code description.
503	Service unavailable.