翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetRevision
指定されたドキュメント ID とブロックアドレスのリビジョンデータオブジェクトを返します。また、DigestTipAddress
が指定されている場合は、指定されたリビジョンの証明を検証のために返します。
リクエストの構文
POST /ledgers/name
/revision HTTP/1.1
Content-type: application/json
{
"BlockAddress": {
"IonText": "string
"
},
"DigestTipAddress": {
"IonText": "string
"
},
"DocumentId": "string
"
}
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- name
-
台帳の名前。
長さの制限:最小長は 1 です。最大長は 32 です。
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
必須: はい
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- BlockAddress
-
検証するドキュメントリビジョンのブロックの場所。アドレスは、
strandId
とsequenceNo
という 2 つのフィールドを含む Amazon Ion 構造です。例:
{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
。型: ValueHolder オブジェクト
必須: はい
- DigestTipAddress
-
証明をリクエストするダイジェストの対象となっている最新のブロックの場所。アドレスは、
strandId
とsequenceNo
という 2 つのフィールドを含む Amazon Ion 構造です。例:
{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}
。タイプ:ValueHolder オブジェクト
必須: いいえ
- DocumentId
-
検証するドキュメントの UUID (Base62 でエンコードされたテキストで表されます)。
型: 文字列
長さの制限: 22 の固定長
Pattern:
^[A-Za-z-0-9]+$
必須:はい
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"Proof": {
"IonText": "string"
},
"Revision": {
"IonText": "string"
}
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Proof
-
GetRevision
リクエストによって返される、Amazon Ion 形式の証明オブジェクト。証明には、指定されたドキュメントリビジョンから始まるマークルツリーを使用して指定されたダイジェストを再計算するために必要なハッシュ値のリストが含まれます。タイプ:ValueHolder オブジェクト
- Revision
-
Amazon Ion 形式のドキュメントリビジョンのデータオブジェクト。
型: ValueHolder オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterException
-
リクエスト内の 1 つ以上のパラメータが有効ではありません。
HTTP ステータスコード:400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード: 404
- ResourcePreconditionNotMetException
-
事前に条件が満たされていなかったため、オペレーションが失敗しました。
HTTP ステータスコード: 412
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。