文档

DescribeInstances - 查询实例列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

api-shared-vpc-001
Languagestring

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

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

是否开启了 Tag 授权

false
Tagobject []

实例所绑定的标签

Keystring

标签键。

key1
Valuestring

标签的值。

value

返回参数

名称类型描述示例值
object
PageNumberinteger

当前页码

1
RequestIdstring

请求 id

CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSizeinteger

每页数目。

10
TotalCountinteger

总数。

1
Instancesobject []

实例信息列表。

Statusstring

实例状态

RUNNING
VpcSlbIntranetEnableboolean

是否开启内网 VPC SLB

true
ClassicEgressAddressstring

出口地址

10.0.0.1
ZoneLocalNamestring

可用区域

多可用区 2
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
InstanceSpecAttributesobject []

实例规格

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

可访问 API 网关实例的内网网段

[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclNamestring

IPV6 访问控制策略名称

testIPV6
IPV6AclIdstring

IPV6 访问控制策略 ID

acl-124resFfs235
IPV6AclTypestring

IPV6 访问控制策略类型

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

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

  • on:开启访问控制。

  • off:关闭访问控制。

off
DedicatedInstanceTypestring

专享实例类型

  • vpc_connect:VPC 融合类型专享实例
  • normal:传统类型专享实例
vpc_connect
InstanceCidrBlockstring

专享实例所在网段

  • 172.16.0.0/12
  • 192.168.0.0/16
192.168.0.0/16
ConnectVpcIdstring

VPC 融合类型专享实例联通的用户 VPC ID

vpc-m5eo7khlb4h4f8y9egsdg
NetworkInterfaceAttributesobject []

VPC 融合类型专享实例连通的用户 VPC 内的网络信息

VswitchIdstring

虚拟交换机 ID

vsw-2zeqals6rbj51bhjn8b89
SecurityGroupIdstring

安全组的 ID,同一个安全组内的服务可以互相访问。

sg-2zeehz13zcyj1kfk3o85
CidrBlockstring

vSwitch 的网段。

192.168.17.0/24
ZoneIdstring

可用区 ID

cn-shenzhen-d
InstanceClusterIdstring

纳管该专享实例的专享实例集群的 ID

apigateway-cluster-sh-1523cafbgffd
MaintainStartTimestring

可运维开始时间,格式为HH:mmZ(UTC 时间)。

22:00Z
MaintainEndTimestring

可运维结束时间,格式为HH:mmZ(UTC 时间)。

01:00Z
ConnectCidrBlocksstring

VPC 融合类型专享实例,可以访问到的用户 VPC 的内网网段。

[\"172.16.0.0/24\",\"172.16.1.0/24\"]

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "Instances": {
    "InstanceAttribute": [
      {
        "Status": "RUNNING",
        "VpcSlbIntranetEnable": true,
        "ClassicEgressAddress": "10.0.0.1",
        "ZoneLocalName": "多可用区 2",
        "UserVpcId": "vpc-t***hx****yu9****t0g4",
        "VpcIntranetEnable": true,
        "VpcOwnerId": 0,
        "InstanceId": "api-shared-vpc-020",
        "InstanceRpsLimit": 500,
        "InstanceType": "VPC_SHARED",
        "RegionId": "cn-beijing",
        "InstanceSpec": "api.s1.small",
        "InstanceChargeType": "PrePaid",
        "HttpsPolicies": "HTTPS2_TLS1_2",
        "VpcEgressAddress": "100.104.254.0/26",
        "EgressIpv6Enable": true,
        "ExpiredTime": "1659801600000",
        "InstanceName": "test",
        "ZoneId": "cn-hangzhou-MAZ5(g,h)",
        "SupportIpv6": true,
        "InternetEgressAddress": "47.241.89.244",
        "CreatedTime": "2021-10-22 15:36:53.0",
        "InstanceSpecAttributes": {
          "SpecAttribute": [
            {
              "Value": "2500",
              "LocalName": "最大每秒请求数"
            }
          ]
        },
        "UserVswitchId": "vsw-t4***eh****d7q****i2f",
        "AclName": "test",
        "AclType": "white",
        "AclStatus": "on",
        "AclId": "acl-uf6f9zfxfxtp5j9ng3yv4",
        "IntranetSegments": "[\\\"172.36.0.0/16\\\",\\\"172.31.16.0/20\\\"]",
        "IPV6AclName": "testIPV6",
        "IPV6AclId": "acl-124resFfs235",
        "IPV6AclType": "black",
        "IPV6AclStatus": "off",
        "DedicatedInstanceType": "vpc_connect",
        "InstanceCidrBlock": "192.168.0.0/16",
        "ConnectVpcId": "vpc-m5eo7khlb4h4f8y9egsdg",
        "NetworkInterfaceAttributes": {
          "NetworkInterfaceAttribute": [
            {
              "VswitchId": "vsw-2zeqals6rbj51bhjn8b89",
              "SecurityGroupId": "sg-2zeehz13zcyj1kfk3o85",
              "CidrBlock": "192.168.17.0/24",
              "ZoneId": "cn-shenzhen-d"
            }
          ]
        },
        "InstanceClusterId": "apigateway-cluster-sh-1523cafbgffd",
        "MaintainStartTime": "22:00Z",
        "MaintainEndTime": "01:00Z",
        "ConnectCidrBlocks": "[\\\"172.16.0.0/24\\\",\\\"172.16.1.0/24\\\"]",
        "PrivateDnsList": {
          "PrivateDns": [
            ""
          ]
        },
        "Tags": {
          "TagInfo": [
            {
              "Key": "",
              "Value": ""
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-03-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-06-10新增 OpenAPI看变更集
  • 本页导读 (1)