DescribeEipGatewayInfo - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the gateway and subnet mask of an elastic IP address (EIP).

Operation description

You can query only EIPs that are associated with secondary elastic network interfaces (ENIs) in multi-EIP-to-ENI mode.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeEipGatewayInfo	list	GatewayInfo acs:vpc:{#regionId}:{#accountId}:eip/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the secondary ENI that is associated with the EIP.	eni-bp1d66qjxb3qoin3****
RegionId	string	Yes	The region to which the EIP that you want to query belongs. You can call the DescribeRegions operation to query the most recent region list.	cn-zhangjiakou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Code	string	The status code of the operation.	200
Message	string	The result of the operation.	successful
RequestId	string	The request ID.	C0FD0EED-F90D-4479-803D-DD62335357E5
EipInfos	array<object>	The detailed information about the EIP.
	object
Ip	string	The IP address of the EIP.	47.XX.XX.236
IpGw	string	The IP address of the gateway that is associated with the EIP.	47.XX.XX.1
IpMask	string	The subnet mask of the EIP.	255.255.255.0

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "C0FD0EED-F90D-4479-803D-DD62335357E5\t",
  "EipInfos": {
    "EipInfo": [
      {
        "Ip": "47.XX.XX.236",
        "IpGw": "47.XX.XX.1",
        "IpMask": "255.255.255.0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.NotExist	The instance is not exist.	-
400	InvalidNetworkInterface.NotFound	The specified network interface is not exist.	-
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-18	API Description Update. The Error code has changed	View Change Details
2023-05-15	The Error code has changed	View Change Details