PreCheckCreateOrderForDeleteDBNodes - ApsaraDB RDS - Alibaba Cloud Documentation Center

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:PreCheckCreateOrderForDeleteDBNodes	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOC****
CommodityCode	string	Yes	The commodity code. Valid value: bards: The instance is a pay-as-you-go primary instance. rds: The instance is a subscription primary instance. rords: The instance is a pay-as-you-go read-only instance. rds_rordspre_public_cn: The instance is a subscription read-only instance. bards_intl: The instance is a pay-as-you-go primary instance. rds_intl: The instance is a subscription primary instance. rords_intl: The instance is a pay-as-you-go read-only instance. rds_rordspre_public_intl: The instance is a subscription read-only instance.	rds
DBInstanceId	string	No	The instance ID.	rm-wz9rziy3he051if82
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ZoneId	string	No	The zone ID.	cn-hangzhou-a
Resource	string	No	The resource of the instance.	buy
AutoPay	boolean	No	Specifies whether to automatically complete the payment. Valid values: true: automatically completes the payment. You must make sure that your account balance is sufficient. false: does not automatically complete the payment. An unpaid order is generated. Note The default value is true. If your account balance is insufficient, you can set the AutoPay parameter to false to generate an unpaid order. Then, you can log on to the ApsaraDB RDS console to complete the payment.	True
PromotionCode	string	No	The coupon code.	aliwood-1688-mobile-promotion
EngineVersion	string	No	The major engine version of the destination instance. The value of this parameter varies based on the value of Engine. Valid values when Engine is set to MySQL: 5.5, 5.6, 5.7, and 8.0 Valid values when Engine is set to SQLServer: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent Valid values when Engine is set to PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, and 15.0	8.0
NodeType	string	No	The type of the database node. Valid value: Master: the primary node Slave: the secondary node	Master
BusinessInfo	string	No	The additional business information about the instance.	{\"promotion_input_param\":\"{\\\"promotionFilter\\\":{},\\\"promotionOptionCode\\\":\\\"youhui_quan\\\"}\"}
DBNodeId	array	No	The node IDs.
	string	No	The node ID. Note You must specify one of the `DBNodeId` and `DBClusterId` parameters. You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as node IDs.	[\"rn-704fvfg7a1841gahd\"]

Response parameters

Parameter	Type	Description	Example
	object
PreCheckResult	boolean	The precheck result.	True
RequestId	string	The request ID.	9B415BC6-FE84-5323-A255-42CF330DB99C
Failures	array<object>	The information about the failed order.
Failures	object
Code	string	The response code. Valid values: 200: success 400: client error 401: identity authentication failed 404: requested page not found 500: server error	200
Message	string	The returned message.	success

Examples

Sample success responses

JSONformat

{
  "PreCheckResult": true,
  "RequestId": "9B415BC6-FE84-5323-A255-42CF330DB99C",
  "Failures": {
    "Failures": [
      {
        "Code": 200,
        "Message": "success"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.InvalidStorageSize	The storage size limit is exceeded.	The disk usage exceeds the upper limit. Free or expand disk space.
403	Forbidden.Authentication	The operation is forbidden by Aliyun Realname Authentication System.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-12	API Description Update. The Error code has changed	View Change Details