文档

DescribeInstanceMaintenanceAttributes - 查询实例的维护属性

更新时间:

调用DescribeInstanceMaintenanceAttributes查询实例的维护属性。

接口说明

查询已设定的维护策略,策略中主要包括两个维护属性。

  • 维护时间窗口:您指定的一个时间段,运维只会在该时间内进行。
  • 维护动作:您指定的实例宕机处理策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeInstanceMaintenanceAttributesRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/*
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
PageNumberlong

维护属性列表的页码。

起始值:1

默认值:1

1
PageSizelong

单页返回的条数。取值范围:1~100

默认值:10

10
InstanceIdarray

实例 ID 列表。可输入最多 100 个实例 ID。

string

实例 ID。

i-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
PageSizeinteger

单页返回的条数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

维护属性列表的页码。

1
TotalCountinteger

查询到的维护属性总数。

100
MaintenanceAttributesobject []

运维属性的集合。

NotifyOnMaintenanceboolean

实例宕机运维前是否发送事件通知。

false
InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****
MaintenanceWindowsobject []

运维窗口实例的列表。

EndTimestring

维护时间窗口结束时间。

18:00:00
StartTimestring

维护时间窗口开始时间。

02:00:00
ActionOnMaintenanceobject

实例的运维动作属性。

DefaultValuestring

维护动作,默认的值。

AutoRecover
Valuestring

维护动作,当前生效的值。可能值:

  • Stop: 停止状态(即宕机)。
  • AutoRecover:自动恢复。
  • AutoRedeploy:宕机迁移,数据盘有损。
Stop
SupportedValuesarray

由维护动作组成的数组格式,返回支持的运维动作值列表。

string

运维动作值。

Stop

示例

正常返回示例

JSON格式

{
  "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"
            ]
          }
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter%s缺失参数,请检查参数是否完整。
403InvalidParameter%s无效的参数。
403InstanceIdLimitExceeded%s指定的 InstanceId 个数不能超过 100 个。
403OperationDenied.NotInWhiteList%s该操作无效,请先加入白名单。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