Call UpdateOriginPool API to Configure Load Balancing - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Modifies a single origin address pool specified by the origin address pool 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:UpdateOriginPool

update

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The origin address pool ID. You can call the ListOriginPools operation to obtain the ID.	1038520525196928
Enabled	boolean	No	Specifies whether the origin address pool is enabled. Valid values: true: Enabled. false: Not enabled.	true
Origins	array<object>	No	The origin server information added to the origin address pool. Use an array to pass multiple origin servers.
	array<object>	No	The origin server information added to the origin address pool.
Name	string	No	The origin server name. The name must be unique within an origin address pool.	origin1
Address	string	No	The addresses of the origin server, such as www.example.com.	www.example.com
Enabled	boolean	No	Specifies whether the origin server is enabled. Valid values: true: Enabled. false: Not enabled.	true
Header	any	No	The request header included in back-to-origin requests. Only Host is supported.	{ "Host": [ "example.com" ] }
Weight	integer	No	The weight. The value is an integer from 0 to 100.	50
Type	string	No	The origin server type. Valid values: ip_domain: an IP address or domain name-based origin server. OSS: an OSS address-based origin server. S3: an AWS S3 origin server.	OSS
AuthConf	object	No	The authentication information. This parameter is required when the origin server is OSS, S3, or another origin server that requires authentication.
AuthType	string	No	The authentication type. Valid values: public: public read/write. Use this value when the origin server is OSS or S3 with public read/write access. private_same_account: private same-account. Use this value when the origin server is OSS with same-account private authentication. private_cross_account: private cross-account. Use this value when the origin server is OSS with cross-account private authentication. private: Use this value when the origin server is S3 with private authentication.	public
AccessKey	string	No	The AccessKey required for private authentication.	yourAccessKeyID
SecretKey	string	No	The SecretKey required for private authentication.	yourAccessKeySecret
Version	string	No	The signature version required when the origin server is AWS S3.	v2
Region	string	No	The region of the origin server required when the origin server is AWS S3.	us-east-1
IpVersionPolicy	string	No	The IP protocol version used for back-to-origin requests. Valid values: round_robin: default policy. Randomly polls IPv4 or IPv6 origin servers. ipv4_first: preferentially uses IPv4 origin servers. ipv6_first: preferentially uses IPv6 origin servers. follow: preferentially follows the IP version used by the client.	round_robin
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the ID.	216558609793952

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Id	integer	The origin address pool ID.	1038520525196928

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Id": 1038520525196928
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	SourceNumberExceedLimit	The number of sources in the origin pool exceeds the quota limit.	The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.
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.
400	Instance.NotOnline	Your plan is unavailable due to an overdue payment. Complete the payment first.	Your plan is unavailable due to an overdue payment. Complete the payment first.
400	OriginPoolNameConflict	The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.	The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.
400	SourceAddressInvalid	Invalid origin address. Check whether the IP address or domain name is in the valid format.	Invalid origin address. Check whether the IP address or domain name is in the valid format.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
400	InvalidParameter.AddressConflict	Duplicate origin addresses. Make sure that each origin address for the same pool is unique.	Duplicate origin addresses. Make sure that each origin address for the same pool is unique.
400	SourceCircleExist	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.	The host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.
400	SourceInBlackList	The source is in the black list.	The source is in the black list.
400	InvalidParameter.SourceIpInBlacklist	The provided origin is an invalid private IP address. Please verify and resubmit.	The provided origin is an invalid private IP address. Please verify and resubmit.
400	InvalidParameter.PrivateIpAsSourceUnsupported	The provided origin is an invalid private IP address. Please verify and resubmit.	The provided origin is an invalid private IP address. Please verify and resubmit.
400	OriginPool.TypeNotSupport	The origin address pool type is not supported.	The origin address pool type is not supported.
400	OriginPool.CheckQuotaFailed	Failed to check source pool quota for site, please try again later.	Failed to check source pool quota for site, please try again later.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.