Use DescribeEipSegment to query contiguous EIP groups - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Queries information about contiguous Elastic IP Address (EIP) groups.

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

vpc:DescribeEipSegment

get

*SegmentAddress

acs:vpc:{#regionId}:{#accountId}:eip/*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001sdfg
RegionId	string	Yes	The region ID of the contiguous EIP group. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
SegmentInstanceId	string	No	The instance ID of the contiguous EIP group to query. If you do not specify this parameter, information about all contiguous EIP groups in the specified region is returned.	eipsg-2zett8ba055tbsxme****
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page in a paging query.	10
RequestId	string	The request ID.	F7A6301A-64BA-41EC-8284-8F4838C15D1F
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries returned.	10
EipSegments	object
EipSegment	array<object>	The details of the contiguous EIP group.
	object	The details of the contiguous EIP group.
CreationTime	string	The time when the contiguous EIP group was created. The time is displayed in ISO 8601 standard in UTC+0 in the yyyy-MM-ddTHH:mm:ssZ format.	2020-03-06T12:30:07Z
Status	string	The status of the contiguous EIP group. Valid values: Allocating: being allocated. Allocated: allocated. Releasing: being released.	Allocated
Descritpion	string	The description of the contiguous EIP group.	MyEipSegment
InstanceId	string	The instance ID of the contiguous EIP group.	eipsg-2zett8ba055tbsxme****
IpCount	string	The number of IP addresses in the contiguous EIP group.	16
Name	string	The name of the contiguous EIP group.	MyEipSegment
Segment	string	The CIDR block and subnet mask of the contiguous EIP group.	161.xx.xx.32/28
RegionId	string	The region ID of the contiguous EIP group.	cn-hangzhou
Zone	string	The zone of the contiguous EIP group.	cn-hangzhou-a

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "F7A6301A-64BA-41EC-8284-8F4838C15D1F",
  "PageNumber": 1,
  "TotalCount": 10,
  "EipSegments": {
    "EipSegment": [
      {
        "CreationTime": "2020-03-06T12:30:07Z",
        "Status": "Allocated",
        "Descritpion": "MyEipSegment",
        "InstanceId": "eipsg-2zett8ba055tbsxme****",
        "IpCount": "16",
        "Name": "MyEipSegment",
        "Segment": "161.xx.xx.32/28",
        "RegionId": "cn-hangzhou",
        "Zone": "cn-hangzhou-a"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.