This topic describes the common parameters, including the common request parameters and common response parameters.

Common request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. For more information about valid values, see List of operations by function.
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud. The AccessKey pair is used to call API operation for authentication, similar to how the user password is used to log on to the Operation Orchestration Service (OOS) console.
Signature String Yes The signature string of the current request. For more information about how signatures are calculated, see Signature method.
SignatureMethod String Yes The encryption method of the signature string. Set the value to HMAC-SHA1.
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 different requests.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2019-06-01T12:00:00Z.
Version String Yes The version number of the API. The value must be in the YYYY-MM-DD format. Set the value to 2019-06-01.
Format String Yes The format in which to return the response. Set the value to JSON.

Sample requests

https://oos.cn-hangzhou.aliyuncs.com/?Action=XXXXXX
&Format=json
&Version=2019-06-01
&Signature=cWgxtKc9dQWgSMB7OEhtOkq%2B9AM%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=479a2bf5-8045-11e9-8d42-6c96cfdd1fa1
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2019-05-27T06%3A04%3A25Z
...

Common response parameters

Parameter Type Description
RequestId String The ID of the request. The system returns a unique ID for each API request, regardless of whether the API operation is successful.