Checking Edge Site Resources

Function

Checks edge site resources.

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:checkEdgeSiteResources	Write	-	-	-	ies:edgeSite:list ies:edgeSite:getMetricData

URI

POST /v2/{project_id}/check-edge-site-resources

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
availability_zone_id	Yes	String	AZ ID.
flavor_id	No	String	Specification ID.
resource_counts	No	Integer	Number of required resources.
volumes	No	Array of CheckEdgeSiteResourcesVolume objects	List of disks, including the system disk.

**Table 3** CheckEdgeSiteResourcesVolume
Parameter	Mandatory	Type	Description
type	Yes	String	Disk type.
size	Yes	Long	Disk size, in GB.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
is_enough	Integer	Whether quotas are enough. The value can be 1 (yes) and 0 (no).
resource_remainder	Array of ResourceRemainderData objects	Number of remaining resources.

**Table 5** ResourceRemainderData
Parameter	Type	Description
type	String	Resource type.
remainder	Long	Number of remaining resources.
need	Long	Number of required resources.
volume_type	String	Disk type. This parameter is returned when type is set to volume_gigabytes.

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

POST /v2/fb2e5ec048384c8f9469d22db0037908/check-edge-site-resources

{
  "availability_zone_id" : "xxx",
  "flavor_id" : "s6.xlarge.4",
  "resource_counts" : 1
}

Example Responses

Status code: 200

Response to the request for checking edge site resources.

{
  "is_enough" : 1,
  "resource_remainder" : [ {
    "type" : "string",
    "remainder" : 0,
    "need" : 0,
    "volume_type" : "string"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for checking edge site resources.
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.