ListOriginPools - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

List Origin Pools

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
esa:ListOriginPools	list	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Page number, default value is 1.	1
PageSize	integer	No	Page size, an integer greater than 0, with a maximum of 500. If the value exceeds 500, it will be set to 500.	20
Name	string	No	Name of the origin pool.	pool1
MatchType	string	No	Type of name match query, supporting the following two types, with exact match as the default. fuzzy: Fuzzy query. exact: Exact query.	exact
OrderBy	string	No	Sorting, supports ascending and descending order by ID, default is descending by ID, which is positively correlated with creation time. -id: Sort by ID in descending order. id: Sort by ID in ascending order.	id
SiteId	long	Yes	Site ID, which can be obtained by calling the ListSites API.	151538882642832

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	15C66C7B-671A-4297-9187-2C4477247A74
OriginPools	array<object>	List of origin pools.
OriginPool	object	Information about the origin pool.
Id	long	ID of the origin pool.	1038520525196928
Name	string	Name of the origin pool, unique within a site.	pool1
SiteId	long	ID of the site to which the origin pool belongs.	216558609793952
RecordName	string	Domain name assigned to the origin pool, which can be used as the origin address for records under the site.	pool1.example.com
Enabled	boolean	Whether the origin pool is enabled: true: Enabled; false: Disabled.	false
References	object	Reference information for the origin pool. The origin pool is considered referenced when it is configured in a load balancer or set as the origin for a record.
LoadBalancers	array<object>	List of load balancers using this origin pool.
LoadBalancer	object	Information about the load balancers using this origin pool.
Name	string	Name of the load balancer.	lb1.example.com
Id	long	ID of the load balancer.	998740660522624
DnsRecords	array<object>
DnsRecord	object	Information about the layer 7 records that use this origin pool as the origin.
Name	string	Record name.	www.example.com
Id	long	Record ID.	1042852886352704
IPARecords	array<object>	List of layer 4 records that use this origin pool as the origin.
IPARecord	object	Information about the layer 4 records that use this origin pool as the origin.
Name	string	Record name.	ipa.example.com
Id	long	Record ID.	1042852886352704
ReferenceLBCount	integer	Number of load balancers that reference this origin pool.	5
Origins	array<object>	Information about the origins added to the origin pool.
Origin	object	Information about the origins added to the origin pool.
Id	long	Origin ID.	997502094872132
Name	string	Origin name.	origin1
Address	string	Origin address, e.g., www.example.com.	www.example.com
Enabled	boolean	Whether the origin is enabled: true: Enabled; false: Disabled.	true
Weight	integer	Weight, an integer between 0 and 100.	50
Type	string	Origin type: ip_domain: IP or domain type origin; OSS: OSS address origin; S3: AWS S3 origin.	S3
Header	any	The request header to be carried during back-to-origin, only supports Host.	{ "Host": [ "example.com" ] }
AuthConf	object	Authentication information. When the origin is OSS or S3 and requires authentication, you need to provide related configuration information for authentication.
AuthType	string	Authentication type. public: Public read/write, used when the origin is OSS or S3 and it is set to public read/write; private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account; private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts; private: Used when the origin is S3 and the authentication type is private.	public
AccessKey	string	The AccessKey required for private authentication.	yourAccessKeyID
SecretKey	string	The SecretKey required for private authentication.	yourAccessKeySecret
Version	string	The signature version required when the origin is AWS S3.	v2
Region	string	The Region of the origin required when the origin is AWS S3.	us-east-1
PageNumber	integer	Current page number.	1
PageSize	integer	Page size.	20
TotalCount	integer	Total count.	16
TotalPage	integer	Total number of pages.	10

Examples

Sample success responses

JSONformat

{
  "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"
          }
        }
      ]
    }
  ],
  "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.

For a list of error codes, visit the Service error codes.