AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 轻量应用服务器 开发参考 API参考 API目录 实例 ListInstances - 获取实例列表

ListInstances - 获取实例列表

更新时间：
产品详情
我的收藏

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

接口说明

通过此接口可查看指定地域下一个或多个实例的详细信息，包括服务器名称、公网 IP 地址，内网 IP 地址，服务器创建时间、服务器到期时间等信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

swas-open:ListInstances

get

Instance

acs:swas-open:{#regionId}:{#accountId}:instance/*

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

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

cn-hangzhou
InstanceIds

string

否

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

说明

同时指定InstanceIds和PublicIpAddresses参数时，必须保证对应的实例 ID 和公网 IP 属于同一台轻量应用服务器，否则返回值为空。

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

string

否

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

默认值：PrePaid

PrePaid
PublicIpAddresses

string

否

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

说明

同时指定InstanceIds和PublicIpAddresses参数时，必须保证对应的实例 ID 和公网 IP 属于同一台轻量应用服务器，否则返回值为空。

["42.1.**.**", "42.2.**.**"]
PageNumber

integer

否

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

默认值：1

1
PageSize

integer

否

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

默认值：10

10
Status

string

否

实例状态，可能值：

  • Pending：准备中。

  • Starting：启动中。

  • Running：运行中。

  • Stopping：停止中。

  • Stopped：停止。

  • Resetting：重置中。

  • Upgrading：升级中。

  • Disabled：不可用。

Running
Tag

array<object>

否

实例的标签列表。

object

否

标签。

Key

string

否

实例的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。

TestKey
Value

string

否

实例的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。

TestValue
ResourceGroupId

string

否

轻量应用服务器所属的资源组 ID。

rg-aek2bti7cf7****
InstanceName

string

否

轻量应用服务器实例名称，支持使用通配符*进行模糊搜索。

test
PlanType

string

否

套餐类型，可能值：

  • NORMAL：通用型。

  • CAPACITY：容量型。

  • PREVIOUS：上一代。

  • MULTI_IP：多公网 IP 型。

  • INTERNATIONAL：国际型。

说明

更多信息，请参见实例规格族。

NORMAL

返回参数

名称

类型

描述

示例值

object

实例信息。

Instances

array<object>

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

object

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

Status

string

实例状态，可能值：

  • Pending：准备中。

  • Starting：启动中。

  • Running：运行中。

  • Stopping：停止中。

  • Stopped：停止。

  • Resetting：重置中。

  • Upgrading：升级中。

  • Disabled：不可用。

Running
CreationTime

string

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

2021-03-08T05:31:06Z
InnerIpAddress

string

内网 IP 地址。

172.26.XX.XX
ChargeType

string

计费方式。

PrePaid
InstanceId

string

实例 ID。

2ad1ae67295445f598017499dc****
PlanId

string

套餐 ID。

swas.s2.c2m2s50b4t08
PublicIpAddress

string

公网 IP 地址。

42.1.XX.XX
RegionId

string

地域 ID。

cn-hangzhou
ExpiredTime

string

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

2021-05-08T16:00:00Z
InstanceName

string

服务器名称。

test-InstanceName
BusinessStatus

string

服务器状态。可能值：

  • Normal：正常。

  • Expired：到期。

  • Overdue：欠费。

Normal
DdosStatus

string

DDos 状态。可能值：

  • Normal：正常。

  • BlackHole：黑洞中。

  • Defense：清洗中。

Normal
ImageId

string

镜像 ID。

fe9c66133a9d4688872869726b52****
DisableReason

string

资源被禁用的原因。取值范围：

  • FINANCIAL：因欠费被锁定。

  • SECURITY：因安全原因被锁定。

  • EXPIRED：实例过期。

EXPIRED
Combination

boolean

是否为组合套餐。

false
CombinationInstanceId

string

组合套餐实例 ID。

com-f6c9a22****45b5b8de68ad608af1ba
Uuid

string

实例的 UUID。

41f30524-5df7-49c9-9c6e-32****489001
ResourceSpec

object

资源规格。

DiskCategory

string

磁盘类型，可能值：

  • ESSD：ESSD 云盘，性能级别 PL0。

  • SSD：SSD 云盘。

  • CLOUD_EFFICIENCY：高效云盘。

ESSD
Cpu

integer

vCPU 核数。

2
Bandwidth

integer

带宽大小，单位：Mbps。

200
DiskSize

integer

磁盘大小，单位：GiB。

60
Memory

number

内存大小，单位：GiB。

2
Flow

number

流量大小。

  • 流量为 0 代表带宽型主机。

  • 非 0 代表流量包型主机。

818
Image

object

镜像的说明信息。

OsType

string

操作系统类型。

windows
ImageName

string

镜像名称。

test-custom-1686536882356
ImageVersion

string

镜像版本。

V3.5
ImageType

string

镜像类型。取值范围：

  • system：系统镜像。

  • app：应用镜像。

  • custom：自定义镜像。

system
ImageIconUrl

string

镜像图标 URL。

https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg
ImageContact

string

镜像提供商。

https://selfs****e.console.aliyun.com/ticket/createIndex
Tags

array<object>

实例的标签列表。

object

标签。

Key

string

实例的标签键。

TestKey
Value

string

实例的标签值。

TestValue
Disks

array<object>

轻量对应磁盘信息的数组。

object

磁盘信息。

CreationTime

string

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

2023-02-24T02:20:10Z
Status

string

磁盘状态。可能值：

  • ReIniting：初始化中。

  • Creating：创建中。

  • In_use：使用中。

  • Available：待挂载。

  • Attaching：挂载中。

  • Detaching：卸载中。

In_use
Device

string

磁盘挂载服务器中的设备名。

/dev/xvda
Size

integer

磁盘大小。单位：GiB。

50
DiskName

string

磁盘名称。

SystemDisk
DiskChargeType

string

磁盘的计费方式。

PrePaid
DiskType

string

磁盘类型。可能值：

  • system：系统盘。

  • data：数据盘。

system
Category

string

磁盘类型，可能值：

  • ESSD：ESSD 云盘，性能级别 PL0。

  • SSD：SSD 云盘。

  • CLOUD_EFFICIENCY：高效云盘。

ESSD
DiskId

string

磁盘 ID。

d-bp14wq0149cpp2x****
RegionId

string

地域 ID。

cn-hangzhou
Remark

string

磁盘备注。

remark
DiskTags

array<object>

磁盘的标签信息。

object

标签信息。

Key

string

标签键。

TestKey
Value

string

标签值。

TestValue
ResourceGroupId

string

磁盘所属的资源组 ID。

rg-aek2bti7cf7****

ResourceGroupId

string

实例所属的资源组 ID。

rg-aekz7jmhg5s****
NetworkAttributes

array<object>

网络返回信息。

object

网络返回信息。

PublicIpAddress

string

公网 IP 地址。

116.62.XX.XX
PrivateIpAddress

string

私网 IP 地址。

72.25.XX.XX
PeakBandwidth

integer

公网峰值带宽。单位为 Mbps。

200
PublicIpDdosStatus

string

公网 IP 的 DDos 状态。

normal
PlanType

string

套餐类型，可能值：

  • NORMAL：通用型。

  • CAPACITY：容量型。

  • PREVIOUS：上一代。

  • MULTI_IP：多公网 IP 型。

  • INTERNATIONAL：国际型。

说明

更多信息，请参见实例规格族。

NORMAL
TotalCount

integer

查询到的实例总数。

1
RequestId

string

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F****
PageSize

integer

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

10
PageNumber

integer

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

1

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "Status": "Running",
      "CreationTime": "2021-03-08T05:31:06Z",
      "InnerIpAddress": "172.26.XX.XX",
      "ChargeType": "PrePaid",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "PlanId": "swas.s2.c2m2s50b4t08",
      "PublicIpAddress": "42.1.XX.XX",
      "RegionId": "cn-hangzhou",
      "ExpiredTime": "2021-05-08T16:00:00Z",
      "InstanceName": "test-InstanceName",
      "BusinessStatus": "Normal",
      "DdosStatus": "Normal",
      "ImageId": "fe9c66133a9d4688872869726b52****",
      "DisableReason": "EXPIRED",
      "Combination": false,
      "CombinationInstanceId": "com-f6c9a22****45b5b8de68ad608af1ba",
      "Uuid": "41f30524-5df7-49c9-9c6e-32****489001",
      "ResourceSpec": {
        "DiskCategory": "ESSD",
        "Cpu": 2,
        "Bandwidth": 200,
        "DiskSize": 60,
        "Memory": 2,
        "Flow": 818
      },
      "Image": {
        "OsType": "windows",
        "ImageName": "test-custom-1686536882356",
        "ImageVersion": "V3.5",
        "ImageType": "system",
        "ImageIconUrl": "https://img.alicdn.com/imgextra/i3/O****1vdh9651ReKqWNMI2I_!!6000000002136****-24-24.svg",
        "ImageContact": "https://selfs****e.console.aliyun.com/ticket/createIndex"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Disks": [
        {
          "CreationTime": "2023-02-24T02:20:10Z",
          "Status": "In_use",
          "Device": "/dev/xvda",
          "Size": 50,
          "DiskName": "SystemDisk",
          "DiskChargeType": "PrePaid",
          "DiskType": "system",
          "Category": "ESSD",
          "DiskId": "d-bp14wq0149cpp2x****",
          "RegionId": "cn-hangzhou",
          "Remark": "remark",
          "DiskTags": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ],
          "ResourceGroupId": "rg-aek2bti7cf7****\n"
        }
      ],
      "ResourceGroupId": "rg-aekz7jmhg5s****",
      "NetworkAttributes": [
        {
          "PublicIpAddress": "116.62.XX.XX",
          "PrivateIpAddress": "72.25.XX.XX",
          "PeakBandwidth": 200,
          "PublicIpDdosStatus": "normal"
        }
      ],
      "PlanType": "NORMAL"
    }
  ],
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "PageSize": 10,
  "PageNumber": 1
}

错误码

HTTP status code

错误码

错误信息

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

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

变更历史

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

上一篇：UpdateInstanceAttribute - 修改实例部分信息下一篇：LoginInstance - 远程登录实例