Retrieve Origin Pool Config with GetOriginPool API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves the details of a specific origin pool by its ID.

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:GetOriginPool

get

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The origin pool ID. To get it, call ListOriginPools.	1038520525196928
SiteId	integer	Yes	The site ID. To get it, call ListSites.	216558609793952

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Id	integer	The origin pool ID.	103852052519****
Name	string	The name of the origin pool. The name must be unique within a site.	pool1
SiteId	integer	The ID of the site that contains the origin pool.	21655860979****
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	Indicates whether the origin pool is enabled. true: The origin pool is enabled. false: The origin pool is disabled.	true
References	object	Resources that reference the origin pool. An origin pool is referenced if a load balancer or record uses it as an origin.
LoadBalancers	array<object>	The 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.	99874066052****
DnsRecords	array<object>	The Layer 7 records that use this origin pool as their origin.
	object	A Layer 7 record that uses this origin pool as its origin.
Name	string	The name of the record.	www.example.com
Id	integer	The ID of the record.	104285288635****
IPARecords	array<object>	The Layer 4 records that use this origin pool as their origin.
	object	A Layer 4 record that uses this origin pool as its origin.
Name	string	The name of the record.	ipa.example.com
Id	integer	The ID of the record.	104285288635****
ReferenceLBCount	integer	The number of load balancers that reference this origin pool.	5
Origins	array<object>	The origins in the origin pool.
	array<object>	An origin in the origin pool.
Id	integer	The origin ID.	99750209487****
Name	string	The origin name.	origin1
Address	string	The origin address, such as www.example.com.	www.example.com
Enabled	boolean	Indicates whether the origin is enabled. true: The origin is enabled. false: The origin is disabled.	true
Weight	integer	The weight of the origin. Must be an integer from 0 to 100.	50
Type	string	The type of the origin. ip_domain: An IP address or a domain name. OSS: An OSS bucket. S3: An AWS S3 bucket.	ip_domain
Header	any	The request header to include in origin requests. Only the Host header is supported.	{ "Host": [ "example.com" ] }
AuthConf	object	The authentication configuration. Required if the origin is an OSS or S3 bucket that requires authentication.
AuthType	string	The authentication type. public: Public access. For OSS or S3 origins with public read access. private_same_account: Private, same account. For private OSS origins in the same account. private_cross_account: Private, cross-account. For private OSS origins in a different account. private: Private. For private S3 origins.	public
AccessKey	string	The AccessKey ID. Required if `AuthType` is set to `private_cross_account` or `private`.	yourAccessKeyID
SecretKey	string	The AccessKey secret. Required if `AuthType` is set to `private_cross_account` or `private`.	yourAccessKeySecret
Version	string	The signature version. Required if the origin is an AWS S3 bucket.	v4
Region	string	The AWS Region of the origin. Required if the origin is an AWS S3 bucket.	us-east-1
IpVersionPolicy	string	The IP version policy for origin requests. round_robin: Default policy. Routes requests to IPv4 and IPv6 origins on a round-robin basis. ipv4_first: Prioritizes IPv4. Routes requests to IPv4 origins first. ipv6_first: Prioritizes IPv6. Routes requests to IPv6 origins first. follow: Matches the client's IP version. The origin request uses the same IP version as the incoming request.	round_robin

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Id": 0,
  "Name": "pool1",
  "SiteId": 0,
  "RecordName": "pool1.example.com",
  "Enabled": true,
  "References": {
    "LoadBalancers": [
      {
        "Name": "lb1.example.com",
        "Id": 0
      }
    ],
    "DnsRecords": [
      {
        "Name": "www.example.com",
        "Id": 0
      }
    ],
    "IPARecords": [
      {
        "Name": "ipa.example.com",
        "Id": 0
      }
    ]
  },
  "ReferenceLBCount": 5,
  "Origins": [
    {
      "Id": 0,
      "Name": "origin1",
      "Address": "www.example.com",
      "Enabled": true,
      "Weight": 50,
      "Type": "ip_domain",
      "Header": "{\n        \"Host\": [\n          \"example.com\"\n        ]\n      }",
      "AuthConf": {
        "AuthType": "public",
        "AccessKey": "yourAccessKeyID",
        "SecretKey": "yourAccessKeySecret",
        "Version": "v4",
        "Region": "us-east-1\n"
      },
      "IpVersionPolicy": "round_robin"
    }
  ]
}

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	OriginPoolNotExist	The specified origin pool does not exist or does not belong to your account or website. Check and try again.	The specified origin pool does not exist or does not belong to your account or website. Check 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.