Pre-Checking Resources
Function
This API is used to pre-check resources. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/resource-check
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
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 Default Value en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
String |
Definition Check type. Constraints N/A Range
Default Value N/A |
resource |
Yes |
CheckResourceInfo object |
Definition Resource information. Constraints N/A |
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 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:
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
Parameter |
Type |
Description |
---|---|---|
result |
Boolean |
Definition Pre-check results. Range |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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" : "cn-southwest-244b", "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot