DescribeVpcs - 查询VPC列表-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

查询当前用户在当前可用区下的VPC列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeVpcs

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	待查询的 VPC 所属的地域 ID。	cn-hangzhou
ZoneId	string	否	查询的 VPC 所属的可用区 ID。	cn-hangzhou-d
PageNumber	integer	否	VPC 列表的页码。默认值：1，取值范围：1~100。	1
PageSize	integer	否	分页查询时设置的每页行数。默认值：50，取值范围：1~50。	50

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B
Vpcs	object	VPC 数组结果。
Vpc	array<object>	单个 VPC 的详细信息。
	object
VpcId	string	VPC 的 ID。	vpc-bp1qpo0kug3a20qqe****
VpcName	string	VPC 名称。	vpc1
Status	string	VPC 的状态，取值： Pending：配置中。 Available：可用。	Available
IsDefault	boolean	是否是该地域的默认 VPC，取值： true：是该地域的默认 VPC。 false：不是该地域的默认 VPC。	true
CidrBlock	string	VPC 的 IPv4 网段。	192.168.0.0/16
RegionNo	string	VPC 所在的地域 ID。	cn-hangzhou
GmtCreate	string	VPC 的创建时间。	2021-04-18T15:02:37Z
GmtModified	string	VPC 的修改时间。	2021-04-18T15:02:37Z
VSwitchs	array	查询到的 VPC 中交换机的列表信息。最多可以查询到 VPC 中最近创建的 300 个交换机的信息。
	string	交换机的 ID。	vsw-bp1nhbnpv2blyz8dl****

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B",
  "Vpcs": {
    "Vpc": [
      {
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "VpcName": "vpc1",
        "Status": "Available",
        "IsDefault": true,
        "CidrBlock": "192.168.0.0/16",
        "RegionNo": "cn-hangzhou",
        "GmtCreate": "2021-04-18T15:02:37Z",
        "GmtModified": "2021-04-18T15:02:37Z",
        "VSwitchs": [
          "vsw-bp1nhbnpv2blyz8dl****"
        ]
      }
    ]
  }
}

错误码

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

变更历史

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