全部产品
Search
文档中心

弹性公网 IP:DescribeEipSegment - 查询连续EIP组

更新时间:May 31, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeEipSegmentRead
  • SegmentAddress
    acs:vpc:{#regionId}:{#accountId}:eip/*

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001sdfg
RegionIdstring

连续 EIP 组所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
SegmentInstanceIdstring

要查询的连续 EIP 组的实例 ID。

eipsg-2zett8ba055tbsxme****
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的条目数。最大值:50。默认值:10

10

返回参数

名称类型描述示例值
object

返回信息列表。

PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

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

列表的页码。

1
TotalCountinteger

列表条目数。

10
EipSegmentsobject []

连续 EIP 组详情。

CreationTimestring

连续 EIP 组的创建时间。按照 ISO8601 标准表示,并需要使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

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

连续 EIP 组的状态。

  • Allocating:分配中。

  • Allocated:已分配。

  • Releasing:释放中。

Allocated
Descritpionstring

连续 EIP 组的描述。

MyEipSegment
InstanceIdstring

连续 EIP 组的实例 ID。

eipsg-2zett8ba055tbsxme****
IpCountstring

连续 EIP 组中包含的 IP 个数。

16
Namestring

连续 EIP 组名称。

MyEipSegment
Segmentstring

连续 EIP 组的网段与掩码。

161.xx.xx.32/28
RegionIdstring

连续 EIP 组所属的地域 ID。

cn-hangzhou
Zonestring

连续 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错误码错误信息
400OperationFailed.QueryDbErrorOperation failed because query db error.

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

变更历史

变更时间变更内容概要操作
2023-04-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更