GetTableDesignProjectFlow - 获取结构设计项目流程信息 - 数据管理 DMS

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:GetTableDesignProjectFlow	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
OrderId	long	是	结构设计工单 ID。您可调用 ListOrders 接口获取该参数的值。	95****
Tid	long	否	租户 ID。说明鼠标移动到界面右上角的头像处，查看租户 ID。具体操作，请参见查看租户信息。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	B5FD0BC8-2D90-4478-B8EC-A0E92E0B1773
Success	boolean	请求是否成功，返回值说明如下： true：请求成功。 false：请求失败。	true
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
ErrorCode	string	错误码，请求异常时返回。	UnknownError
ProjectFlow	object	结构设计流程信息。
FlowNodeArray	array<object>	流程节点列表。
FlowNodeArray	object
NodeRole	string	流程节点角色： START：开始。 DESIGN：结构设计。 PUBLISH：发布。 END：结束。	DESIGN
NodeTitle	string	节点的标题。	设计阶段
Position	integer	流程所在环节，从 1 开始。	1
PublishAnchor	boolean	定义该节点是否为发布锚点。一个结构设计流程中有且仅有一个发布锚点，负责执行发布操作。发布锚点发布后，将生成发布后镜像、释放 DDL 元数据锁。	false
BackToDesign	boolean	是否允许流程返回结构设计阶段，取值： 1：允许。 0：不允许，只能定义在 PUBLISH（发布）节点上。	1
CanSkip	boolean	是否允许跳过该当前节点，取值： 1：可以。 0：不可以，只能定义在 PUBLISH（发布）节点上。	0
PublishStrategies	array	提交发布可选择执行策略列表。
PublishStrategies	string	选择执行发布策略： IMMEDIATELY：立即执行。 REGULARLY：定时执行。	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缺省规则集"
  }
}

错误码

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