调用DescribeEipSegment查询连续EIP组-弹性公网IP-阿里云

调用DescribeEipSegment查询连续EIP组的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	02fb3da4-130e-11e9-8e44-001sdfg
RegionId	string	是	连续 EIP 组所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
SegmentInstanceId	string	否	要查询的连续 EIP 组的实例 ID。未指定时，返回指定地域下所有连续 EIP 组的信息。	eipsg-2zett8ba055tbsxme****
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的条目数。最大值：50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
PageSize	integer	分页查询时每页的条目数。	10
RequestId	string	请求 ID。	F7A6301A-64BA-41EC-8284-8F4838C15D1F
PageNumber	integer	列表的页码。	1
TotalCount	integer	列表条目数。	10
EipSegments	array<object>	连续 EIP 组详情。
EipSegment	object	连续 EIP 组详情。
CreationTime	string	连续 EIP 组的创建时间。按照 ISO8601 标准表示，并需要使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-03-06T12:30:07Z
Status	string	连续 EIP 组的状态。 Allocating：分配中。 Allocated：已分配。 Releasing：释放中。	Allocated
Descritpion	string	连续 EIP 组的描述。	MyEipSegment
InstanceId	string	连续 EIP 组的实例 ID。	eipsg-2zett8ba055tbsxme****
IpCount	string	连续 EIP 组中包含的 IP 个数。	16
Name	string	连续 EIP 组名称。	MyEipSegment
Segment	string	连续 EIP 组的网段与掩码。	161.xx.xx.32/28
RegionId	string	连续 EIP 组所属的地域 ID。	cn-hangzhou
Zone	string	连续 EIP 组的可用区。	cn-hangzhou-a

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息
400	OperationFailed.QueryDbError	Operation failed because query db error.

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-04-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情