TempModifyDBNode - PolarDB - Alibaba Cloud Documentation Center

Temporarily changes the node configurations.

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:
- The required resource types are displayed in bold characters.
- 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
polardb:TempModifyDBNode	update	DBCluster acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}	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 value. Make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.	6000170000591aed949d0f5********************
DBClusterId	string	Yes	The cluster ID.	pc-xxxxxxxxxx
OperationType	string	Yes	The operation type. Valid values: Modify: temporarily upgrades the configuration of the cluster.	Modify
ModifyType	string	Yes	The type of configuration change. Set the value to TempUpgrade.	TempUpgrade
DBNode	array<object>	Yes	The information of the added node.
	object	Yes
TargetClass	string	No	The instance type of the added node. The instance type of the added node must be the same as the instance type of the original node. Note You can call the DescribeDBClusters operation to view the instance types of original nodes.	polar.mysql.x4.medium
ZoneId	string	No	The ID of the zone in which the added node is deployed. The instance type of the added node must be the same as the instance type of the original node.	cn-hangzhou-i
RestoreTime	string	Yes	The rollback time of the configuration for the temporary upgrade. Specify the time in the ISO 8601 standard in the YYYY-MM-DD hh:mm:ss format. Note The rollback time cannot be 1 hour earlier than the current time and cannot be later than one day before the time when the cluster expires.	2021-09-23 18:16:00

Response parameters

Parameter	Type	Description	Example
	object
DBClusterId	string	The cluster ID.	pc-xxxxxxxxxxxxxxxxx
DBNodeIds	array	The details of the nodes.
DBNodeId	string	The details of the node. Note If the OperationType parameter is set to Add, the value of this parameter is returned. If the OperationType parameter is set to Modify, no value is returned.	pi-***************
OrderId	string	The ID of the order.	2035638*******
RequestId	string	The request ID.	69A85BAF-1089-4CDF-A82F-0A140F******

Examples

Sample success responses

JSONformat

{
  "DBClusterId": "pc-xxxxxxxxxxxxxxxxx",
  "DBNodeIds": [
    "pi-***************"
  ],
  "OrderId": "2035638*******",
  "RequestId": "69A85BAF-1089-4CDF-A82F-0A140F******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
400	InvalidDBNodeNum.Malformed	The number of parameter DBNode.N is not valid.	The specified number of database nodes is invalid.
400	InvalidDBNode.Malformed	The specified parameter DBNode.N is not valid.	The specified DBNode.N parameter is invalid.
400	InvalidModifyType.Malformed	The specified parameter ModifyType is not valid.	The specified ModifyType parameter is invalid.
400	InvalidZoneId.Malformed	The specified parameter ZoneId is not valid.	The specified ZoneId parameter is invalid.
400	InvalidDBNodeClass.Malformed	The specified parameter DBNodeClass is not valid.	The specified DBNodeClass parameter is invalid.
403	OperationDenied.TempAddNodeDuring	This operation is not allowed during the temporary add node of the cluster.	This operation is not supported during temporary node addition.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.	The specified cluster ID does not exist.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidRestoreTimeExceedsExpirationTime.Malformed	The RestoreTime cannot be later than 1 day before the cluster ExpirationTime.	The value of RestoreTime can be up to 1 day earlier than the expiration time of the cluster.
404	InvalidCurrentTimeExceedsRestoreTime.Malformed	The RestoreTime cannot be 1 hour later than the CurrentTime.	The value of RestoreTime cannot be 1 hour later than the value of CurrentTime.
404	InvalidRestoreTime.Malformed	The specified RestoreTime is not valid.	The specified RestoreTime parameter is invalid.
404	InvalidOperationType.Malformed	The specified OperationType is not valid.	The specified OperationType parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2023-09-12	The Error code has changed	View Change Details