TempModifyDBNode - PolarDB - Alibaba Cloud Documentation Center

Temporarily modifies the configurations of a node.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:TempModifyDBNode

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a unique token for each request. The token is case-sensitive and can be up to 64 ASCII characters in length.	6000170000591aed949d0f5********************
DBClusterId	string	Yes	The cluster ID.	pc-xxxxxxxxxx
OperationType	string	Yes	The operation type. Valid values: Modify: temporary upgrade Add: temporarily add a node	Modify
ModifyType	string	Yes	The modification type. The value is fixed to TempUpgrade.	TempUpgrade
DBNode	array<object>	Yes	The information about the nodes to upgrade or add.
	object	No
TargetClass	string	No	The specifications of the node to upgrade or add. Note When you add a node, the node specifications must be the same as the specifications of the existing nodes. For more information about the specifications of existing cluster nodes, see DescribeDBClusters.	polar.mysql.x4.medium
ZoneId	string	No	The zone for the new node. The zone must be the same as the zone of the existing nodes.	cn-hangzhou-i
RestoreTime	string	Yes	The time to revert the temporary upgrade. The format is YYYY-MM-DD hh:mm:ss. Note The revert time must be at least 1 hour later than the current time. It must also be at least 1 day before the cluster expires.	2021-09-23 18:16:00

Response elements

Element	Type	Description	Example
	object
DBClusterId	string	The cluster ID.	pc-xxxxxxxxxxxxxxxxx
DBNodeIds	array	The list of nodes.
	string	The list of nodes. Note This parameter is returned only when OperationType is set to Add. If OperationType is set to Modify, an empty value is returned.	pi-***************
OrderId	string	The order ID.	2035638*******
RequestId	string	The request ID.	69A85BAF-1089-4CDF-A82F-0A140F******

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.