ここでは、SSL 証明書サービスによって提供される API 操作の共通パラメーターについて説明します。

共通リクエストパラメーター

共通リクエストパラメーターは、各 API 操作の実行時に使用するリクエストパラメーターです。

表 1. 共通リクエストパラメーター
パラメーター タイプ 必須/任意 説明
Format String 任意 レスポンスの形式。

有効値:JSON、XML (デフォルト)

Version String 必須 API バージョン番号を日付形式 YYYY-MM-DD で示します。

有効値:2018-08-13

AccessKeyId String 必須 SSL 証明書サービスへのアクセスに使用される Alibaba Cloud アカウントの AccessKey ID 。
Signature String 必須 現在のリクエストの署名文字列。
SignatureMethod String 必須 署名アルゴリズム。

有効値:HMAC-SHA1

Timestamp String 必須 リクエストに署名するタイムスタンプ。 時刻を ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ) の形式で指定します。 時間は UTC である必要があります。

例:2013-01-10T12:00:00Z indicates January 10, 2013, 20:00:00 (UTC+8).

SignatureVersion String 必須 署名アルゴリズムのバージョンです。 現在のバージョンは 1.0 です。
SignatureNonce String 必須 固有の乱数。反射攻撃を防ぎます。

各リクエストにおいて異なる乱数を使用する必要があります。

ResourceOwnerAccount String 任意 この API リクエストを介してアクセスされるリソースを所有するアカウントの名前。
https://cas.aliyuncs.com/
? Format=xml
&Version=2018-08-13
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z

共通レスポンスパラメーター

API レスポンスは HTTP レスポンス形式を使用します。ステータスコードが 2XX の場合は呼び出しの成功を示し、ステータスコードが 4XX または 5XX の場合は呼び出しの失敗を示します。

レスポンスデータは JSON 形式または XML 形式のいずれかで返されます。 リクエスト送信時にレスポンスの形式を指定できます。 デフォルトのレスポンス形式は XML です。

呼び出しの成否に関わらず、すべてのレスポンスには一意の RequestId があります。
  • XML形式
    <? 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 形式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*Responses*/
        }