全部产品
Search
文档中心

轻量应用服务器:ListInstanceStatus - 批量获取实例状态

更新时间:Oct 30, 2024

查询一个或多个实例的状态。

调试

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

授权信息

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

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

请求参数

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

指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
InstanceIdsstring

轻量应用服务器的实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]
PageNumberinteger

当前页码。

1
PageSizeinteger

分页查询时设置的每页行数。

10

返回参数

名称类型描述示例值
object
InstanceStatusesarray<object>

实例状态集类型(InstanceStatus)。

InstanceStatuseobject

轻量应用服务器实例状态。

Statusstring

实例状态,可能值:

  • Pending:准备中
  • Starting:启动中
  • Running:运行中
  • Stopping:停止中
  • Stopped:停止
  • Resetting:重置中
  • Upgrading:升级中
  • Disabled:不可用
Running
InstanceIdstring

指定的轻量应用服务器的实例 ID。

a9a6474b935d41bcb531250bb5d****
RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
PageSizeinteger

分页查询时设置的每页行数。

10
PageNumberinteger

当前页码。

1
TotalCountinteger

总条数。

54

示例

正常返回示例

JSON格式

{
  "InstanceStatuses": [
    {
      "Status": "Running",
      "InstanceId": "a9a6474b935d41bcb531250bb5d****"
    }
  ],
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 54
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

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