更新时间:2025-09-04 GMT+08:00

资源预校验

功能介绍

资源预校验。

URI

POST /v3/{project_id}/resource-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释

校验类型。

约束限制

不涉及。

取值范围

  • createInstance:校验创建实例。

  • createReadonlyNode:校验创建只读节点。

  • resizeFlavor:校验规格变更。

默认取值

不涉及。

resource

CheckResourceInfo object

参数解释

资源信息。

约束限制

不涉及。

表4 CheckResourceInfo

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释

企业项目ID。

约束限制

action为createInstance时必填。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_num

Integer

参数解释

实例数量。

约束限制

action为createInstance时必填。

取值范围

不涉及。

默认取值

不涉及。

mode

String

参数解释

实例类型。

约束限制

action为createInstance时必填。

取值范围

Cluster。

默认取值

不涉及。

availability_zone_mode

String

参数解释

可用区类型。

约束限制

action为createInstance时必填。

取值范围

  • single:单可用区。

  • multi:多可用区。

默认取值

不涉及。

node_num

Integer

参数解释

节点数量。

约束限制

action为createInstance、createReadonlyNode时必填。

取值范围

不涉及。

默认取值

不涉及。

flavor_ref

String

参数解释

规格码。

约束限制

action为createInstance、resizeFlavor时必填。

取值范围

不涉及。

默认取值

不涉及。

availability_zone

String

参数解释

可用区码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

subnet_id

String

参数解释

子网ID。

子网的网络ID,获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。

  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

约束限制

action为createInstance时必填。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。

约束限制

action为createReadonlyNode、resizeFlavor时必填。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

响应参数

状态码: 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
}

状态码

请参见状态码

错误码

请参见错误码