租户端互联网中间件分布式事务（DTF）数据结构

数据结构

最近更新时间: 2026-07-12 00:14:56

RetryTransactionError

重试主事务事务异常信息

被如下接口引用：RetryTransactions

名称	必选	允许NULL	类型	描述
TransactionId	是	否	Int64	主事务ID 示例值：
ErrorMessage	是	是	String	异常信息示例值：

Branch

分支事务

被如下接口引用：DescribeBranches

名称	必选	允许NULL	类型	描述
BranchId	否	是	Int64	分支事务ID 示例值：
ParentId	否	是	Int64	父级分支事务ID，顶级时返回null 示例值：
BranchBegin	否	是	Int64	分支事务开始时间戳，UTC，精确到毫秒示例值：
BranchEnd	否	是	Int64	分支事务结束时间戳，UTC，精确到毫秒示例值：
BranchType	否	是	Int64	分支事务类型示例值：
Name	否	是	String	分支事务名称示例值：
Status	否	是	Int64	分支事务状态示例值：
GroupId	否	是	String	事务分组ID 示例值：
Server	否	是	String	分支事务来源服务标识示例值：
Parameters	否	是	String	分支运行参数，Json格式字符串示例值：
TransactionId	否	是	Int64	主事务ID 示例值：

PagedBranch

分页分支事务

被如下接口引用：DescribeBranches

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数示例值：
Content	是	否	Array of Branch	分支事务分组列表示例值：查看

PagedCluster

分页集群

被如下接口引用：DescribeClusters

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	总条数示例值：
Content	否	是	Array of Cluster	集群列表示例值：查看

AllGroupStatistics

所有事务分组统计信息

被如下接口引用：DescribeAllGroupStatistics

名称	必选	允许NULL	类型	描述
TransactionQuantity	是	是	Int64	主事务总数示例值：
BranchQuantity	是	是	Int64	分支事务总数示例值：
ErrorTransactionQuantity	是	是	Int64	异常主事务数示例值：
GroupQuantity	是	是	Int64	事务分组数示例值：
Tps	是	是	Float	TPS 示例值：
SuccessStoreTime	否	是	Int64	成功事务存储时间示例值：
FailStoreTime	否	是	Int64	失败事务存储时间示例值：

Transaction

主事务

被如下接口引用：DescribeTransactions

名称	必选	允许NULL	类型	描述
TransactionId	否	是	Int64	主事务ID 示例值：
TransactionBegin	否	是	Int64	主事务开始时间戳，UTC，精确到毫秒示例值：
TransactionEnd	否	是	Int64	主事务结束时间戳，UTC，精确到毫秒示例值：
TransactionCommit	否	是	Int64	主事务提交时间戳，UTC，精确到毫秒示例值：
TransactionRollback	否	是	Int64	主事务回滚时间戳，UTC，精确到毫秒示例值：
TransactionError	否	是	Int64	主事务异常停止时间戳，UTC，精确到毫秒示例值：
Timeout	否	是	Int64	主事务超时时长，单位毫秒示例值：
Status	否	是	Int64	主事务状态示例值：
EndFlag	否	是	Int64	主事务结束标识示例值：
TimeoutFlag	否	是	Int64	主事务超时标识示例值：
Comment	否	是	String	异常信息示例值：
GroupId	否	是	String	事务分组ID 示例值：
Server	否	是	String	主事务来源服务标识示例值：
BranchQuantity	否	是	Int64	分支事务数量示例值：
RetryFlag	否	是	Bool	重试标识：true：可以重试；false：不可重试示例值：
ClusterId	否	是	String	集群名示例值：
TriggerFlag	否	是	Int64	触发类型，0 业务触发/ 1 手动触发示例值：
Statement	否	是	String	statement 示例值：

PagedTransaction

分页主事务

被如下接口引用：DescribeTransactions

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数，特定在该接口中总是会返回null 示例值：
Content	是	否	Array of Transaction	主事务分组列表示例值：查看

BranchStatistics

分支事务统计信息

被如下接口引用：DescribeBranchStatistics

