Oracle Transaction Manager for MicroservicesのREST API

すべてのTCCトランザクションの詳細の取得

get

/admin/v1/tcc-transaction

マイクロサービス対応トランザクション・マネージャによって処理され、指定のトランザクション・ステータスと一致するすべてのTCCトランザクションの詳細を取得します。問合せパラメータを指定しないと、現在のすべてのTCCトランザクションの詳細が取得されます。

リクエスト

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

application/json

問合せパラメータ

begin (オプション): integer(int32)

表示をスキップするオフセットすなわちレコード数を指定します。たとえば、100番目のレコード以降の情報を表示するには、100を入力します。レコード数が多いときは、返される(表示される)レスポンスの数が制限され、{{more }}が{{true }}に設定されて表示するレコードがさらにあることが示されます。{{more }}が{{false }}に設定される場合は、すべてのレコードが表示されています
status (オプション): string

トランザクション・ステータス

指定できる値: [ "InProcess", "Confirming", "Confirmed", "FailedToConfirm", "Canceling", "Canceled", "FailedToCancel" ]

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: schema

型: array

ソースを表示

配列: object tcc-transactions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/tcc-transactions"
    }
}

ネストされたスキーマ: tcc-transactions

型: object

ソースを表示

more (オプション): boolean
transactions (オプション): array transactions

{
    "type":"object",
    "properties":{
        "more":{
            "type":"boolean"
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/tcc-transaction"
            }
        }
    }
}

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

型: array

ソースを表示

配列: object tcc-transaction

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/tcc-transaction"
    }
}

ネストされたスキーマ: tcc-transaction

型: object

ソースを表示

hostname: string

TCCトランザクションが初期化されるTMMコーディネータ・インスタンスID
id: string

TCCトランザクション参加側識別子
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":"TCC transaction participant identifier"
        },
        "userId":{
            "type":"string",
            "description":"Id of the user who initiated the TCC transaction"
        },
        "hostname":{
            "type":"string",
            "description":"TMM coordinator instance id where the TCC transaction gets initialized"
        },
        "status":{
            "$ref":"#/definitions/tcc-status"
        },
        "startTime":{
            "type":"string",
            "description":"TCC transaction start time"
        },
        "participants":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "id",
                    "uri",
                    "status"
                ],
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"TCC transaction participant identifier"
                    },
                    "uri":{
                        "type":"string",
                        "description":"TCC transaction participant call back url"
                    },
                    "timeLimit":{
                        "type":"string",
                        "description":"TCC transaction participant time limit"
                    },
                    "status":{
                        "$ref":"#/definitions/tcc-participant-status"
                    }
                }
            }
        }
    }
}

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

型: array

ソースを表示

配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "id",
            "uri",
            "status"
        ],
        "properties":{
            "id":{
                "type":"string",
                "description":"TCC transaction participant identifier"
            },
            "uri":{
                "type":"string",
                "description":"TCC transaction participant call back url"
            },
            "timeLimit":{
                "type":"string",
                "description":"TCC transaction participant time limit"
            },
            "status":{
                "$ref":"#/definitions/tcc-participant-status"
            }
        }
    }
}

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

型: object

ソースを表示

id: string

TCCトランザクション参加側識別子
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":"TCC transaction participant identifier"
        },
        "uri":{
            "type":"string",
            "description":"TCC transaction participant call back url"
        },
        "timeLimit":{
            "type":"string",
            "description":"TCC transaction participant time limit"
        },
        "status":{
            "$ref":"#/definitions/tcc-participant-status"
        }
    }
}

400レスポンス

Invalid Arguments

401レスポンス

Unauthorized

先頭に戻る

例

cURLコマンド

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

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

curl -X GET 
     -H "Authorization:Bearer $OTMM_COOKIE"
     https://192.0.2.1:8080/admin/v1/tcc-transaction

OTMM_COOKIEは、前に認証cookieを格納した変数の名前です。認証cookieの取得および変数への格納の詳細は、認証を参照してください。
192.0.2.1:8080は、RESTエンドポイントURLの例です。この値をRESTエンドポイントURLに変更して、ご使用の環境のIstioイングレス・ゲートウェイにアクセスします。ご使用のサイトのRESTエンドポイントURLを確認する方法の詳細は、リクエストの送信を参照してください。

レスポンス本文の例

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

{
    "more": false,
    "tccs": [
        {
            "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"
        }
    ]
}

先頭に戻る