文档

GetTableDesignProjectFlow - 获取结构设计项目流程信息

调用此API可获取结构设计工单当前所在环节、是否允许返回结构设计节点、执行发布的策略等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
OrderIdlong

结构设计工单 ID。您可调用 ListOrders 接口获取该参数的值。

95****
Tidlong

租户 ID。

说明 鼠标移动到界面右上角的头像处,查看租户 ID。具体操作,请参见查看租户信息
3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID,用于定位日志,排查问题。

B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773
Successboolean

请求是否成功,返回值说明如下:

  • true:请求成功。
  • false:请求失败。
true
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
ErrorCodestring

错误码,请求异常时返回。

UnknownError
ProjectFlowobject

结构设计流程信息。

FlowNodeArrayarray<object>

流程节点列表。

object
NodeRolestring

流程节点角色:

  • START:开始。
  • DESIGN:结构设计。
  • PUBLISH:发布。
  • END:结束。
DESIGN
NodeTitlestring

节点的标题。

设计阶段
Positioninteger

流程所在环节,从 1 开始。

1
PublishAnchorboolean

定义该节点是否为发布锚点。 一个结构设计流程中有且仅有一个发布锚点,负责执行发布操作。发布锚点发布后,将生成发布后镜像、释放 DDL 元数据锁。

false
BackToDesignboolean

是否允许流程返回结构设计阶段,取值:

  • 1:允许。

  • 0:不允许,只能定义在 PUBLISH(发布)节点上。

1
CanSkipboolean

是否允许跳过该当前节点,取值:

  • 1:可以。
  • 0:不可以,只能定义在 PUBLISH(发布)节点上。
0
PublishStrategiesarray

提交发布可选择执行策略列表。

string

选择执行发布策略:

  • IMMEDIATELY:立即执行。
  • REGULARLY:定时执行。
IMMEDIATELY
CurrentPositioninteger

当前结构设计流程所在节点位置。

2
RuleNamestring

结构设计应用的安全规则集名称。

mysql default
RuleCommentstring

结构设计应用的安全规则集描述。

mysql缺省规则集

示例

正常返回示例

JSON格式

{
  "RequestId": "B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectFlow": {
    "FlowNodeArray": [
      {
        "NodeRole": "DESIGN",
        "NodeTitle": "设计阶段",
        "Position": 1,
        "PublishAnchor": false,
        "BackToDesign": true,
        "CanSkip": true,
        "PublishStrategies": [
          "IMMEDIATELY"
        ]
      }
    ],
    "CurrentPosition": 2,
    "RuleName": "mysql default",
    "RuleComment": "mysql缺省规则集"
  }
}

错误码

访问错误中心查看更多错误码。