全部產品
Search
文件中心

Data Management:GetTableDesignProjectFlow - 擷取結構設計專案流程資訊

更新時間:Mar 21, 2026

調用此API可擷取結構設計工單當前所在環節、是否允許返回結構設計節點、執行發布的策略等資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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:請求成功。

  • false:請求失敗。

true

ErrorMessage

string

調用失敗時,返回的錯誤資訊。

UnknownError

ErrorCode

string

錯誤碼,請求異常時返回。

UnknownError

ProjectFlow

object

結構設計流程資訊。

FlowNodeArray

array<object>

流程節點列表。

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

提交發布可選擇執行策略列表。

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預設規則集"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情