DocsICP FilingConsole
Documentation

ModifyInstanceMaintenanceAttributes

Updated at:
Copy as MD
Product
My Favorites

Modifies the maintenance attributes of an instance.

Operation description

This operation is used to modify the maintenance policy of an instance. The maintenance policy consists of the following maintenance attributes:

  • Maintenance window: the time period that you specify for maintenance.

  • Maintenance action: the action that you specify in response to instance shutdown.

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

ecs:ModifyInstanceMaintenanceAttributes

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ActionOnMaintenance

string

No

The maintenance action. Valid values:

  • Stop: stops the instance.

  • AutoRecover: automatically recovers the instance.

  • AutoRedeploy: redeploys the instance, which may damage the data disks attached to the instance.

AutoRecover
NotifyOnMaintenance

boolean

No

Specifies whether to send an event notification before maintenance. Valid values:

  • true

  • false

Default value: false.

false
InstanceId

array

No

The ID of instance N. Valid values of N: 1 to 100.

i-bp67acfmxazb4ph****

string

No

The ID of instance N. Valid values of N: 1 to 100.

i-bp67acfmxazb4ph****
MaintenanceWindow

array<object>

No

The maintenance windows.

object

No

The maintenance windows.

EndTime

string

No

The end time of the maintenance window. The time must be on the hour. You must configure both StartTime and EndTime. The value of EndTime must be 1 to 23 hours later than the value of StartTime. Specify the time in the HH:mm:ss format. The time must be in UTC+8. Set the value of N to 1.

18:00:00
StartTime

string

No

The start time of the maintenance window. The time must be on the hour. You must configure both StartTime and EndTime. The value of EndTime must be 1 to 23 hours later than the value of StartTime. Specify the time in the HH:mm:ss format. The time must be in UTC+8. Set the value of N to 1.

02:00:00

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code

Error code

Error message

Description
403 InvalidParameter %s
403 OperationDenied.NotInWhiteList %s You are not authorized to perform this operation. Try again when you are authorized.
404 InvalidInstanceId.NotFound %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.