All Products
Search
Document Center

Virtual Private Cloud:DescribeEipSegment

Last Updated:Nov 27, 2024

Queries contiguous elastic IP address (EIP) groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeEipSegmentget
*SegmentAddress
acs:vpc:{#regionId}:{#accountId}:eip/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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 request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-001sdfg
RegionIdstringYes

The ID of the region to which the contiguous EIP group belongs. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
SegmentInstanceIdstringNo

The ID of the contiguous EIP group that you want to query.

eipsg-2zett8ba055tbsxme****
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

F7A6301A-64BA-41EC-8284-8F4838C15D1F
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

10
EipSegmentsarray<object>

The details of the contiguous EIP group.

EipSegmentobject
CreationTimestring

The time when the contiguous EIP group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2020-03-06T12:30:07Z
Statusstring

The status of the contiguous EIP group. Valid values:

  • Allocating
  • Allocated
  • Releasing
Allocated
Descritpionstring

The description of the contiguous EIP group.

MyEipSegment
InstanceIdstring

The ID of the contiguous EIP group.

eipsg-2zett8ba055tbsxme****
IpCountstring

The number of EIPs in the contiguous EIP group.

16
Namestring

The name of the contiguous EIP group.

MyEipSegment
Segmentstring

The CIDR block and mask of the contiguous EIP group.

161.xx.xx.32/28
RegionIdstring

The ID of the region to which the contiguous EIP group belongs.

cn-hangzhou
Zonestring

The zone of the contiguous EIP group.

cn-hangzhou-a

Examples

Sample success responses

JSONformat

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

HTTP status codeError codeError message
400OperationFailed.QueryDbErrorOperation failed because query db error.

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

Change history

Change timeSummary of changesOperation
2023-04-10The Error code has changed. The response structure of the API has changedView Change Details