BatchSetDcdnIpaDomainConfigs - Edge Security Acceleration

Operation description

Note

The call frequency for a single user is limited to 20 calls per second.

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 accelerated by DCDN for IPA. Separate multiple domain names with a comma (,).	example.com
Functions	string	Yes	A list of features. `[{"functionArgs":[{"argName":"configuration name","argValue":"configuration value"}],"functionName":"feature name"}]`	[{"functionArgs":[{"argName":"domain_name","argValue":"api.*com"}],"functionName":"protogw"}]

Feature description

Name

Parameters

protogw: IP Application Acceleration

`realip` (Required): The method used to pass the client's real IP address to the origin server. The following three methods are supported.`off`: Disables this feature.`toa`: Passes the client's real IP address to the origin server. The origin server must have the TCP Option Address (TOA) kernel module installed. The application requires no changes.`pp`: Passes the client's real IP address to the origin server. This method is supported by open-source Nginx by default. Other origin server software must be compatible.
`port` (Required): The service port.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	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.