Common request parameters
Common request parameters must be included in all WAF API requests.
Parameter | Type | Required | Description |
---|---|---|---|
Region | String | Yes | The ID of the region to which the WAF instance belongs. Set the value to:
|
InstanceId | String | Yes | The ID of the WAF instance.
Note You can call DescribePayInfo to view your WAF instance ID.
|
Format | String | No | The format in which to return the response. Valid values:
|
Version | String | Yes | The version number of the API, in the format of YYYY-MM-DD. Set the value to:
2018-01-17 |
AccessKeyId | String | Yes | The AccessKey ID provided to you by Alibaba Cloud |
Signature | String | Yes | The signature string in the API request. |
SignatureMethod | String | Yes | The encryption method of the signature string. Set the value to
HMAC-SHA1 |
Timestamp | String | Yes | The UTC time when the request is signed. Specify the time in the ISO 8601 standard
in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
For example, 20:00:00 on January 10, 2013 in China Standard Time (UTC +8) is written as 2013-01-10T12:00:00Z. |
SignatureVersion | String | Yes | The version of the signature encryption algorithm. Set the value to
1.0. |
SignatureNonce | String | Yes | A unique, random number used to prevent replay attacks.
You must use different numbers for multiple requests. |
ResourceOwnerAccount | String | No | The account that owns the resource to be accessed by the current request. |
https://wafopenapi.cn-hangzhou.aliyuncs.com/?Action=DescribeDomainNames
&Region=cn
&InstanceId=waf_elasticity-cn-0xldbqtm005
&Timestamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-01-17
&SignatureVersion=1.0
&Signature=Signature
Common response parameters
API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. Response data can be returned in either the JSON or XML format. You can specify the response format when you are making the request. The default response format is XML.
Every response returns a unique RequestId (request ID) regardless of whether the call is successful.- XML format
<?xml xml version="1.0" encoding="utf-8"? > <!--Result Root Node--> <Operation Name+Response> <!-Return Request Tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!-Return Result Data--> </Operation Name+Response>
- JSON format
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*Return Result Data*/ }