GetIpv4GatewayAttribute - Query IPv4 gateway attributes - Virtual Private Cloud

Queries the attributes of a specified IPv4 gateway.

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:GetIpv4GatewayAttribute

get

*Ipv4Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv4 gateway. Call the DescribeRegions operation to query available regions.	ap-southeast-6
Ipv4GatewayId	string	Yes	The ID of the IPv4 gateway.	ipv4gw-5tsnc6s4ogsedtp3k****
RegionId	string	Yes	The region ID of the IPv4 gateway. Call the DescribeRegions operation to query available regions.	ap-southeast-6

Response elements

Element	Type	Description	Example
	object	The details of the IPv4 gateway.
VpcId	string	The VPC ID associated with the IPv4 gateway.	vpc-5tsrxlw7dv074gci4****
Status	string	The status of the IPv4 gateway. Valid values: Creating Created Modifying Deleting Deleted Activating	Created
Ipv4GatewayId	string	The ID of the IPv4 gateway.	ipv4gw-5tsnc6s4ogsedtp3k****
RequestId	string	The request ID.	7F79A919-6FE9-50C4-967B-45705E1F9C38
Ipv4GatewayDescription	string	The description of the IPv4 gateway.	new
Enabled	boolean	Whether the IPv4 gateway is activated. Valid values: true false	true
Ipv4GatewayRouteTableId	string	The ID of the route table associated with the IPv4 gateway.	vtb-5ts0ohchwkp3dydt2****
Ipv4GatewayName	string	The name of the IPv4 gateway.	name
CreateTime	string	The time when the IPv4 gateway was created.	2022-02-24T09:02:36Z
ResourceGroupId	string	The resource group ID of the IPv4 gateway.	rg-bp67acfmxazb4ph****
Tags	array<object>	The tags.
	object
Key	string	The key of tag N added to the resource.	FinanceDept
Value	string	The value of tag N added to the resource.	FinanceJoshua

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.Ipv4Gateway	The specified resource ipv4Gateway is not found.	The IPv4 gateway is not found and cannot be deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.