调用DescribeInstancesFullStatus查询一台或多台ECS实例的全状态信息。全状态信息包括实例状态和实例系统事件状态,其中,实例状态为实例的生命周期状态,实例系统事件为维护事件的健康状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeInstancesFullStatus | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Status | string | 否 | 指定实例的生命周期状态。取值范围:
| Running |
HealthStatus | string | 否 | 指定实例的健康状态。取值范围:
以上参数取值均区分大小写。 | OK |
EventType | string | 否 | 一个事件的类型。EventType 参数只在未指定 InstanceEventType.N 参数时有效。取值范围:
| 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。 | |
string | 否 | 实例 ID。 | i-bp67acfmxazb4p**** | |
EventId | array | 否 | 事件 ID 列表。可输入最多 100 个事件 ID。 | |
string | 否 | 事件 ID。 | e-bp1hygp5b04o56l0**** | |
InstanceEventType | array | 否 | 实例事件的类型列表。可输入最大 30 个实例事件的类型。 | |
string | 否 | 实例系统事件的类型。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。
| SystemMaintenance.Reboot |
返回参数
示例
正常返回示例
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
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | InvalidParameter | %s | 无效的参数。 |
403 | InvalidParameter.TimeEndBeforeStart | %s | 您输入的参数无效,请确认结束时间是否早于开始时间。 |
403 | OperationDenied.NotInWhiteList | %s | 该操作无效,请先加入白名单。 |
403 | InstanceIdLimitExceeded | %s | 指定的 InstanceId 个数不能超过 100 个。 |
403 | EventIdLimitExceeded | %s | 一次最多能指定100个模拟事件ID。 |
404 | MissingParameter | %s | 缺失参数,请检查参数是否完整。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-03 | OpenAPI 错误码发生变更 | 查看变更详情 |