DescribeEipSegment

呼叫 DescribeEipSegment 查詢連續 EIP 組的資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeEipSegment

get

*SegmentAddress

acs:vpc:{#regionId}:{#accountId}:eip/*

無

請求參數

名稱	類型	必填	描述	樣本值
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	object
EipSegment	array<object>	連續 EIP 組詳情。
	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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。