RestartDBNode - PolarDB - Alibaba Cloud Documentation Center

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:RestartDBNode

update

*DBNode

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBNodeId	string	Yes	The ID of the cluster node. Note Call the DescribeDBClusters operation to query the details of all clusters under your account, including node IDs.	pi-*************
PlannedStartTime	string	No	The earliest time to start the scheduled node restart. The task is executed within a specified time window. The time must be in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC. Note The start time can be set to any point in time within the next 72 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can be set to a value in the range from `2021-01-14T09:00:00Z` to `2021-01-17T09:00:00Z`. If this parameter is empty, the node is restarted immediately.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	The latest time to start the scheduled task. The time must be in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC. Note The latest time must be at least 30 minutes later than the earliest time. If PlannedStartTime is specified but this parameter is not, the latest start time of the task is PlannedStartTime plus 30 minutes by default. For example, if PlannedStartTime is set to `2021-01-14T09:00:00Z` and this parameter is empty, the task starts no later than `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
FromTimeService	string	No	Specifies whether to restart the node immediately or at a scheduled time. Valid values: false (default): The node is restarted at a scheduled time. true: The node is restarted immediately.	false
RegionId	string	No	The region ID. Note Call the DescribeRegions operation to query the available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E6CD86******

Examples

Success response

JSON format

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.