DescribeInstancesFullStatus - 查询实例的全部状态信息 - 云服务器 ECS

调用DescribeInstancesFullStatus查询一台或多台ECS实例的全状态信息。全状态信息包括实例状态和实例系统事件状态，其中，实例状态为实例的生命周期状态，实例系统事件为维护事件的健康状态。

接口说明

返回结果包括实例状态和待执行（Scheduled）状态的实例系统事件。

如果指定一个时间段，则根据时间段筛选事件。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribeInstancesFullStatus

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
RegionId	string	是	实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
Status	string	否	指定实例的生命周期状态。取值范围： Starting：启动中。 Running：运行中。 Stopped：已停止。	Running
HealthStatus	string	否	指定实例的健康状态。取值范围： Impaired：服务损坏。 Warning：警告，实例性能可能因维护而降低。 Maintaining：维护中。 Initializing：初始化中。 InsufficientData：数据不足。 NotApplicable：不适用。以上参数取值均区分大小写。	Initializing
EventType	string	否	一个事件的类型。EventType 参数只在未指定 InstanceEventType.N 参数时有效。取值范围： SystemMaintenance.Reboot：因系统维护实例重启。 SystemFailure.Reboot：因系统错误实例重启。 InstanceFailure.Reboot：因实例错误实例重启。 InstanceExpiration.Stop：因包年包月期限到期，实例停止。 InstanceExpiration.Delete：因包年包月期限到期，实例释放。 AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。 AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。	InstanceExpiration.Stop
NotBefore.Start	string	否	查询事件计划执行时间的开始时间。按照ISO 8601标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2017-12-07T00:00:00Z
NotBefore.End	string	否	查询事件计划执行时间的结束时间。按照ISO 8601标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2017-11-30T00:00:00Z
EventPublishTime.Start	string	否	查询事件发布时间的开始时间。按照ISO 8601标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2017-11-30T00:00:00Z
EventPublishTime.End	string	否	查询事件发布时间的结束时间。按照ISO 8601标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2017-12-07T00:00:00Z
PageNumber	integer	否	查询结果的页码。取值范围：正整数默认值：1。	1
PageSize	integer	否	查询结果的分页大小。取值范围：1~100。默认值：10。	10
InstanceId	array	否	实例 ID 列表。可输入最大 100 个实例 ID。	i-bp67acfmxazb4p****
	string	否	实例 ID。	i-bp67acfmxazb4p****
EventId	array	否	事件 ID 列表。可输入最多 100 个事件 ID。	e-bp1hygp5b04o56l0****
	string	否	事件 ID。	e-bp1hygp5b04o56l0****
InstanceEventType	array	否	实例事件的类型列表。可输入最大 30 个实例事件的类型。	InstanceExpiration.Stop
	string	否	实例系统事件的类型。取值范围： SystemMaintenance.Reboot：因系统维护实例重启。 SystemMaintenance.Redeploy：因系统维护实例重新部署。 SystemFailure.Reboot：因系统错误实例重启。 SystemFailure.Redeploy：因系统错误实例重新部署。 SystemFailure.Delete：因实例创建失败实例释放。 InstanceFailure.Reboot：因实例错误实例重启。 InstanceExpiration.Stop：因包年包月期限到期，实例停止。 InstanceExpiration.Delete：因包年包月期限到期，实例释放。 AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。 AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。说明事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件，不能是磁盘系统事件。	SystemMaintenance.Reboot

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页大小。	1
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	页码。	1
TotalCount	integer	总条数。	2
InstanceFullStatusSet	object
InstanceFullStatusType	array<object>	实例全状态数组。说明当实例不存在时该数据为空。
	array<object>
InstanceId	string	实例 ID。	i-bp67acfmxazb4p****
ScheduledSystemEventSet	object
ScheduledSystemEventType	array<object>	当前状态为 Scheduled 或 Inquiring 的系统事件数组。
	array<object>
EventPublishTime	string	事件的发布时间，使用 UTC+0 时间。	2017-11-30T06:32:31Z
EventId	string	实例事件 ID。	e-bp1hygp5b04o56l0****
NotBefore	string	事件的计划执行时间，使用 UTC+0 时间。	2017-12-07T00:00:00Z
ImpactLevel	string	影响级别。说明不在白名单的用户，该参数为空。	100
Reason	string	系统事件的计划原因。说明当阿里云没有判断出异常原因时，该参数为空。	A simulated event.
EventCycleStatus	object	事件状态。
Name	string	事件状态名称。	Scheduled
Code	integer	事件状态代码。	24
EventType	object	事件类型。
Name	string	事件类型名称。	SystemMaintenance.Reboot
Code	integer	事件类型代码。	1
ExtendedAttribute	object	本地盘实例系统事件拓展属性。不同事件类型，返回值有所不同。当事件类型不在以下列表中时，该数据为空。 SystemMaintenance.StopAndRepair SystemMaintenance.CleanInactiveDisks SecurityPunish.Locked SecurityPunish.WebsiteBanned SystemUpgrade.Migrate SystemMaintenance.RebootAndIsolateErrorDisk SystemMaintenance.RebootAndReInitErrorDisk SystemMaintenance.ReInitErrorDisk SystemMaintenance.IsolateErrorDisk
Device	string	本地盘设备名。	/dev/vdb
DiskId	string	本地盘磁盘 ID。	d-bp67acfmxazb4p****
InactiveDisks	object
InactiveDisk	array<object>	已释放但需要清理的非活跃云盘或本地盘信息。
	object
