Common request parameters are request parameters used by each API.

Common request parameters

Name Type Required Description
Region String Yes The region where the Anti-DDoS Pro instance is located. Example value: cn-hangzhou.
InstanceId String Yes The ID of the Anti-DDoS Pro instance.
Format String No The format of the response. Value:
  • JSON (default)
  • XML
Version String Yes The version of the API in the format of YYYY-MM-DD. Example value: 2017-07-25.
AccessKeyId String Yes The AccessKey ID of the user who calls the API.
Signature String Yes The request signature.
SignatureMethod String Yes The algorithm used to create the request signature. Value: HMAC-SHA1.
Timestamp String Yes The time at which the quest is signed in the YYYY-MM-DDThh:mm:ssZ format.

For example, 2013-01-10T12:00:00Z.

SignatureVersion String Yes The signature version. Value: 1.
SignatureNonce String Yes A random number for the signature to prevent from network attacks. Each request must use a different random number.
ResourceOwnerAccount String No The account of the owner of the requested resource. Use the logon account name.

Common response parameters

The API response uses a unified format. If a 2XX HTTP status code is returned, the call is successful; if a 4xx or 5xx HTTP status code is returned, the call has failed. When a call succeeds, the formats of the returned data include XML and JSON. You can specify the format of the returned data when sending the request. The default format is XML.

A RequestId is returned regardless of whether the request is successful or not.
  • XML format
    <? xml version="1.0" encoding="utf-8"? > 
        <!—The root node of the result-->
            <!—The returned result-->
            <!—The returned result-->
  • JSON format
        /*The returned result*/