ListInstances_轻量应用服务器_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
swas-open:ListInstances
Get
Instance
acs:swas-open:{#regionId}:{#accountId}:instance/*
Instance
acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    ListRegions
InstanceIdsstring

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

示例值:["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]参考取值来源:
    CreateInstances
    ListInstanceStatus
    DescribeDatabaseInstances
ChargeTypestring

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

示例值:PrePaid
PublicIpAddressesstring

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

示例值:["42.1.**.**", "42.2.**.**"]
PageNumberinteger<int32>

轻量应用服务器列表的页码。展开详情

示例值:1取值 <= 1000
PageSizeinteger<int32>

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

示例值:10取值 <= 100
Statusstring

实例状态,可能值:展开详情

示例值:Running
Tagarray<object>

实例的标签列表。

子级条数 <= 100
ResourceGroupIdstring

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

示例值:rg-aek2bti7cf7****
InstanceNamestring

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

示例值:*test,test*,*test*参考取值来源:
    DescribeDatabaseInstances
PlanTypestring

套餐类型,可能值:展开详情

示例值:NORMAL参考取值来源:
    ListPlans

返回参数

字段名称字段详情
Instancesarray<object>

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

TotalCountinteger<int32>

查询到的实例总数。

示例值:1
RequestIdstring

请求 ID。

示例值:20758A-585D-4A41-A9B2-28DA8F4F****
PageSizeinteger<int32>

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

示例值:10
PageNumberinteger<int32>

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

示例值:1

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidChargeType.ValueNotSupported
The specified parameter ChargeType is invalid.诊断
400
InvalidPublicIpAddresses.ValueNotSupported
The specified parameter PublicIpAddresses is invalid.诊断
404
InvalidInstanceId.NotFound
The specified InstanceId does not exist.诊断
500
InternalError
An error occurred while processing your request.诊断

变更历史

变更时间变更内容概要操作
2025-03-20
新增请求参数PlanType
变更返回参数
2025-03-14
变更返回参数
2024-06-17
新增请求参数InstanceName
2024-05-29
新增请求参数ResourceGroupId
变更返回参数
2024-02-20
变更返回参数
2024-01-17
新增请求参数Tag
  • 1
  • 2
  • 10 条/页

相关示例