CreationTime	string	云盘或本地盘的创建时间。按照ISO 8601标准表示，使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2018-07-27T13:53:25Z
DeviceSize	string	云盘或本地盘大小，单位 GiB。	80
DeviceCategory	string	云盘或本地盘种类。可能值： cloud：普通云盘 cloud_efficiency：高效云盘 cloud_ssd：SSD 盘 cloud_essd：ESSD 云盘 local_ssd_pro：I/O 密集型本地盘 local_hdd_pro：吞吐密集型本地盘 ephemeral：（已停售）本地盘 ephemeral_ssd：（已停售）本地 SSD 盘	cloud_ssd
DeviceType	string	云盘或本地盘类型。可能值： system：系统盘 data：数据盘	system
ReleaseTime	string	云盘或本地盘的释放时间。按照ISO 8601标准表示，使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-07-27T13:53:25Z
Status	object	实例生命周期状态。
Name	string	实例生命周期状态名称。	Running
Code	integer	实例生命周期状态代码。	1
HealthStatus	object	实例的健康状态。
Name	string	健康状态名称。	Warning
Code	integer	健康状态代码。	64

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "InstanceFullStatusSet": {
    "InstanceFullStatusType": [
      {
        "InstanceId": "i-bp67acfmxazb4p****",
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "EventId": "e-bp1hygp5b04o56l0****",
              "NotBefore": "2017-12-07T00:00:00Z",
              "ImpactLevel": "100",
              "Reason": "A simulated event.",
              "EventCycleStatus": {
                "Name": "Scheduled",
                "Code": 24
              },
              "EventType": {
                "Name": "SystemMaintenance.Reboot",
                "Code": 1
              },
              "ExtendedAttribute": {
                "Device": "/dev/vdb",
                "DiskId": "d-bp67acfmxazb4p****",
                "InactiveDisks": {
                  "InactiveDisk": [
                    {
                      "CreationTime": "2018-07-27T13:53:25Z",
                      "DeviceSize": "80",
                      "DeviceCategory": "cloud_ssd",
                      "DeviceType": "system",
                      "ReleaseTime": "2019-07-27T13:53:25Z"
                    }
                  ]
                }
              }
            }
          ]
        },
        "Status": {
          "Name": "Running",
          "Code": 1
        },
        "HealthStatus": {
          "Name": "Warning",
          "Code": 64
        }
      }
    ]
  }
}

异常返回示例

JSON格式

{
  "InstanceFullStatusSet": {
    "InstanceFullStatusType": [
      {
        "InstanceId": "i-instance1",
        "Status": {
          "Code": 1,
          "Name": "Running"
        },
        "HealthStatus": {
          "Code": 0,
          "Name": "Maintaining"
        },
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventId": "e-event1",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 1,
                "Name": "SystemMaintenance.Reboot"
              },
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "NotBefore": "2017-12-01T06:32:31Z"
            },
            {
              "EventId": "e-event2",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 34,
                "Name": "InstanceExpiration.Stop"
              },
              "EventPublishTime": "2017-11-30T00:00:00Z",
              "NotBefore": "2017-12-07T00:00:00Z"
            }
          ]
        }
      },
      {
        "InstanceId": "i-instance2",
        "Status": {
          "Code": 1,
          "Name": "Running"
        },
        "HealthStatus": {
          "Code": 64,
          "Name": "Warning"
        },
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventId": "e-event3",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 65,
                "Name": "SystemFailure.Reboot"
              },
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "NotBefore": "2017-12-01T06:32:31Z"
            }
          ]
        }
      }
    ]
  },
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "RequestId": "AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4"
}

错误码

HTTP status code	错误码	错误信息	描述
403	InvalidParameter	%s
403	InvalidParameter.TimeEndBeforeStart	%s	您输入的参数无效，请确认结束时间是否早于开始时间。
403	OperationDenied.NotInWhiteList	%s	该操作无效，请先加入白名单。
403	InstanceIdLimitExceeded	%s	指定的 InstanceId 个数不能超过 100 个。
403	EventIdLimitExceeded	%s
404	MissingParameter	%s

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

变更历史

更多信息，参考变更详情。