DescribeEipSegment -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
ClientToken	String	No	02fb3da4-130e-11e9-8e44-001sdfg	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 client token as the request ID. The request ID may be different for each API request.
Action	String	Yes	DescribeEipSegment	The operation that you want to perform. Set the value to DescribeEipSegment.
RegionId	String	Yes	cn-hangzhou	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.
SegmentInstanceId	String	No	eipsg-2zett8ba055tbsxme****	The ID of the contiguous EIP group that you want to query.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
PageSize	Integer	No	10	The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters


Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	F7A6301A-64BA-41EC-8284-8F4838C15D1F	The request ID.
PageNumber	Integer	1	The number of the returned page.
TotalCount	Integer	10	The total number of entries returned.
EipSegments	Array of EipSegment		The details of the contiguous EIP group.
EipSegment
CreationTime	String	2020-03-06T12:30:07Z	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.
Status	String	Allocated	The status of the contiguous EIP group. Valid values: Allocating Allocated Releasing
Descritpion	String	MyEipSegment	The description of the contiguous EIP group.
InstanceId	String	eipsg-2zett8ba055tbsxme****	The ID of the contiguous EIP group.
IpCount	String	16	The number of EIPs in the contiguous EIP group.
Name	String	MyEipSegment	The name of the contiguous EIP group.
Segment	String	161.xx.xx.32/28	The CIDR block and mask of the contiguous EIP group.
RegionId	String	cn-hangzhou	The ID of the region to which the contiguous EIP group belongs.
Zone	String	cn-hangzhou-a	The zone of the contiguous EIP group.

Examples

Sample requests

http(s)://[Endpoint]/?ClientToken=02fb3da4-130e-11e9-8e44-001sdfg
&Action=DescribeEipSegment
&RegionId=cn-hangzhou
&SegmentInstanceId=eipsg-2zett8ba055tbsxme****
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeEipSegmentResponse>
    <PageSize>10</PageSize>
    <RequestId>F7A6301A-64BA-41EC-8284-8F4838C15D1F</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>10</TotalCount>
    <EipSegments>
        <CreationTime>2020-03-06T12:30:07Z</CreationTime>
        <Status>Allocated</Status>
        <Descritpion>MyEipSegment</Descritpion>
        <InstanceId>eipsg-2zett8ba055tbsxme****</InstanceId>
        <IpCount>16</IpCount>
        <Name>MyEipSegment</Name>
        <Segment>161.xx.xx.32/28</Segment>
        <RegionId>cn-hangzhou</RegionId>
    </EipSegments>
</DescribeEipSegmentResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "F7A6301A-64BA-41EC-8284-8F4838C15D1F",
  "PageNumber" : 1,
  "TotalCount" : 10,
  "EipSegments" : [ {
    "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"
  } ]
}

Error codes

For a list of error codes, see Service error codes.