Configures multiple domain names to be accelerated by IP Application Accelerator (IPA).

Note The maximum number of times that users can call this operation per second is 20.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameter

Parameter Type Required Example Description
Action String Yes BatchSetDcdnIpaDomainConfigs

The operation that you want to perform. Set the value to BatchSetDcdnIpaDomainConfigs.

DomainNames String Yes example.com

The domain names accelerated by IPA. Separate multiple domain names with commas (,).

Functions String Yes [{"functionArgs":[{"argName":"domain_name","argValue":"api.example.com"}],"functionName":"protogw"}]
The list of features.
[{"functionArgs":[{"argName":"Parameter name","argValue":"Parameter value"}],"functionName":"Feature name"}]
Description

Name

Parameter

protogw: IPA

realip: configures IP passthrough for passing client IP addresses to origin servers. This parameter is required. Valid values: off: disables IP passthrough. toa: carries the real IP address of the client. The origin server must have the TCP Option Address (TOA) kernel module installed. You do not need to adjust your services. pp: carries the real IP address of the client. This method is supported by the open source version of NGINX. Make sure that other pieces of software of the origin server also support this method.

port: specifies the service port. This parameter is required.

Response parameters

Parameter Type Sample response Description
RequestId String 0AEDAF20-4DDF-4165-8750-47FF9C1929C9

The ID of the request.

Examples

Sample requests

http(s)://dcdn.aliyuncs.com/?Action=BatchSetDcdnIpaDomainConfigs
&DomainNames=example.com
&Functions=[{"functionArgs":[{"argName":"domain_name","argValue":"api..com"}],"functionName":"protogw"}]
&<Common request parameters>

Sample success responses

XML format

<BatchSetDcdnIpaDomainConfigsResponse>
      <RequestId>0AEDAF20-4DDF-4165-8750-47FF9C1929C9</RequestId>
</BatchSetDcdnIpaDomainConfigsResponse>

JSON format

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

Errors codes

HttpCode Error code Error message Description
400 InvalidFunctions.Malformed The specified Functions is invalid. The error message returned because the specified configuration is not supported.
400 InvalidArgValue.Malformed The specified ArgValue is invalid. The error message returned because the specified value of the ArgValue parameter is invalid. Specify a valid value.
400 Invalid%s.ValueNotSupported [%s] is not supported. The error message returned because the specified value is not supported.
400 Invalid%s.Malformed The specified ArgValue [%s] is invalid. The error message returned because the specified value of the argValue parameter is invalid. Specify a valid value.
403 DcdnIpaServiceNotFound The DCDN IPA service has not been activated. The error message returned because the DCDN IPA service is not activated.

For a list of error codes, visit the API Error Center.