Common request parameters

Common request parameters are request parameters that you must use when you call each API.

Table 1. Common request parameters
Name Type Required Description
Region string Yes The region of the Threat Detection Service (TDS) instance.

Valid values:

  • cn-hangzhou: all regions except for Malaysia (Kuala Lumpur).
  • ap-southeast-3: Malaysia (Kuala Lumpur).
Format string No The format of the response.

Valid values: JSON (default), XML

Version String Yes The API version, in the format of YYYY-MM-DD.

Set the value to 2018-12-03.

AccessKeyId String Yes The AccessKey ID that you use to call an API.
Signature String Yes The request signature.
SignatureMethod String Yes The signature method.

Set the value to HMAC-SHA1.

Timestamp String Yes The UTC time when the request is signed, in the format of YYYY-MM-DDThh:mm:ssZ.

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

SignatureVersion String Yes A unique random number that is used to prevent network replay attacks.

You must use different random numbers for different requests.

ResourceOwnerAccount String No The owner account (the logon username) of the resource to be accessed through this API request.

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.

The response result can be returned in JSON or XML format. You can specify the format when calling an operation. The result is returned in XML format by default.

Each time you send a request to call an API, the system returns a unique identifier RequestId, regardless of whether the request is successful or not.
  • XML format
    <? xml version="1.0" encoding="utf-8"? > 
        <!—The root node of the response-->
        <Operation name+Response>
            <!—The returned request tag-->
            <!—The response data-->
        </Operation name+Response>
  • JSON format
        /*The response data*/