调用ListInstances查询指定地域下一个或多个实例的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListInstances

系统规定参数。取值:ListInstances

RegionId String cn-hangzhou

轻量应用服务器所属的地域ID。

InstanceIds String ["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]

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

说明 同时指定InstanceIdsPublicIpAddresses参数时,必须保证对应的实例ID和公网IP属于同一台轻量应用服务器,否则返回值为空。
ChargeType String PrePaid

实例的计费方式。取值:PrePaid,目前仅支持包年包月。

默认值:PrePaid

PublicIpAddresses String ["42.1.**.**", "42.2.**.**"]

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

说明 同时指定InstanceIdsPublicIpAddresses参数时,必须保证对应的实例ID和公网IP属于同一台轻量应用服务器,否则返回值为空。
PageNumber Integer 1

轻量应用服务器列表的页码。

默认值:1

PageSize Integer 10

分页查询时设置的每页行数。最大值:100

默认值:10

返回数据

名称 类型 示例值 描述
Instances Array of Instance

轻量应用服务器信息组成的数组。

BusinessStatus String Normal

服务器状态。可能值:

  • Normal:正常
  • Expired:到期
  • Overdue:欠费
ChargeType String PrePaid

计费方式。

CreationTime String 2021-03-08T05:31:06Z

创建时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

DdosStatus String Normal

DDos状态。可能值:

  • Normal:正常
  • BlackHole:黑洞中
  • Defense:清洗中
ExpiredTime String 2021-05-08T16:00:00Z

到期时间。按照ISO 8601标准表示,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

ImageId String fe9c66133a9d4688872869726b52****

镜像ID。

InnerIpAddress String 172.26.**.**

内网IP。

InstanceId String 2ad1ae67295445f598017499dc****

实例ID。

InstanceName String test-InstanceName

服务器名称。

PlanId String swas.s2.c2m2s50b4t08

套餐ID。

PublicIpAddress String 42.1.**.**

公网IP。

RegionId String cn-hangzhou

地域ID。

Status String Running

实例状态,可能值:

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

轻量应用服务器列表的页码。

PageSize Integer 10

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

RequestId String 20758A-585D-4A41-A9B2-28DA8F4F534F

请求ID。

TotalCount Integer 1

查询到的实例总数。

示例

请求示例

https://swas.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&ChargeType=PrePaid
&<公共请求参数>

正常返回示例

XML格式

<ListInstancesResponse>
      <Instances>
            <Status>Running</Status>
            <InstanceId>2ad1ae67295445f598017499dc****</InstanceId>
            <PlanId>swas.s2.c2m2s50b4t08</PlanId>
            <DdosStatus>Normal</DdosStatus>
            <BusinessStatus>Normal</BusinessStatus>
            <InstanceName>test-InstanceName</InstanceName>
            <PublicIpAddress>42.1.**.**</PublicIpAddress>
            <InnerIpAddress>172.26.**.**</InnerIpAddress>
            <ChargeType>PrePaid</ChargeType>
            <ExpiredTime>2021-05-08T16:00:00Z</ExpiredTime>
            <CreationTime>2021-03-08T05:31:06Z</CreationTime>
            <ImageId>fe9c66133a9d4688872869726b52****</ImageId>
            <RegionId>cn-hangzhou</RegionId>
      </Instances>
      <TotalCount>1</TotalCount>
      <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
      <PageSize>5</PageSize>
      <PageNumber>1</PageNumber>
</ListInstancesResponse>

JSON格式

{
  "Instances": [
    {
      "Status": "Running",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "DdosStatus": "Normal",
      "BusinessStatus": "Normal",
      "InstanceName": "test-InstanceName",
      "PublicIpAddress": "42.1.**.**",
      "InnerIpAddress": "172.26.**.**",
      "ChargeType": "PrePaid",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "CreationTime": "2021-03-08T05:31:06Z",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "RegionId": "cn-hangzhou"
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 5,
  "PageNumber": 1
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidChargeType.ValueNotSupported The specified parameter ChargeType is invalid. 指定的实例计费方式不合法。
400 InvalidPublicIpAddresses.ValueNotSupported The specified parameter PublicIpAddresses is invalid. 指定的公网IP不合法。
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定的实例不存在,请您检查实例ID是否正确。
500 InternalError An error occurred while processing your request. 内部错误,请重试。如果多次尝试失败,请提交工单。

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