Queries elastic IP addresses (EIPs).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeEipResources

The operation that you want to perform. Set the value to DescribeEipResources.

ServiceMeshId String No cb8963379255149cb98c8686f274x****

The ID of the ASM instance.

PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 50

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String BD65C0AD-D3C6-48D3-8D93-38D2015C****

The ID of the request.

EipList Array of eipList

The EIPs.

IpAddress String 120.xx.xx.112

The IP address of the EIP.

Status String InUse

The status of the EIP. Valid values:

  • Associating: The EIP is being associated with a resource.
  • Unassociating: The EIP is being disassociated from a resource.
  • InUse: The EIP is associated with a resource.
  • Available: The EIP is available.
AllocationId String eip-2zeerraiwb7ujxscd****

The ID of the EIP.

InstanceType String SlbInstance

The type of the resource that is associated with the EIP. Valid values:

  • EcsInstance: an ECS instance in a VPC
  • SlbInstance: a Server Load Balancer (SLB) instance in a VPC
  • Nat: a NAT gateway
  • HaVip: a high-availability virtual IP address (HAVIP)
  • NetworkInterface: a secondary elastic network interface (ENI)

Default value: EcsInstance.

PageResult Object

The pagination information.

TotalCount Integer 10

The number of entries returned.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeEipResources
&ServiceMeshId=cb8963379255149cb98c8686f274x****
&PageNum=1
&PageSize=50
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeEipResourcesResponse>
    <RequestId>BD65C0AD-D3C6-48D3-8D93-38D2015C****</RequestId>
    <EipList>
        <IpAddress>120.xx.xx.112</IpAddress>
        <Status>InUse</Status>
        <AllocationId>eip-2zeerraiwb7ujxscd****</AllocationId>
        <InstanceType>SlbInstance</InstanceType>
    </EipList>
    <PageResult>
        <TotalCount>10</TotalCount>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
    </PageResult>
</DescribeEipResourcesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "EipList" : {
    "IpAddress" : "120.xx.xx.112",
    "Status" : "InUse",
    "AllocationId" : "eip-2zeerraiwb7ujxscd****",
    "InstanceType" : "SlbInstance"
  },
  "PageResult" : {
    "TotalCount" : 10,
    "PageNumber" : 1,
    "PageSize" : 10
  }
}

Error codes

HTTP status code Error code Error message Description
500 ERR500 An internal server error occurred. The error message returned because a backend service error has occurred.

For a list of error codes, visit the API Error Center.