全部產品
Search
文件中心

Data Management:CreateStructSyncOrder - 建立結構同步工單

更新時間:Mar 21, 2026

建立變更工單。

介面說明

僅管控模式為安全協同的資料庫執行個體可調用此 API。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:CreateStructSyncOrder

create

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Comment

string

工單備忘。

test

RelatedUserList

array

相關人 ID 列表。

integer

相關人 ID。

432***

Param

object

工單參數。

Source

object

基準庫資訊。

DbId

integer

庫 ID,可調用 SearchDatabases 介面擷取。

432****

DbSearchName

string

庫搜尋名,可調用 SearchDatabases 介面擷取。

test

Logic

boolean

是否為邏輯庫,取值:

  • true:是

  • false:否

false

VersionId

string

版本號碼,預設為最新的表結構版本,更多資訊,請參見管理表結構版本

e179bbb8163dcdcfacda24858bedb4d8006ae2b8

Target

object

目標庫資訊。

DbId

integer

庫 ID,可調用 SearchDatabases 介面擷取。

432***

DbSearchName

string

庫搜尋名,可調用 SearchDatabases 介面擷取。

test

Logic

boolean

是否為邏輯庫,取值:

  • true:是

  • false:否

false

VersionId

string

版本號碼。

說明

當您輸入目標庫的表結構版本號碼時,該工單僅會對比兩個庫之間的表結構。

e179bbb8163dcdcfacda24858bedb4d8006ae2b8

IgnoreError

boolean

是否忽略報錯,取值:

  • true:忽略,遇到錯誤會跳過當前失敗 SQL 指令碼,繼續執行。

  • false:不忽略,遇到出錯則中斷後面的 SQL 指令碼,不再執行。

false

TableInfoList

array<object>

同步的表資訊列表。

object

同步的表。

SourceTableName

string

源表表名。

test_tbl

TargetTableName

string

目標表表名。

test_tbl

AttachmentKey

string

上傳附件成功後返回的附件 Key,您可以調用 GetUserUploadFileJob 介面擷取。

upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql

Tid

integer

租戶 ID。

說明

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

3***

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

4E1D2B4D-3E53-4ABC-999D-1D2520B3471A

Success

boolean

請求是否成功。

true

ErrorMessage

string

錯誤資訊。

UnknownError

ErrorCode

string

錯誤碼。

UnknownError

CreateOrderResult

array

建立工單結果。

integer

工單號。

432****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情