All Products
Search
Document Center

Virtual Private Cloud:DescribeEipGatewayInfo

Last Updated:Mar 04, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the secondary ENI that is associated with the EIP.

eni-bp1d66qjxb3qoin3****
RegionIdstringYes

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

ParameterTypeDescriptionExample
object

The response parameters.

Codestring

The status code of the operation.

200
Messagestring

The result of the operation.

successful
RequestIdstring

The request ID.

C0FD0EED-F90D-4479-803D-DD62335357E5
EipInfosobject []

The detailed information about the EIP.

Ipstring

The IP address of the EIP.

47.XX.XX.236
IpGwstring

The IP address of the gateway that is associated with the EIP.

47.XX.XX.1
IpMaskstring

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 codeError codeError messageDescription
400Instance.NotExistThe instance is not exist.-
400InvalidNetworkInterface.NotFoundThe specified network interface is not exist.-
403ForbiddenUser 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 timeSummary of changesOperation
2023-09-18API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
2023-05-15The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 400