调用此API可获取结构设计工单当前所在环节、是否允许返回结构设计节点、执行发布的策略等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:GetTableDesignProjectFlow |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| OrderId |
integer |
是 |
结构设计工单 ID。您可调用 ListOrders 接口获取该参数的值。 |
95**** |
| Tid |
integer |
否 |
租户 ID。 说明
鼠标移动到界面右上角的头像处，查看租户 ID。具体操作，请参见查看租户信息。 |
3*** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID，用于定位日志，排查问题。 |
B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773 |
| Success |
boolean |
请求是否成功，返回值说明如下：
|
true |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
UnknownError |
| ErrorCode |
string |
错误码，请求异常时返回。 |
UnknownError |
| ProjectFlow |
object |
结构设计流程信息。 |
|
| FlowNodeArray |
array<object> |
流程节点列表。 |
|
|
object |
|||
| NodeRole |
string |
流程节点角色：
|
DESIGN |
| NodeTitle |
string |
节点的标题。 |
设计阶段 |
| Position |
integer |
流程所在环节，从 1 开始。 |
1 |
| PublishAnchor |
boolean |
定义该节点是否为发布锚点。 一个结构设计流程中有且仅有一个发布锚点，负责执行发布操作。发布锚点发布后，将生成发布后镜像、释放 DDL 元数据锁。 |
false |
| BackToDesign |
boolean |
是否允许流程返回结构设计阶段，取值：
|
1 |
| CanSkip |
boolean |
是否允许跳过该当前节点，取值：
|
0 |
| PublishStrategies |
array |
提交发布可选择执行策略列表。 |
|
|
string |
选择执行发布策略：
|
IMMEDIATELY |
|
| CurrentPosition |
integer |
当前结构设计流程所在节点位置。 |
2 |
| RuleName |
string |
结构设计应用的安全规则集名称。 |
mysql default |
| RuleComment |
string |
结构设计应用的安全规则集描述。 |
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缺省规则集"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。