首页 API 网关 开发指南 API参考指南 API目录 实例 DescribeInstances - 查询实例列表

DescribeInstances - 查询实例列表

查询region下的共享实例/专享实例详情。

调试

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

调试

授权信息

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

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

请求参数

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

实例id 不填写默认查询所有实例

api-shared-vpc-001
Languagestring

语言类型。系统权限策略的描述将以此语言返回。

  • en:英文。
  • zh:中文。
  • ja:日文。
zh
EnableTagAuthorizationboolean

是否开启了Tag授权

false
Tagarray

实例所绑定的标签

object

实例所绑定的标签

Keystring

标签键。

key1
Valuestring

标签的值。

value

返回参数

名称类型描述示例值
object
PageNumberinteger

当前页码

1
RequestIdstring

请求id

CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSizeinteger

每页数目。

10
TotalCountinteger

总数。

1
Instancesarray

实例信息列表。

object

实例列表信息。

Statusstring

实例状态

RUNNING
VpcSlbIntranetEnableboolean

是否开启内网VPC SLB

true
ClassicEgressAddressstring

出口地址

10.0.0.1
ZoneLocalNamestring

可用区域

多可用区 2
VipTypeListstring
UserVpcIdstring

用户VPC Id

vpc-t***hx****yu9****t0g4
VpcIntranetEnableboolean

是否开启内网VPC

true
VpcOwnerIdlong

VPC实例所属账号ID。

1408453217640291****
InstanceIdstring

实例id

api-shared-vpc-020
InstanceRpsLimitinteger

实例rps限制

500
InstanceTypestring

实例类型

  • VPC_SHARED:共享实例(VPC)
  • VPC_DEDICATED:专享实例(VPC)
VPC_SHARED
RegionIdstring

所在的region

cn-beijing
InstanceSpecstring

实例规格

api.s1.small
InstanceChargeTypestring

实例的计费方式。可能值:

  • PrePaid:包年包月。
  • PayAsYouGo:按量付费。
PrePaid
HttpsPoliciesstring

https安全策略

HTTPS2_TLS1_2
VpcEgressAddressstring

内网VPC出口网段

100.104.254.0/26
EgressIpv6Enableboolean

IPV6出访能力是否支持

true
ExpiredTimestring

实例过期时间。

1659801600000
InstanceNamestring

实例名称

test
ZoneIdstring

可用区ID

cn-hangzhou-MAZ5(g,h)
SupportIpv6boolean

是否支持ipv6

true
InternetEgressAddressstring

公网出口地址

47.241.89.244
CreatedTimestring

实例创建时间

2021-10-22 15:36:53.0
InstanceSpecAttributesarray

实例规格

object

实例规格

Valuestring

变量值

2500
LocalNamestring

变量名

最大每秒请求数
UserVswitchIdstring

用户交互机Id

vsw-t4***eh****d7q****i2f
AclNamestring

访问控制策略名称。

test
AclTypestring

访问控制的类型:

  • black:黑名单
  • white:白名单
white
AclStatusstring

是否开启访问控制功能。取值:

  • on:开启访问控制。

  • off:关闭访问控制。

on
AclIdstring

访问控制策略ID。

acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegmentsstring

错误码

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

变更历史

变更时间变更内容概要操作
2022-06-10新增 OpenAPI
阿里云首页 API 网关 相关技术圈