Common parameters

更新时间:
复制 MD 格式

This topic describes the request and response parameters that are common to all API calls.

Common request parameters

Table 1. Common request parameters
NameTypeRequiredDescription
FormatStringNoThe format of the response message. Valid value:

JSON (default)

VersionStringYesThe API version number. Use the YYYY-MM-DD date format. Valid value:

2020-05-09

AccessKeyIdStringYesThe AccessKey ID used to access the service.
SignatureStringYesThe signature string.
SignatureMethodStringYesThe signature method. Valid value:

HMAC-SHA1

TimestampStringYesThe timestamp of the request. The timestamp must be in UTC and in the ISO 8601 standard format: YYYY-MM-DDThh:mm:ssZ.

For example, January 10, 2013, 20:00:00 UTC+8 is expressed as 2013-01-10T12:00:00Z.

SignatureVersionStringYesThe signature algorithm version. Valid value:

1.0

SignatureNonceStringYesA unique random number used to prevent network replay attacks.

Use a different random value for each request.

ResourceOwnerAccountStringNoThe logon username of the resource owner.
The following is an example:
http://baasdis.cn-hangzhou.aliyuncs.com/?Action=CreatePersonalDID
&TimeStamp=2020-06-23T11%3A19%3A12Z
&Format=JSON
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2020-05-09
&SignatureVersion=1.0
&Signature=Signature

Common response parameters

API responses use a standard format. For successful calls, response data is returned only in JSON format. Each API call, whether successful or not, returns a unique RequestId.
  • A 2xx HTTP status code indicates a successful call.
  • A 4xx or 5xx HTTP status code indicates a failed call.
The following is an example of the common response parameters:
  • JSON format
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*Response data*/
     }