全部產品
Search

搜尋本產品

    Data Management：GetTableDesignProjectInfo - 擷取結構設計專案資訊

    文件中心

    Data Management：GetTableDesignProjectInfo - 擷取結構設計專案資訊

    更新時間：Mar 21, 2026

    調用此API可擷取指定結構設計工單的專案資訊以及工單的變更基準庫的資訊，包含結構設計工單的狀態、工單建立者ID、基準庫的名稱和ID等。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:GetTableDesignProjectInfo

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    OrderId

    integer

    是

    結構設計工單 ID。您可調用 ListOrders 介面擷取該參數的值。

    95****
    Tid

    integer

    否

    租戶 ID。

    說明

    取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。

    3***

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID，用於定位日誌，排查問題。

    48778434-5796-571A-8455-A59146588401
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功。

    • false：請求失敗。

    true
    ErrorMessage

    string

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

    UnknownError
    ErrorCode

    string

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

    UnknownError
    ProjectInfo

    object

    結構設計專案資訊。

    OrderId

    integer

    工單 ID。

    95****
    ProjectId

    integer

    專案 ID。

    12****
    GmtCreate

    string

    工單的建立時間。

    2024-04-23 02:57:01
    GmtModified

    string

    最後一次修改工單的時間。

    2024-04-23 02:57:01
    Status

    string

    結構設計專案的狀態：

    • DESIGN：設計中。

    • PUBLISHED：發行。

    • CLOSE：已關閉。

    DESIGN
    Title

    string

    結構設計專案名稱。

    使用者增長戰役
    Description

    string

    結構設計專案描述。

    測試
    CreatorId

    integer

    工單建立者的使用者識別碼。

    71****
    BaseDatabase

    object

    結構設計中變更基準庫的資訊。

    SearchName

    string

    搜尋資料庫的名稱。

    schema_name@127.0.XX.XX
    SchemaName

    string

    資料庫名稱。

    bk_atc020
    DbId

    integer

    資料庫 ID。

    11****
    Logic

    boolean

    是否為邏輯庫，取值：

    • true：是。

    • false：否。

    false
    Alias

    string

    執行個體別名。

    核心交易庫
    EnvType

    string

    環境類型，取值如下：

    • product：生產環境。

    • dev：開發環境。

    • pre：預發環境。

    • test：測試環境。

    • sit：SIT 環境。

    • uat：UAT 環境。

    • pet：壓測環境。

    • stag：STAG 環境。

    dev
    DbType

    string

    資料庫類型，傳回值請參見 DbType 參數說明。

    POLARDB

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "48778434-5796-571A-8455-A59146588401",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "ProjectInfo": {
    "OrderId": 0,
    "ProjectId": 0,
    "GmtCreate": "2024-04-23 02:57:01",
    "GmtModified": "2024-04-23 02:57:01",
    "Status": "DESIGN",
    "Title": "使用者增長戰役",
    "Description": "測試",
    "CreatorId": 0,
    "BaseDatabase": {
      "SearchName": "schema_name@127.0.XX.XX",
      "SchemaName": "bk_atc020",
      "DbId": 0,
      "Logic": false,
      "Alias": "核心交易庫",
      "EnvType": "dev",
      "DbType": "POLARDB"
    }
  }
}

    錯誤碼

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

    變更歷史

    更多資訊，參考變更詳情。