All Products
Search
Document Center

:Common parameters

Last Updated:Apr 24, 2022

This topic describes the request parameters and response parameters that are required by each API of the trusted ledger database.

Common request parameters

Common request parameters

Parameter

Type

Required?

Description

Format

String

No

The format in which to return the response.

Valid values: JSON and XML.

Version

String

Required

The version number of the API. The value is in the YYYY-MM-DD format. Valid values: 2019-11-22

AccessKeyId

String

Required

The AccessKey ID provided to you by Alibaba Cloud

Signature

String

Required

The signature string in the API request.

SignatureMethod

String

Required

The signature method. Valid values: HMAC-SHA1

Timestamp

String

Required

The time at which the quest 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, 2013-01-10T12:00:00Z.

SignatureVersion

String

Required

The version of the signature algorithm. Valid values: 1.0

SignatureNonce

String

Required

A unique, random number used to prevent replay attacks. Users must use different numbers for different requests.

ResourceOwnerAccount

String

No

The account that owns the resource to be accessed by this API request.

Sample requests

http://ledgerdb.aliyuncs.com/?Action=CreateLedger
&TimeStamp=2019-11-22T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-11-22
&SignatureVersion=1.0
&Signature=Signature

Common response parameters

Response data can be returned in either the JSON or XML format. You can specify the response format in the request. The default response format is JSON. Every response has a unique RequestId regardless of whether the call was successful or not.

  • A 2xx HTTP status code indicates a successful call.

  • A 4xx or 5xx HTTP status code indicates a failed call.

Sample responses

  • XM format

    <? xml version="1.0" encoding="utf-8"? > 
        <!-Result root node-->
        <Interface Name+Response>
            <!-Request ID-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!-Return result data-->
        </Interface Name+Response>
  • JSON format

    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*Return result data*/
    }