Use DescribeInstanceMaintenanceAttributes to query instance maintenance attributes - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the maintenance attributes of an instance.

Operation description

This operation is used to query the specified maintenance policy of an instance, which contains 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:DescribeInstanceMaintenanceAttributes

get

*All Resource

*

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
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
InstanceId	array	No	The instance IDs. You can specify up to 100 instance IDs.	i-bp67acfmxazb4p****
	string	No	The instance ID.	i-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of queried maintenance attributes.	100
MaintenanceAttributes	object
MaintenanceAttribute	array<object>	The maintenance attributes.
	array<object>
NotifyOnMaintenance	boolean	Indicates whether an event notification was sent before maintenance.	false
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
MaintenanceWindows	object
MaintenanceWindow	array<object>	The maintenance windows.
	object
EndTime	string	The end time of the maintenance window.	18:00:00
StartTime	string	The start time of the maintenance window.	02:00:00
ActionOnMaintenance	object	The attributes of the maintenance action of the instance.
DefaultValue	string	The default maintenance action.	AutoRecover
Value	string	The current 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.	Stop
SupportedValues	object
SupportedValue	array	The supported maintenance actions.
	string	The supported maintenance action.	Stop

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 100,
  "MaintenanceAttributes": {
    "MaintenanceAttribute": [
      {
        "NotifyOnMaintenance": false,
        "InstanceId": "i-bp67acfmxazb4p****",
        "MaintenanceWindows": {
          "MaintenanceWindow": [
            {
              "EndTime": "18:00:00",
              "StartTime": "02:00:00"
            }
          ]
        },
        "ActionOnMaintenance": {
          "DefaultValue": "AutoRecover",
          "Value": "Stop",
          "SupportedValues": {
            "SupportedValue": [
              "Stop"
            ]
          }
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s	A parameter is not specified.
403	InvalidParameter	%s
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
403	OperationDenied.NotInWhiteList	%s	You are not authorized to perform this operation. Try again when you are authorized.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.