apache / apache/incubator-seata

docs: the console interface docs

Open
#4,195 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
26k
Forks
8.8k
Avg merge
1d 8h
Merged PRs (30d)
4

Description

1.console/globalSession/query
接口名称:条件查询全局事物信息列表
方法类型:get
入参:

- xid String xid 非必要
- applicationId String 应用id 非必要
- status Integer 全局事务状态 非必要
- transactionName String 全局事务名称 非必要
- withBranch boolean 是否待分支事务信息 true:带分支事务信息,false:不带分支事务信息 非必要,默认false

- pageNum Integer 页码 必要
- pageSize Integer 每页大小 必要
- timeStart Date 事务开始时间 非必要
- timeEnd Date 事务结束时间 非必要

出参:

```java
{
"code": "200",
"message": "success",
"pageSize": 0, //每页数据量
"pageNum": 0, //页码
"total": 2,//数据总量
"pages": 0,//总页数
"data": [
{
"xid": null, //全局事务id
"transactionId": null, //事务id
"status": null, //全局事务状态
"applicationId": null,//应用id
"transactionServiceGroup": null,//事务分组
"transactionName": "tst1",//事务名称
"timeout": null,//事务超时时间
"beginTime": null,//事务开始时间
"applicationData": null,//应用数据
"gmtCreate": null,//记录创建时间
"gmtModified": null,//记录修改时间
"branchSessionVOs": [//分支事物列表
{
"xid": null,//全局事务id
"transactionId": null,//事务id
"branchId": null,//分支事务id
"resourceGroupId": null,//事务分组id
"resourceId": null,//资源id
"branchType": null,//分支类型
"status": null,//分支事务状态
"clientId": null,//客户端id
"applicationData": null,//应用数据
"gmtCreate": null,//记录创建时间
"gmtModified": null//记录修改时间
},
{
"xid": null,
"transactionId": null,
"branchId": null,
"resourceGroupId": null,
"resourceId": null,
"branchType": null,
"status": 2,
"clientId": null,
"applicationData": "ferw",
"gmtCreate": null,
"gmtModified": null
}
]
},
{
"xid": null,
"transactionId": null,
"status": null,
"applicationId": null,
"transactionServiceGroup": null,
"transactionName": "tst2",
"timeout": null,
"beginTime": null,
"applicationData": null,
"gmtCreate": null,
"gmtModified": null,
"branchSessionVOs": null
}
],
"currPage": 0,//当前页码
"success": true
}
```

Contributor guide

Open the contributing guide

Research direction

Locate the existing documentation for the console API and the `console/globalSession/query` endpoint. Document its request parameters and response schema, including the optional branch-session data; done when the endpoint details are available in the appropriate documentation location.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.