DescribeEipResources - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	No	The ID of the ASM instance.	cb8963379255149cb98c8686f274x****
PageNum	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page.	50

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
EipList	object []	The EIPs.
IpAddress	string	The IP address of the EIP.	120.xx.xx.112
Status	string	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.	InUse
AllocationId	string	The ID of the EIP.	eip-2zeerraiwb7ujxscd****
InstanceType	string	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`.	SlbInstance
PageResult	object	The pagination information.
TotalCount	integer	The number of entries returned.	10
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10

Examples

Sample success responses

JSONformat

{
  "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
500	ERR500	An internal server error occurred.

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