Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Pre-Checking Resources
Updated on 2026-03-16 GMT+08:00
View PDF

Pre-Checking Resources

Function

This API is used to pre-check resources. Before calling this API:

URI

POST /v3/{project_id}/resource-check

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Check type.

Constraints

N/A

Range

  • createInstance: pre-checking resources during instance creation

  • createReadonlyNode: pre-checking resources during read replica creation

  • resizeFlavor: pre-checking resources during instance specification change

Default Value

N/A

resource

Yes

CheckResourceInfo object

Definition

Resource information.

Constraints

N/A
Table 4 CheckResourceInfo

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

This parameter is mandatory when action is set to createInstance.

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_num

No

Integer

Definition

Number of instances.

Constraints

This parameter is mandatory when action is set to createInstance.

Range

N/A

Default Value

N/A

mode

No

String

Definition

Instance type.

Constraints

This parameter is mandatory when action is set to createInstance.

Range

Cluster

Default Value

N/A

availability_zone_mode

No

String

Definition

AZ type.

Constraints

This parameter is mandatory when action is set to createInstance.

Range

  • single: single AZ

  • multi: multiple AZs

Default Value

N/A

node_num

No

Integer

Definition

Number of nodes.

Constraints

This parameter is mandatory when action is set to createInstance or createReadonlyNode.

Range

N/A

Default Value

N/A

flavor_ref

No

String

Definition

Specification code.

Constraints

This parameter is mandatory when action is set to createInstance or resizeFlavor.

Range

N/A

Default Value

N/A

availability_zone

No

String

Definition

AZ code.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_id

No

String

Definition

Subnet ID.

Subnet ID. You can obtain the value with either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the subnet ID on the displayed page.

  • Method 2: Query the subnet ID through the VPC API. For details, see Querying Subnets.

Constraints

This parameter is mandatory when action is set to createInstance.

Range

N/A

Default Value

N/A

instance_id

No

String

Definition

Instance ID.

Constraints

This parameter is mandatory when action is set to createReadonlyNode or resizeFlavor.

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

result

Boolean

Definition

Pre-check results.

Range

  • true: The pre-check is passed.

  • false: The pre-check fails.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Pre-checking resources during instance creation 
    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" : "eu-west-101",
    "subnet_id" : "1e9f71dd-9192-4c0d-9739-161d8dcca68c"
  }
}
  • Pre-checking resources during read replica creation 
    POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check

{
  "action" : "createReadonlyNode",
  "resource" : {
    "instance_id" : "376e0847a2224e95afcd3e607eccd544in07",
    "node_num" : 1
  }
}
  • Pre-checking resources during instance specification change 
    POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check

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

Example Response

Status code: 200

Success.

{
  "result" : true
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management