名称	必选	允许NULL	类型	描述
BranchType	是	否	Int64	分支事务类型示例值：
Quantity	是	否	Int64	分支事务数示例值：

PagedGroup

分页事务分组

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数示例值：
Content	是	否	Array of Group	事务分组列表示例值：查看

Addresses

集群地址

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
Server	否	是	String	ipv4地址示例值：
ServerIpv6	否	是	String	ipv6地址示例值：
Zone	否	是	String	所属zone 示例值：

GroupStatistics

事务分组统计信息

被如下接口引用：DescribeGroupStatistics

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	事务分组ID 示例值：
TransactionQuantity	是	是	Int64	主事务总数示例值：
BranchQuantity	是	是	Int64	分支事务总数示例值：
ErrorTransactionQuantity	是	是	Int64	异常主事务数示例值：
SuccessStoreTime	否	否	Int64	成功事务存储时间（UCT毫秒数，GMT，-1为永久保留）示例值：
FailStoreTime	否	否	Int64	失败事务存储时间（UCT毫秒数，GMT，-1为永久保留）示例值：
Tps	否	是	Int64	tps 示例值：

Group

事务分组

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	事务分组ID 示例值：
GroupName	否	是	String	事务分组名称示例值：
GroupDescription	否	是	String	事务分组描述示例值：
CreationTime	否	是	Int64	创建时间戳，UTC，精确到毫秒示例值：
LastUpdateTime	否	是	Int64	更新时间戳，UTC，精确到毫秒示例值：
DeleteFlag	否	是	Bool	删除标识，true：可以删除；false：不可删除示例值：
Servers	否	是	Array of String	集群列表示例值：
ClusterId	否	是	String	协调器集群ID 示例值：
ClusterType	否	是	Int64	协调器集群类型示例值：
Ratelimit	否	是	Int64	限流值示例值：
Project	否	是	String	项目 ID 示例值：
ProjectName	否	是	String	项目名称示例值：
Ipv6Servers	否	是	Array of String	集群ipv6列表示例值：
ResourceId	否	是	String	事务分组的 tpo resource id 示例值：
SuccessStoreTime	否	是	Int64	成功事务保存时间示例值：
FailStoreTime	否	是	Int64	失败事务保存时间示例值：
Addresses	否	是	Array of Addresses	集群访问地址示例值：查看

Client

dtf 客户端信息

被如下接口引用：DescribeClients

名称	必选	允许NULL	类型	描述
Addresses	否	否	Array of String	客户端地址示例值：
Name	否	否	String	客户端名称示例值：
SdkVersion	否	是	String	sdk 版本示例值：

Database

数据库连接信息

被如下接口引用：CreateCluster、DescribeClusters、TestDB

名称	必选	允许NULL	类型	描述
Address	否	否	String	数据库连接信息，格式为 IP:PORT，如果包含多个地址，以逗号连接，例如 1.1.1.1:3306,2.2.2.2:3306 示例值：
User	否	否	String	数据库用户名示例值：
Password	否	是	String	数据库用户密码示例值：

ClientList

客户端列表

被如下接口引用：DescribeClients

名称	必选	允许NULL	类型	描述
Clients	否	是	Array of Client	客户端列表示例值：查看
CollectionTime	否	否	String	信息采集时间示例值：

Cluster

dtf集群

被如下接口引用：DescribeClusters

名称	必选	允许NULL	类型	描述
ClusterId	否	否	String	集群id 示例值：
ClusterType	否	是	Int64	集群类型示例值：
ComponentVersions	否	是	String	ComponentVersions 示例值：
CreationTime	否	是	Int64	创建时间示例值：
Creator	否	是	String	创建人示例值：
Database	否	是	Database	数据库信息示例值：查看
Description	否	是	String	集群描述示例值：
GroupQuantity	否	否	Int64	事务分组总数示例值：
Namespace	否	否	String	集群所在namespace 示例值：
Phase	否	是	String	集群当前状态示例值：
ReadOnly	否	是	Bool	只读集群示例值：
ScheduleParamStr	否	是	String	调度策略示例值：
Status	否	是	String	集群状态示例值：
StorageMode	否	是	String	存储模式示例值：