Retrieve Details of a Saga Transaction
/admin/v1/lra-coordinator/{id}
Request
- application/json
-
id(required): string
Unique ID which you can use to track the transaction.
Response
- application/json
200 Response
object-
begin(required):
integer(int64)
The time at which the Saga transaction began.
-
closePending(required):
boolean
Indicates whether the Saga close operation is in progress or if it has completed.
-
end(required):
integer(int64)
The time at which the Saga transaction reached a final state.
-
hostname(required):
string
ID of the MicroTx coordinator instance where the Saga transaction begins.
-
id(required):
string
Unique transaction ID of the Saga transaction.
-
parentLra:
string
Parent Saga transaction ID. Applicable for nested Saga transactions.
-
participants:
array participants
-
status(required):
string
Allowed Values:
[ "Active", "Closing", "Closed", "FailedToClose", "Cancelling", "Cancelled", "FailedToCancel" ] -
timeout(required):
integer(int32)
Saga transaction timeout in milliseconds.
-
userId(required):
string
ID of the user who initiated the Saga transaction.
object-
begin(required):
integer(int64)
The time at which the Saga transaction began.
-
id(required):
string
Unique transaction ID of the Saga transaction.
-
links(required):
object links
Saga transaction participant call back links for compensate,complete and status endpoints.
-
status(required):
string
Allowed Values:
[ "Active", "Completing", "Completed", "FailedToComplete", "Compensating", "Compensated", "FailedToCompensate" ] -
timeout(required):
integer(int32)
Saga transaction participant timeout value in milliseconds.
object400 Response
401 Response
404 Response
Examples
cURL Command
The following example shows how to view details of a Saga transaction by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
Enter the command on a single line. Line breaks are used in this example for readability.
curl -X GET
-H "Authorization:Bearer $OTMM_COOKIE"
https://192.0.2.1:8080/admin/v1/lra-coordinator/15cd86ca-e0b7-4778-8cb6-4b78dfb3b981-
OTMM_COOKIEis the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authenticate. -
192.0.2.1:8080is an example REST endpoint URL. Change this value to the REST endpoint URL to access the Istio ingress gateway in your environment. For information about finding out REST endpoint URL for your site, see Send Requests. -
15cd86ca-e0b7-4778-8cb6-4b78dfb3b981is an example value for a Saga transaction ID. Replace this value with the transaction ID of a Saga transaction in your environment.
Example of the Response Body
The following example shows the contents of the response body in JSON format. Example values have been truncated with ... to improve readability. When you view the response in your environment, you'll see the entire value.
{
"begin": 1657273191245,
"closePending": false,
"encryptedEntry": "IDMmg...",
"end": 0,
"hostname": "otmm-tcs-69c4b49b6-854xw",
"id": "15cd86ca-e0b7-4778-8cb6-4b78dfb3b981",
"keyVersion": "1",
"nonce": "e7sEB9HixkmBhVrY",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhb...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
}