Use ListIpv4Gateways to query IPv4 gateways - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Queries a list of IPv4 gateway instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ListIpv4Gateways

list

Ipv4Gateway

acs:vpc:{#regionId}:{#accountId}:ipv4gateway/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv4 gateways to query. Call the DescribeRegions operation to query the most recent region list.	ap-southeast-6
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token for the next query. Valid values: If this is your first query or no more results exist, ignore this parameter. If more results exist, set this to the NextToken value returned from the previous call.	FFmyTO70tTpLG6I3FmYAXGKPd****
VpcId	string	No	The ID of the VPC associated with the IPv4 gateway.	vpc-5tsrxlw7dv074gci4****
Ipv4GatewayId	string	No	The ID of the IPv4 gateway.	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayName	string	No	The name of the IPv4 gateway. The name must be 1 to 128 characters in length, and cannot start with `http://` or `https://`.	name
RegionId	string	Yes	The region ID of the IPv4 gateways to query. Call the DescribeRegions operation to query the most recent region list.	ap-southeast-6
ResourceGroupId	string	No	The ID of the resource group to which the IPv4 gateway belongs.	rg-bp67acfmxazb4ph****
Tags	array<object>	No	The tags of the resource.
	object	No	The tags of the resource.
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The key cannot exceed 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with `aliyun` or `acs:`. The key cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value cannot exceed 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The tag value must start with a letter but cannot start with `aliyun` or `acs:`. The tag value cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token for the next query. Valid values: If NextToken is not returned, no more results are available. If NextToken is returned, the value is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	2D265800-E306-529C-8418-84B0A1D201DB
TotalCount	string	The total number of entries returned.	1
Ipv4GatewayModels	array<object>	The list of IPv4 gateways.
	array<object>
VpcId	string	The ID of the VPC associated with the IPv4 gateways.	vpc-5tsrxlw7dv074gci4****
Status	string	The status of the IPv4 gateway. Valid values: Creating Created Modifying Deleting Deleted	Created
Ipv4GatewayId	string	The ID of the IPv4 gateway.	ipv4gw-5tsnc6s4ogsedtp3k****
Ipv4GatewayDescription	string	The description of the IPv4 gateway.	test
Enabled	boolean	Whether the IPv4 gateway is activated. Valid values: true: yes false: no	true
GmtCreate	string	The time when the IPv4 gateway was created.	2021-12-02T07:07:35Z
Ipv4GatewayRouteTableId	string	The ID of the route table associated with the IPv4 gateway.	vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayName	string	The name of the IPv4 gateway.	name
ResourceGroupId	string	The ID of the resource group to which the IPv4 gateway belongs.	rg-bp67acfmxazb4ph****
Tags	array<object>	The tags added to the IPv4 gateway.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.