Retrieve Details of all Saga Transactions
/admin/v1/lra-coordinator
Request
- application/json
-
begin: integer(int32)
Specify the offset or the number of records that you want to skip viewing. For example, enter 100 to view information from the 100th record and beyond. When there are a large number of records, the number of returned responses that is displayed is limited and {{more }} is set to {{true }} to indicate that more records are available for you to view. If {{more }} is set to {{false }}, then all the records have been displayed.
-
status: string
transaction statusAllowed Values:
[ "Active", "Closing", "Closed", "FailedToClose", "Cancelling", "Cancelled", "FailedToCancel" ]
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.
object
400 Response
401 Response
500 Response
Examples
cURL Command
The following example shows how to retrieve details of all Saga transactions 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
-
OTMM_COOKIE
is 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:8080
is 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.
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.
{
"lras": [
{
"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"
},
{
"begin": 1657178261312,
"closePending": false,
"encryptedEntry": "yoFck/vC...",
"end": 0,
"hostname": "otmm-tcs-6499bcc5f5-zqmzd",
"id": "2a6898ab-082c-4ad1-8d22-4d498c445527",
"keyVersion": "1",
"nonce": "SH9pmeudGKRHhARd",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhbGci...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657272796101,
"closePending": false,
"encryptedEntry": "zc6TKa...",
"end": 0,
"hostname": "otmm-tcs-69c4b49b6-854xw",
"id": "2f6253a4-c9ae-4439-8fc1-5b874de83e79",
"keyVersion": "1",
"nonce": "mmIdcpVmx00QA3xN",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJh...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657273469487,
"closePending": false,
"encryptedEntry": "dw7/plWfu...",
"end": 0,
"hostname": "otmm-tcs-69c4b49b6-854xw",
"id": "bccbf48f-a98e-4655-aa79-96e61711b27c",
"keyVersion": "1",
"nonce": "aB0NhtHpHgAWeTnL",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhbGciOiJS...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657273758984,
"closePending": false,
"encryptedEntry": "ySbkvf...",
"end": 0,
"hostname": "otmm-tcs-69c4b49b6-854xw",
"id": "bd307928-72ff-4175-b1b2-31b90032c29f",
"keyVersion": "1",
"nonce": "ZpTSxCKs0gigByk5",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJh...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657219888577,
"closePending": false,
"encryptedEntry": "IDMmg...",
"end": 0,
"hostname": "otmm-tcs-776cbd446c-mfz66",
"id": "c2bca0b4-1fee-4712-86cb-52301b671461",
"keyVersion": "1",
"nonce": "e7sEB9HixkmBhVrY",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhbGciOi...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657119367631,
"closePending": false,
"encryptedEntry": "dw7/plWfu...",
"end": 0,
"hostname": "otmm-tcs-6499bcc5f5-zqmzd",
"id": "e9a29853-15c2-486d-8e6e-201b8cd6c88c",
"keyVersion": "1",
"nonce": "aB0NhtHpHgAWeTnL",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhbG...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
},
{
"begin": 1657119602109,
"closePending": false,
"encryptedEntry": "ySbkvf...",
"end": 0,
"hostname": "otmm-tcs-6499bcc5f5-zqmzd",
"id": "f86b8ac5-27cb-4d43-8284-b068c068e677",
"keyVersion": "1",
"nonce": "ZpTSxCKs0gigByk5",
"parentLra": "",
"participants": null,
"status": "Active",
"thumbprint": "Bearer eyJhb...",
"timeout": 0,
"userId": "43225c1d-a626-4519-8fca-7a60593e3fd5"
}
],
"more": false
}