数据结构

最近更新时间: 2026-11-06 00:09:55

Transaction

主事务

被如下接口引用：DescribeTransactions

名称 必选 允许NULL 类型 描述
TransactionId 否 是 Int64 主事务ID
示例值： 716670931317628928
TransactionBegin 否 是 Int64 主事务开始时间戳，UTC，精确到毫秒
示例值： 1759130065163
TransactionEnd 否 是 Int64 主事务结束时间戳，UTC，精确到毫秒
示例值： 1759130065864
TransactionCommit 否 是 Int64 主事务提交时间戳，UTC，精确到毫秒
示例值： 1759130065718
TransactionRollback 否 是 Int64 主事务回滚时间戳，UTC，精确到毫秒
示例值： 1759130065718
TransactionError 否 是 Int64 主事务异常停止时间戳，UTC，精确到毫秒
示例值： 1759130065718
Timeout 否 是 Int64 主事务超时时长，单位毫秒
示例值： 60000
Status 否 是 Int64 主事务状态
示例值： 2
EndFlag 否 是 Int64 主事务结束标识
示例值： 1
TimeoutFlag 否 是 Int64 主事务超时标识
示例值： 0
Comment 否 是 String 异常信息
示例值： "ok"
GroupId 否 是 String 事务分组ID
示例值： "group-12eyqbju""
Server 否 是 String 主事务来源服务标识
示例值： spring-boot-orde
BranchQuantity 否 是 Int64 分支事务数量
示例值： 4
RetryFlag 否 是 Bool 重试标识：true：可以重试；false：不可重试
示例值： false
ClusterId 否 是 String 集群名
示例值： "default"
TriggerFlag 否 是 Int64 触发类型，0 业务触发/ 1 手动触发
示例值： 0
Statement 否 是 String statement
示例值： "insert into def_demo_order(product_id,qty,account_id) values (1,1,1);"

PagedCluster

分页集群

被如下接口引用：DescribeClusters

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

Client

dtf 客户端信息

被如下接口引用：DescribeClients

名称 必选 允许NULL 类型 描述
Addresses 否 否 Array of String 客户端地址
示例值： ["10.10.0.10:26434"]
Name 否 否 String 客户端名称
示例值： "order"
SdkVersion 否 是 String sdk 版本
示例值： "3.2-RELEASE"

AllGroupStatistics

所有事务分组统计信息

被如下接口引用：DescribeAllGroupStatistics

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

Group

事务分组

被如下接口引用：DescribeGroups

名称 必选 允许NULL 类型 描述
GroupId 否 是 String 事务分组ID
示例值： "group-12eyqbju""
GroupName 否 是 String 事务分组名称
示例值： "my-group"
GroupDescription 否 是 String 事务分组描述
示例值： "My Group"
CreationTime 否 是 Int64 创建时间戳，UTC，精确到毫秒
示例值： 1758541337443
LastUpdateTime 否 是 Int64 更新时间戳，UTC，精确到毫秒
示例值： 1758541337443
DeleteFlag 否 是 Bool 删除标识，true：可以删除；false：不可删除
示例值： false
Servers 否 是 Array of String 集群列表
示例值： ["10.10.0.10:16353"]
ClusterId 否 是 String 协调器集群ID
示例值： "default"
ClusterType 否 是 Int64 协调器集群类型
示例值： 1
Ratelimit 否 是 Int64 限流值
示例值： 100
Project 否 是 String 项目 ID
示例值： "pr-4fb59f73"
ProjectName 否 是 String 项目名称
示例值： "p1"
Ipv6Servers 否 是 Array of String 集群ipv6列表
示例值： ["fc00:1324:acbd:ef01::1]:16353"]
ResourceId 否 是 String 事务分组的 tpo resource id
示例值： "default/group-12rvmwta"
SuccessStoreTime 否 是 Int64 成功事务保存时间
示例值： 172800000
FailStoreTime 否 是 Int64 失败事务保存时间
示例值： 172800000
Addresses 否 是 Array of Addresses 集群访问地址
示例值：查看

PagedBranch

分页分支事务

被如下接口引用：DescribeBranches

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

ClientList

客户端列表

被如下接口引用：DescribeClients

名称 必选 允许NULL 类型 描述
Clients 否 是 Array of Client 客户端列表
示例值：查看
CollectionTime 否 否 String 信息采集时间
示例值： "2025-04-10 06:54:59 GMT"

BranchStatistics

分支事务统计信息

被如下接口引用：DescribeBranchStatistics

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

PagedGroup

分页事务分组

被如下接口引用：DescribeGroups

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

Addresses

集群地址

被如下接口引用：DescribeGroups

名称 必选 允许NULL 类型 描述
Server 否 是 String ipv4地址
示例值： "10.10.0.10:16353"
ServerIpv6 否 是 String ipv6地址
示例值： "[fc00:1324:acbd:ef01::1]:16353"
Zone 否 是 String 所属zone
示例值： "az1"

GroupStatistics

事务分组统计信息

被如下接口引用：DescribeGroupStatistics

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

RetryTransactionError

重试主事务事务异常信息

被如下接口引用：RetryTransactions

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

Database

数据库连接信息

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

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

Cluster

dtf集群

被如下接口引用：DescribeClusters

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

PagedTransaction

分页主事务

被如下接口引用：DescribeTransactions

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

Branch

分支事务

被如下接口引用：DescribeBranches

名称 必选 允许NULL 类型 描述
BranchId 否 是 Int64 分支事务ID
示例值： 716670931657367552
ParentId 否 是 Int64 父级分支事务ID，顶级时返回null
示例值： 716670931657367513
BranchBegin 否 是 Int64 分支事务开始时间戳，UTC，精确到毫秒
示例值： 1759130065209
BranchEnd 否 是 Int64 分支事务结束时间戳，UTC，精确到毫秒
示例值： 1759130065765
BranchType 否 是 Int64 分支事务类型
示例值： 0
Name 否 是 String 分支事务名称
示例值： "INSERT:dtf_demo_order.dtf_demo_order@1247476360"
Status 否 是 Int64 分支事务状态
示例值： 1
GroupId 否 是 String 事务分组ID
示例值： "group-12eyqbju""
Server 否 是 String 分支事务来源服务标识
示例值： "spring-boot-order"
Parameters 否 是 String 分支运行参数，Json格式字符串
示例值： "["dataSource"]"
TransactionId 否 是 Int64 主事务ID
示例值： 716670931317628928