调用ListIpv4Gateways查询IPv4网关实例的列表信息

调用ListIpv4Gateways接口查询IPv4网关实例的列表信息。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListIpv4Gateways	List	VPC acs:vpc:{#regionId}:{#accountId}:ipv4gateway/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要查询的IPv4网关列表信息的地域ID。您可以通过调用DescribeRegions接口获取地域ID。	ap-southeast-6
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为10。	10
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	FFmyTO70tTpLG6I3FmYAXGKPd****
VpcId	string	否	要查询的IPv4网关实例关联的VPC的ID。	vpc-5tsrxlw7dv074gci4****
Ipv4GatewayId	string	否	要查询的IPv4网关实例的ID。	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayName	string	否	要查询的IPv4网关实例的名称。名称长度为1～128个字符，不能以`http://`或`https://`开头。	name
ResourceGroupId	string	否	IPv4网关所属的资源组ID。	rg-bp67acfmxazb4ph****
Tags	object []	否	标签列表信息。
Key	string	否	标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua

返回参数

名称	类型	描述	示例值
	object	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求ID。	2D265800-E306-529C-8418-84B0A1D201DB
TotalCount	string	列表条目数。	1
Ipv4GatewayModels	object []	IPv4网关实例的列表信息。
VpcId	string	IPv4网关实例关联的VPC的ID。	vpc-5tsrxlw7dv074gci4****
Status	string	IPv4网关实例的状态。取值： Creating：创建中。 Created：已创建，可用状态。 Modifying：修改中。 Deleting：删除中。 Deleted：已删除。	Created
Ipv4GatewayId	string	IPv4网关的实例ID。	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayDescription	string	IPv4网关实例的描述信息。	test
Enabled	boolean	IPv4网关实例是否已经激活。取值： true；已激活。 false：未激活。	true
GmtCreate	string	IPv4网关创建时间	2021-12-02T07:07:35Z
Ipv4GatewayRouteTableId	string	IPv4网关实例关联的路由表ID。	vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayName	string	IPv4网关实例的名称。	name
ResourceGroupId	string	IPv4网关所属的资源组ID。	rg-bp67acfmxazb4ph****
Tags	object []	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "2D265800-E306-529C-8418-84B0A1D201DB",
  "TotalCount": "1",
  "Ipv4GatewayModels": [
    {
      "VpcId": "vpc-5tsrxlw7dv074gci4****",
      "Status": "Created",
      "Ipv4GatewayId": "ipv4gw-5tsnc6s4ogsedtp3k****",
      "Ipv4GatewayDescription": "test",
      "Enabled": true,
      "GmtCreate": "2021-12-02T07:07:35Z",
      "Ipv4GatewayRouteTableId": "vtb-5ts0ohchwkp3dydt2****",
      "Ipv4GatewayName": "name",
      "ResourceGroupId": "rg-bp67acfmxazb4ph****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-08-07

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用