Configures multiple domain names to be accelerated by IP Application Accelerator (IPA).
Operation description
Note
You can call this operation up to 20 times per second per account.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainNames | string | Yes | The domain names accelerated by IPA. Separate multiple domain names with commas (,). | example.com |
Functions | string | Yes | The list of features. | [{"functionArgs":[{"argName":"domain_name","argValue":"api.*com"}],"functionName":"protogw"}] |
Description
Feature | Parameters |
---|---|
protogw: configures IP Application Accelerator (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 needs to 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
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.