移動

• リクエスト
• レスポンス
• 例

1つのTCCトランザクションの詳細の取得

get

/admin/v1/tcc-transaction/{id}

指定されたTCCトランザクションIDの詳細を取得します。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): string
  トランザクションの追跡に使用できる一意のID。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: tcc-transaction

型: object

ソースを表示

• hostname(必須): string
  TCCトランザクションが開始されたMicroTxコーディネータ・インスタンスのID。
• id(必須): string
  TCCトランザクションの一意のトランザクションID。
• participants: array participants
• startTime(必須): string
  TCCトランザクションが開始された時刻。
• status(必須): string
  指定できる値: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]
• userId(必須): string
  TCCトランザクションを開始したユーザーのID。

{
    "type":"object",
    "required":[
        "id",
        "userId",
        "hostname",
        "status",
        "startTime"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique transaction ID of the TCC transaction."
        },
        "userId":{
            "type":"string",
            "description":"ID of the user who initiated the TCC transaction."
        },
        "hostname":{
            "type":"string",
            "description":"ID of the MicroTx coordinator instance where the TCC transaction began."
        },
        "status":{
            "$ref":"#/definitions/tcc-status"
        },
        "startTime":{
            "type":"string",
            "description":"The time at which the TCC transaction began."
        },
        "participants":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "id",
                    "uri",
                    "status"
                ],
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"Unique transaction ID of the TCC transaction."
                    },
                    "uri":{
                        "type":"string",
                        "description":"TCC transaction participant call back url"
                    },
                    "timeLimit":{
                        "type":"string",
                        "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
                    },
                    "status":{
                        "$ref":"#/definitions/tcc-participant-status"
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: participants

型: array

ソースを表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "id",
            "uri",
            "status"
        ],
        "properties":{
            "id":{
                "type":"string",
                "description":"Unique transaction ID of the TCC transaction."
            },
            "uri":{
                "type":"string",
                "description":"TCC transaction participant call back url"
            },
            "timeLimit":{
                "type":"string",
                "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
            },
            "status":{
                "$ref":"#/definitions/tcc-participant-status"
            }
        }
    }
}

ネストされたスキーマ: items

型: object

ソースを表示

• id(必須): string
  TCCトランザクションの一意のトランザクションID。
• status(必須): string
  指定できる値: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]
• timeLimit: string
  トランザクション・イニシエータ・サービスがリソースを予約する期間。期限切れになった後でリソースを解放してTCCトランザクションのその部分を取り消すために必要なコードを用意するのは、アプリケーション開発者の責任です。
• uri(必須): string
  TCCトランザクション参加側コールバックURL

{
    "type":"object",
    "required":[
        "id",
        "uri",
        "status"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique transaction ID of the TCC transaction."
        },
        "uri":{
            "type":"string",
            "description":"TCC transaction participant call back url"
        },
        "timeLimit":{
            "type":"string",
            "description":"The time period for which the transaction initiator service to reserve the resources. It is the responsibility of the application developer to provide the required code to release the resources and cancel the their part of the TCC transaction after the time limit expires."
        },
        "status":{
            "$ref":"#/definitions/tcc-participant-status"
        }
    }
}

400レスポンス

Invalid Arguments

401レスポンス

Unauthorized

先頭に戻る

例

cURLコマンド

次の例では、cURLを使用してRESTリソースにGETリクエストを送信することによって、1つのTCCトランザクションの詳細を表示する方法を示しています。cURLの詳細は、「cURLの使用」を参照してください

コマンドは1行で入力してください。この例では、読みやすくするために改行を使用しています。

curl -X GET 
     -H "Authorization:Bearer $OTMM_COOKIE"
     https://192.0.2.1:8080/admin/v1/tcc-transaction/3885402b-1aa0-439a-af2c-63a3ea581ed5

• OTMM_COOKIEは、前に認証cookieを格納した変数の名前です。認証cookieの取得および変数への格納の詳細は、認証を参照してください。

• 192.0.2.1:8080は、RESTエンドポイントURLの例です。この値をRESTエンドポイントURLに変更して、ご使用の環境のIstioイングレス・ゲートウェイにアクセスします。ご使用のサイトのRESTエンドポイントURLを確認する方法の詳細は、リクエストの送信を参照してください。

• 3885402b-1aa0-439a-af2c-63a3ea581ed5は、TCCトランザクションIDの値の例です。この値は、ご使用の環境のTCCトランザクションのトランザクションIDで置き換えてください。

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。値の例は、読みやすくするために...を使用して一部を省いています。ご使用の環境でレスポンスを確認すると、値全体が表示されます。

{
  "encryptedEntry": "uu...",
  "end": 0,
  "hostname": "otmm-tcs-0",
  "id": "3885402b-1aa0-439a-af2c-63a3ea581ed5",
  "keyVersion": "1",
  "nonce": "oQKXXe2nfnWFeeo9",
  "participants": null,
  "status": "Active",
  "thumbprint": "Bearer eyJhbGci...",
  "timeLimit": 0,
  "userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
}

先頭に戻る