Bulk Configure IPA Domains at Scale via BatchSetDcdnIpaDomainConfigs - Edge Security Acceleration

Operation description

Note

The request rate for this operation is limited to 20 requests per second per user.

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

dcdn:BatchSetDcdnIpaDomainConfigs

update

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainNames	string	Yes	The domain names to configure for IPA. Separate multiple domain names with a comma (,). You can specify a maximum of 20 domain names.	example.com
Functions	string	Yes	The functions to configure, specified as a JSON string. Format: `[{"functionArgs":[{"argName":"Configuration Name","argValue":"Configuration Value"}],"functionName":"Function Name"}]`	[{"functionArgs":[{"argName":"domain_name","argValue":"api.*com"}],"functionName":"protogw"}]

Features

Name Parameter

protogw: IP Application Acceleration (IPA) realip (Required): Specifies the method for passing the client's real IP to the origin server. The following methods are supported:
• off: Disables Origin IP Passthrough.
• toa: Passes the client's real IP address to the origin server. The TOA Kernel Module must be installed on the origin server. No application modifications are required.
• pp: Passes the client's real IP address to the origin server. This method is enabled by default in open-source Nginx. Ensure compatibility if you use other server software.
port (Required): The service port.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The unique ID of the request.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFunctions.Malformed	The specified Functions is invalid.	The specified configuration is invalid.
400	InvalidArgValue.Malformed	The specified ArgValue is invalid.	The value specified for the ArgValue parameter is invalid.
400	Invalid%s.ValueNotSupported	[%s] is not supported.	The specified value is not supported.
400	Invalid%s.Malformed	The specified ArgValue [%s] is invalid.	The value specified for the ArgValue parameter is invalid.
403	DcdnIpaServiceNotFound	The DCDN IPA service has not been activated.	IPA is not activated for DCDN.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.