校验边缘站点资源 - CheckEdgeSiteResources

功能介绍

校验边缘站点资源。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
availability_zone_id	是	String	可用区id。
flavor_id	否	String	规格id。
resource_counts	否	Integer	需要的资源数量。
volumes	否	Array of CheckEdgeSiteResourcesVolume objects	磁盘列表。包含系统盘。

表3 CheckEdgeSiteResourcesVolume
参数	是否必选	参数类型	描述
type	是	String	磁盘类型。
size	是	Long	磁盘大小，单位GB。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
is_enough	Integer	配额是否足够1：足够 0 ：不足。
resource_remainder	Array of ResourceRemainderData objects	资源剩余数量信息。

表5 ResourceRemainderData
参数	参数类型	描述
type	String	资源类型。
remainder	Long	剩余数量。
need	Long	所需资源。
volume_type	String	磁盘类型。type为volume_gigabytes时，会返回该字段。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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

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

响应示例

状态码：200

校验边缘站点资源响应。

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

状态码

状态码	描述
200	校验边缘站点资源响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。