Query & Filter Origin Pools via ListOriginPools API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries all origin pools under a site with pagination. You can search by pool name using exact or fuzzy matching.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:ListOriginPools

list

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default: 1.	1
PageSize	integer	No	The number of entries per page. Must be a positive integer. Maximum value: 500. Values greater than 500 are automatically set to 500.	20
Name	string	No	The name of the origin pool.	pool1
MatchType	string	No	The query type for the origin pool name. Default: exact. Valid values: `fuzzy`: Fuzzy match. `exact`: Exact match.	exact
OrderBy	string	No	The sort order based on origin pool ID. IDs are positively correlated with creation time. `id`: Descending order (default). `id_asc`: Ascending order.	id
SiteId	integer	Yes	The site ID. You can call the `ListSites` operation to obtain this ID.	151538882642832

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	A list of origin pools.
	array<object>	Details of an origin pool.
Id	integer	The ID of the origin pool.	1038520525196928
Name	string	The origin pool name. Must be unique within a site.	pool1
SiteId	integer	The ID of the site to which the origin pool belongs.	216558609793952
RecordName	string	The domain name assigned to the origin pool, used as the origin address for records within the site.	pool1.example.com
Enabled	boolean	Specifies whether the origin pool is enabled. `true`: Enabled. `false`: Disabled.	false
References	object	Resources that reference this origin pool. A pool is referenced when a load balancer or record uses it as an origin.
LoadBalancers	array<object>	Load balancers that use this origin pool.
	object	A load balancer that uses this origin pool.
Name	string	The name of the load balancer.	lb1.example.com
Id	integer	The ID of the load balancer.	998740660522624
DnsRecords	array<object>	Layer 7 records that use this origin pool as an origin.
	object	A Layer 7 record that uses this origin pool as an origin.
Name	string	The name of the record.	www.example.com
Id	integer	The ID of the record.	1042852886352704
IPARecords	array<object>	Layer 4 records that use this origin pool as an origin.
	object	A Layer 4 record that uses this origin pool as an origin.
Name	string	The name of the record.	ipa.example.com
Id	integer	The ID of the record.	1042852886352704
ReferenceLBCount	integer	The number of load balancers referencing this origin pool.	5
Origins	array<object>	The origins in the pool.
	array<object>	Details of an origin in the pool.
Id	integer	The ID of the origin.	997502094872132
Name	string	The name of the origin.	origin1
Address	string	The address of the origin, such as `www.example.com`.	www.example.com
Enabled	boolean	Specifies whether the origin is enabled. `true`: Enabled. `false`: Disabled.	true
Weight	integer	The weight of the origin. Valid values: 0 to 100.	50
Type	string	The origin type. Valid values: `ip_domain`: IP address or domain name. `OSS`: OSS bucket. `S3`: AWS S3 bucket.	S3
Header	any	The request header sent with origin requests. Only the `Host` header is supported.	{ "Host": [ "example.com" ] }
AuthConf	object	Authentication configuration for the origin. Required if the origin (such as an OSS or AWS S3 bucket) requires authentication.
AuthType	string	The authentication type. Valid values: `public`: Publicly accessible OSS or AWS S3 bucket. `private_same_account`: Private authentication to an OSS origin within the same account. `private_cross_account`: Private, cross-account authentication to an OSS origin. `private`: Private authentication to an AWS S3 origin.	public
AccessKey	string	The AccessKey for private authentication.	yourAccessKeyID
SecretKey	string	The SecretKey for private authentication.	yourAccessKeySecret
Version	string	The signature version for AWS S3 bucket origins.	v2
Region	string	The origin region. Required for AWS S3 bucket origins.	us-east-1
IpVersionPolicy	string	The IP version policy for origin requests. Valid values: `round_robin`: Alternates between IPv4 and IPv6 (default). `ipv4_first`: Prefers IPv4. `ipv6_first`: Prefers IPv6. `follow`: Matches the client request IP version.	round_robin
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of origin pools.	16
TotalPage	integer	The total number of pages.	10

Examples

Success response

JSON format

{
  "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": "round_robin"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 16,
  "TotalPage": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	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.	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.	The website does not exist or does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.