文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ 实例管理/ 资源预校验
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

资源预校验

功能介绍

资源预校验。

URI

POST /v3/{project_id}/resource-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

是

String

内容类型。

取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

校验类型。

  • createInstance：校验创建实例。
  • createReadonlyNode：校验创建只读节点。
  • resizeFlavor：校验规格变更。

resource

是

CheckResourceInfo object

资源信息。
表4 CheckResourceInfo

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID。action为createInstance时必填。

instance_num

否

Integer

实例数量。action为createInstance时必填。

mode

否

String

实例类型，目前仅支持Cluster。action为createInstance时必填。

availability_zone_mode

否

String

可用区类型，单可用区single或多可用区multi。action为createInstance时必填。

node_num

否

Integer

节点数量。action为createInstance、createReadonlyNode时必填。

flavor_ref

否

String

规格码。action为createInstance、resizeFlavor时必填。

availability_zone

否

String

可用区码。

subnet_id

否

String

子网ID。action为createInstance时必填。

instance_id

否

String

实例ID。action为createReadonlyNode、resizeFlavor时必填。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

Boolean

结果。

  • true：表示通过。
  • false：表示不通过。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 创建实例资源预校验。 
    POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check

{
  "action" : "createInstance",
  "resource" : {
    "enterprise_project_id" : 0,
    "instance_num" : 1,
    "mode" : "Cluster",
    "availability_zone_mode" : "single",
    "node_num" : 2,
    "flavor_ref" : "gaussdb.mysql.xlarge.x86.4",
    "availability_zone" : "cn-southwest-244b",
    "subnet_id" : "1e9f71dd-9192-4c0d-9739-161d8dcca68c"
  }
}
  • 添加只读资源预校验。 
    POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check

{
  "action" : "createReadonlyNode",
  "resource" : {
    "instance_id" : "376e0847a2224e95afcd3e607eccd544in07",
    "node_num" : 1
  }
}
  • 规格变更资源预校验。 
    POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check

{
  "action" : "resizeFlavor",
  "resource" : {
    "instance_id" : "376e0847a2224e95afcd3e607eccd544in07",
    "flavor_ref" : "gaussdb.mysql.xlarge.x86.4"
  }
}

响应示例

状态码： 200

Success.

{
  "result" : true
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理