調用ListOriginPools介面查詢源位址集區列表-邊緣安全加速-阿里雲

查詢網站下所有源位址集區，支援分頁，可以按源位址名稱精確查詢、模糊查詢。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

esa:ListOriginPools

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	頁碼，預設值為 1。	1
PageSize	integer	否	頁面大小，大於 0 的整數，最大 500，超過 500 會置為 500。	20
Name	string	否	源位址集區名稱。	pool1
MatchType	string	否	按名稱匹配查詢類型，支援以下 2 種類型，預設為精確查詢。 fuzzy：模糊查詢。 exact：精確查詢。	exact
OrderBy	string	否	排序，支援按 ID 的升序、降序，預設按 ID 降序，ID 和建立時間正相關。 id: 按 ID 降序。 id: 按 ID 升序。	id
SiteId	integer	是	網站 ID，可通過調用 ListSites 介面擷取。	151538882642832

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	源位址集區列表。
	array<object>	源位址集區資訊。
Id	integer	源位址集區 ID。	1038520525196928
Name	string	源位址集區名稱，一個網站下源位址集區名稱唯一。	pool1
SiteId	integer	源位址集區所屬的網站 ID。	216558609793952
RecordName	string	為源位址集區分配的網域名稱，可以用來作網站下記錄的來源站點地址。	pool1.example.com
Enabled	boolean	源位址集區是否啟用： true: 啟用； false：不啟用。	false
References	object	源位址集區被引用資訊，源位址集區被負載平衡器配置或者被記錄配置為來源站點時，被認為是引用。
LoadBalancers	array<object>	使用此源位址集區的負載平衡器列表。
	object	使用此源位址集區的負載平衡器資訊。
Name	string	負載平衡器名字。	lb1.example.com
Id	integer	負載平衡器 ID。	998740660522624
DnsRecords	array<object>	使用此源位址集區為來源站點的七層記錄列表。
	object	使用此源位址集區為來源站點的七層記錄資訊。
Name	string	記錄名稱。	www.example.com
Id	integer	記錄 ID。	1042852886352704
IPARecords	array<object>	使用此源位址集區為來源站點的四層記錄列表。
	object	使用此源位址集區為來源站點的四層記錄資訊。
Name	string	記錄名稱。	ipa.example.com
Id	integer	記錄 ID。	1042852886352704
ReferenceLBCount	integer	被多少個負載平衡器引用。	5
Origins	array<object>	源位址集區裡添加的來源站點資訊。
	array<object>	源位址集區裡添加的來源站點資訊。
Id	integer	來源站點 ID。	997502094872132
Name	string	來源站點名稱。	origin1
Address	string	來源站點地址，如：www.example.com。	www.example.com
Enabled	boolean	來源站點是否啟用： true: 啟用； false：不啟用。	true
Weight	integer	權重，0-100 的整數。	50
Type	string	來源站點類型： ip_domain: ip 或網域名稱類型來源站點； OSS：OSS 地址來源站點； S3：AWS S3 來源站點。	S3
Header	any	回源時帶的要求標頭，只支援 Host。	{ "Host": [ "example.com" ] }
AuthConf	object	鑒權資訊，來源站點為 OSS 或者 S3 等來源站點需要鑒權時，需要傳鑒權相關配置資訊。
AuthType	string	鑒權類型。 public：公用讀寫，來源站點為 OSS 或 S3 且為公用讀寫時使用； private_same_account：私人同帳號，來源站點為 OSS，且鑒權類型為同帳號私人鑒權時使用； private_cross_account：私人跨帳號，來源站點為 OSS，且鑒權類型為跨帳號私人鑒權時使用； private：來源站點為 S3，且鑒權類型為私人時使用。	public
AccessKey	string	私人鑒權時需要傳的 AccessKey。	yourAccessKeyID
SecretKey	string	私人鑒權時需要傳的 SecretKey。	yourAccessKeySecret
Version	string	來源站點為 AWS S3 時需要傳的簽名版本。	v2
Region	string	來源站點為 AWS S3 時需要傳的來源站點 Region。	us-east-1
IpVersionPolicy	string
PageNumber	integer	當前頁碼。	1
PageSize	integer	頁大小。	20
TotalCount	integer	總個數。	16
TotalPage	integer	總頁數。	10

樣本

正常返回樣本

JSON格式

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "OriginPools": [
    {
      "Id": 1038520525196928,
      "Name": "pool1",
      "SiteId": 216558609793952,
      "RecordName": "pool1.example.com\n",
      "Enabled": false,
      "References": {
        "LoadBalancers": [
          {
            "Name": "lb1.example.com\n",
            "Id": 998740660522624
          }
        ],
        "DnsRecords": [
          {
            "Name": "www.example.com\n",
            "Id": 1042852886352704
          }
        ],
        "IPARecords": [
          {
            "Name": "ipa.example.com\n",
            "Id": 1042852886352704
          }
        ]
      },
      "ReferenceLBCount": 5,
      "Origins": [
        {
          "Id": 997502094872132,
          "Name": "origin1",
          "Address": "www.example.com",
          "Enabled": true,
          "Weight": 50,
          "Type": "S3",
          "Header": "{\n        \"Host\": [\n          \"example.com\"\n        ]\n      }",
          "AuthConf": {
            "AuthType": "public",
            "AccessKey": "yourAccessKeyID",
            "SecretKey": "yourAccessKeySecret",
            "Version": "v2",
            "Region": "us-east-1\n"
          },
          "IpVersionPolicy": ""
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 16,
  "TotalPage": 10
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InternalException	Failed to call the service. Try again later or contact technical support.	調用服務失敗，請稍後重試或聯絡客服諮詢詳情。
400	InvalidParameter.Coverage	The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.	您選擇的加速地區不在當前套餐支援範圍內，請更換為套餐支援的加速地區後重試。
404	SiteNotFound	The website does not exist or does not belong to you.	網站不存在，或者不屬於你。

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

變更歷史

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