全部产品
Search
文档中心

云服务器 ECS:DescribeInstanceStatus - 获取多台ECS实例的状态信息

更新时间:Sep 29, 2024

调用DescribeInstanceStatus,查询一台或多台指定ECS实例的状态。

接口说明

  • ECS 实例的生命周期状态请参见实例状态表
  • 该接口也可用于获取实例列表。

操作指引

  • 根据指定地域查询状态信息,入参示例:
{
      "RegionID": ["cn-hangzhou"]
}
  • 根据指定地域下的某个可用区查询状态信息,入参示例:
{
      "RegionID": "cn-hangzhou",
      "ZoneID": ["cn-hangzhou-a"]
}
  • 根据实例 ID查询状态信息,入参示例:
{
      "RegionID": "cn-hangzhou",
      "InstancesID": ["i-bp1f7c1zqp999zvp****", "i-bp1dqjv36biueg61****"]
}

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
ZoneIdstring

实例所属可用区。您可以调用 DescribeZones 查看最新的阿里云可用区列表。

cn-hangzhou-d
ClusterIdstring

实例所属的集群 ID。

注意 该参数已废弃,不建议使用!

cls-bp67acfmxazb4p****
PageNumberinteger

实例状态列表的页码。

起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。取值范围:1~50。

默认值:10。

10
InstanceIdarray

实例 ID 列表。

调用示例:InstanceId.1=i-bp1j4i2jdf3owlhe****, InstanceId.2=i-bp1j4i2jdf3o1234****

string

实例 ID。

i-bp1j4i2jdf3owlhe****

返回参数

名称类型描述示例值
object
PageSizeinteger

输入时设置的每页行数。

1
RequestIdstring

请求 ID。

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

实例列表的页码。

1
TotalCountinteger

实例总个数。

58
InstanceStatusesarray<object>

实例状态集类型(InstanceStatus)。

InstanceStatusobject
Statusstring

实例状态。可能值:

  • Pending:创建中。

  • Running:运行中。

  • Starting:启动中。

  • Stopping:停止中。

  • Stopped:已停止。

Running
InstanceIdstring

实例 ID。

i-bp1j4i2jdf3owlhe****

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 58,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "Status": "Running",
        "InstanceId": "i-bp1j4i2jdf3owlhe****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403InvalidParameter.TooManyInstanceIdsInstance ids cannot be more than 100.-
403Abs.InvalidInstanceIds.MalFormedThe specified instanceIds is not valid.指定的InstanceId参数不合法
404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.指定的可用区 ID 不存在。

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