ListOriginPools - 查询源地址池列表_边缘安全加速(ESA)-阿里云帮助中心

查询站点下所有源地址池，支持分页，可以按源地址名称精确查询、模糊查询。

调试

您可以在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	long	是	站点 ID，可通过调用 ListSites 接口获取。	151538882642832

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	源地址池列表。
OriginPool	object	源地址池信息。
Id	long	源地址池 ID。	1038520525196928
Name	string	源地址池名称，一个站点下源地址池名称唯一。	pool1
SiteId	long	源地址池所属的站点 ID。	216558609793952
RecordName	string	为源地址池分配的域名，可以用来作站点下记录的源站地址。	pool1.example.com
Enabled	boolean	源地址池是否启用： true: 启用； false：不启用。	false
References	object	源地址池被引用信息，源地址池被负载均衡器配置或者被记录配置为源站时，被认为是引用。
LoadBalancers	array<object>	使用此源地址池的负载均衡器列表。
LoadBalancer	object	使用此源地址池的负载均衡器信息。
Name	string	负载均衡器名字。	lb1.example.com
Id	long	负载均衡器 ID。	998740660522624
DnsRecords	array<object>	使用此源地址池为源站的七层记录列表。
DnsRecord	object	使用此源地址池为源站的七层记录信息。
Name	string	记录名称。	www.example.com
Id	long	记录 ID。	1042852886352704
IPARecords	array<object>	使用此源地址池为源站的四层记录列表。
IPARecord	object	使用此源地址池为源站的四层记录信息。
Name	string	记录名称。	ipa.example.com
Id	long	记录 ID。	1042852886352704
ReferenceLBCount	integer	被多少个负载均衡器引用。	5
Origins	array<object>	源地址池里添加的源站信息。
Origin	object	源地址池里添加的源站信息。
Id	long	源站 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
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": {
            "Host": [
              "example.com"
            ]
          },
          "AuthConf": {
            "AuthType": "public",
            "AccessKey": "yourAccessKeyID",
            "SecretKey": "yourAccessKeySecret",
            "Version": "v2",
            "Region": "us-east-1\n"
          }
        }
      ]
    }
  ],
  "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.	站点不存在，或者不属于你。

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