All Products
Search

This Product

    Blockchain as a Service:Common parameters

    Document Center

    Blockchain as a Service:Common parameters

    Last Updated:Jul 20, 2023

    This topic describes the request parameters and response parameters that each operation uses.

    Common request parameters

    Table 1. Common request parameters

    Parameter

    Type

    Required

    Description

    Format

    String

    No

    The format of the response. Valid value:

    JSON (default) | XML

    Version

    String

    Yes

    The version number of the API, in the format of YYYY-MM-DD. Valid values:

    2018-12-21

    AccessKeyId

    String

    Yes

    The AccessKey ID of your Alibaba Cloud account that is used to access SSL Certificates Service.

    Signature

    String

    Yes

    The signature string of the current request.

    SignatureMethod

    String

    Yes

    The algorithm used to create the request signature. Valid value:

    HMAC-SHA1.

    Timestamp

    String

    Yes

    The timestamp when the request is signed. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

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

    SignatureVersion

    String

    Yes

    The signature version to use. Valid value:

    1.0.

    SignatureNonce

    String

    Yes

    A unique and randomly generated number used to prevent replay attacks.

    Users must use different numbers for different requests.

    ResourceOwnerAccount

    String

    No

    The name of the account that owns the resource to be accessed through this API request, that is, the name of the logged user.

    Examples 

    http://baas.aliyuncs.com/?Action=DescribeFabricOrganization
&TimeStamp=2018-12-21T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2018-12-21
&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 is successful or not.

    • An HTTP status code of 2xx indicates a successful call.

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

    Sample responses

    • XML format 

      <? xml version="1.0" encoding="utf-8"? > 
    <!--Response root node-->
    <API operation name+response>
        <!--Request ID-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Responses-->
    </API operation name+response>

    • JSON format 

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