调用DescribeEipSegment接口查询连续EIP组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ClientToken | String | 否 | 02fb3da4-130e-11e9-8e44-001sdfg | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。 |
Action | String | 是 | DescribeEipSegment | 系统规定参数。取值:DescribeEipSegment。 |
RegionId | String | 是 | cn-hangzhou | 连续EIP组所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。 |
SegmentInstanceId | String | 否 | eipsg-2zett8ba055tbsxme**** | 要查询的连续EIP组的实例ID。 |
PageNumber | Integer | 否 | 1 | 列表的页码。默认值:1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页的条目数。最大值:50。默认值:10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 | 分页查询时每页的条目数。 |
RequestId | String | F7A6301A-64BA-41EC-8284-8F4838C15D1F | 请求ID。 |
PageNumber | Integer | 1 | 列表的页码。 |
TotalCount | Integer | 10 | 列表条目数。 |
EipSegments | Array of EipSegment | 连续EIP组详情。 |
|
EipSegment | |||
CreationTime | String | 2020-03-06T12:30:07Z | 连续EIP组的创建时间。按照ISO8601标准表示,并需要使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
Status | String | Allocated | 连续EIP组的状态。
|
Descritpion | String | MyEipSegment | 连续EIP组的描述。 |
InstanceId | String | eipsg-2zett8ba055tbsxme**** | 连续EIP组的实例ID。 |
IpCount | String | 16 | 连续EIP组中包含的IP个数。 |
Name | String | MyEipSegment | 连续EIP组名称。 |
Segment | String | 161.xx.xx.32/28 | 连续EIP组的网段与掩码。 |
RegionId | String | cn-hangzhou | 连续EIP组所属的地域ID。 |
Zone | String | cn-hangzhou-a | 连续EIP组的可用区。 |
示例
请求示例
http(s)://[Endpoint]/?ClientToken=02fb3da4-130e-11e9-8e44-001sdfg
&Action=DescribeEipSegment
&RegionId=cn-hangzhou
&SegmentInstanceId=eipsg-2zett8ba055tbsxme****
&PageNumber=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
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
格式
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"
} ]
}
错误码
访问错误中心查看更多错误码。