All Products
Search
Document Center

Virtual Private Cloud:DescribeEipSegment

Last Updated:Jan 29, 2024

Queries contiguous elastic IP address (EIP) groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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
EipSegmentsobject []

The details of the contiguous EIP group.

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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.