All Products
Search
Document Center

Elastic Compute Service:ModifyInstanceMaintenanceAttributes

Last Updated:Sep 29, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:ModifyInstanceMaintenanceAttributesupdate
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ActionOnMaintenancestringNo

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
NotifyOnMaintenancebooleanNo

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

  • true
  • false

Default value: false.

false
InstanceIdarrayNo

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

stringNo

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

i-bp67acfmxazb4ph****
MaintenanceWindowarray<object>No

The maintenance windows.

objectNo

The maintenance windows.

EndTimestringNo

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
StartTimestringNo

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403InvalidParameter%sThe specified parameter is invalid.
403OperationDenied.NotInWhiteList%sYou are not authorized to perform this operation. Try again when you are authorized.
404InvalidInstanceId.NotFound%sThe specified instance does not exist. Check whether the InstanceId parameter is valid.

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

Change history

Change timeSummary of changesOperation
No change history