DescribeEipResources - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries elastic IP address (EIP) resources.

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

servicemesh:DescribeEipResources

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The returned object.
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
EipList	array<object>	The list of EIP resources.
	object	The details of the EIP.
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 attached. `Unassociating`: The EIP is being detached. `InUse`: The EIP is allocated. `Available`: The EIP is available.	InUse
AllocationId	string	The ID of the EIP instance.	eip-2zeerraiwb7ujxscd****
InstanceType	string	The type of the resource to which the EIP is bound. Valid values: `EcsInstance`: an ECS instance in a VPC. `SlbInstance`: an 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 paging information.
TotalCount	integer	The total number of entries.	10
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.