All Products
Search
Document Center

Edge Security Acceleration:GetOriginPool

Last Updated:Nov 07, 2025
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.

Query a specific origin pool

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:GetOriginPoolget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdlongYes

The ID of the origin pool, which can be obtained by calling the ListOriginPools interface.

1038520525196928
SiteIdlongYes

The ID of the site, which can be obtained by calling the ListSites interface.

216558609793952

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Idlong

Origin pool ID.

103852052519****
Namestring

Name of the origin pool. The name is unique under a single site.

pool1
SiteIdlong

ID of the site to which the origin pool belongs.

21655860979****
RecordNamestring

The domain name assigned to the origin pool, which can be used as the origin address for records under the site.

pool1.example.com
Enabledboolean

Whether the origin pool is enabled:

  • true: Enabled;
  • false: Disabled.
true
Referencesobject

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.

LoadBalancersarray<object>

List of load balancers using this origin pool.

LoadBalancerobject

Information about the load balancers using this origin pool.

Namestring

Name of the load balancer.

lb1.example.com
Idlong

ID of the load balancer.

99874066052****
DnsRecordsarray<object>

List of layer 7 records using this origin pool as the origin.

DnsRecordobject

Information about the layer 7 records using this origin pool as the origin.

Namestring

Record name.

www.example.com
Idlong

Record ID.

104285288635****
IPARecordsarray<object>

List of layer 4 records using this origin pool as the origin.

IPARecordobject

Information about the layer 4 records using this origin pool as the origin.

Namestring

Record name.

ipa.example.com
Idlong

记录 ID。

104285288635****
ReferenceLBCountinteger

The number of load balancers that reference this origin pool.

5
Originsarray<object>

Information about the origins added to the origin pool.

Originobject

Information about the origins added to the origin pool.

Idlong

The ID of the origin.

99750209487****
Namestring

The name of the origin.

origin1
Addressstring

The address of the origin, e.g., www.example.com.

www.example.com
Enabledboolean

Whether the origin is enabled:

  • true: Enabled;
  • false: Disabled.
true
Weightinteger

The weight, an integer between 0 and 100.

50
Typestring

The type of the origin:

  • ip_domain: IP or domain type origin;
  • OSS: OSS address origin;
  • S3: AWS S3 origin.
ip_domain
Headerany

The request header to be included when fetching from the origin, only supports Host.

{ "Host": [ "example.com" ] }
AuthConfobject

Authentication information. When the origin is an OSS or S3, and authentication is required, you need to provide the relevant configuration information.

AuthTypestring

The type of authentication:

  • public: Public read/write, used when the origin is OSS or S3 and is publicly readable/writable;
  • 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
AccessKeystring

The AccessKey required when AuthType is set to private_cross_account or private.

yourAccessKeyID
SecretKeystring

The SecretKey required when AuthType is set to private_cross_account or private.

yourAccessKeySecret
Versionstring

The signature version required when the origin is an AWS S3.

v4
Regionstring

The source Region to be passed when the origin is AWS S3.

us-east-1

Examples

Sample success responses

JSONformat

{
  "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": {
        "Host": [
          "example.com"
        ]
      },
      "AuthConf": {
        "AuthType": "public",
        "AccessKey": "yourAccessKeyID",
        "SecretKey": "yourAccessKeySecret",
        "Version": "v4",
        "Region": "us-east-1\n"
      }
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400OriginPoolNotExistThe 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.
404SiteNotFoundThe 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.

Change history

Change timeSummary of changesOperation
2025-11-07The Error code has changed. The response structure of the API has changedView Change Details