使用CreateOrder建立通用工單-Data Management-阿里雲

介面說明

為了降低建立工單的難度，如果您需要建立以下類型的工單，請調用專用介面建立。

普通資料變更工單：調用 CreateDataCorrectOrder 介面。
歷史資料清理工單：調用 CreateDataCronClearOrder 介面。
資料匯入工單：調用 CreateDataImportOrder 介面。
無鎖變更工單：調用 CreateFreeLockCorrectOrder 介面。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:CreateOrder

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 或 ListUserTenants 擷取該參數的值。	3***
Comment	string	是	輸入工單描述資訊。	test
PluginParam	object	是	建立工單參數，格式為 JSON 形式的字串。每個工單類型的參數設定不一致，詳情請參見表格下方的PluginParam 參數補充說明。	{PluginParam_test}
RelatedUserList	string	否	工單相關人使用者識別碼列表，多個相關人用半形逗號（,）隔開。	user1,user2
PluginType	string	是	工單類型，取值請參見 PluginType 參數說明。	DATA_EXPORT
AttachmentKey	string	否	上傳附件成功後返回的附件 Key，可通過調用介面 GetUserUploadFileJob 擷取該參數的值。	test_AttachmentKey
RealLoginUserUid	string	否

PluginParam 參數補充說明

# 結構設計
 {
    "title": "test", // 標題
    "description": "test", // 描述
    "dbId": 11****, // 基準庫
    "logic": false, // 是否邏輯庫
    "relatedIds": [], // 變更相關人使用者識別碼
  }

# 資料匯出
 {
  "classify": "原因分類", // 原因分類
  "dbId": 17****, // 匯出庫 id
  "exeSQL": "select 1", // 匯出 SQL
  "logic": false, // 是否邏輯庫
  "ignoreAffectRows": false, // 是否忽略校正影響行數
  "affectRows": 1, // 使用者預估影響行數
  "ignoreAffectRowsReason": "" // 忽略影響行數校正原因
 }

# 許可權工單
{
	"seconds": xxx, //許可權時間長度，單位為秒
	"permType": xx, //權限類別型：1-查詢 2-匯出 4-變更, 如果申請多個權限類別型，則為值相加，例如查詢和匯出的許可權則為 3
	"resources": [{
		"dbId": xxx, // 資料庫 id
		"instanceId": xxx // 執行個體 id
		"logic": xxx // 是否為邏輯庫
		"tableName": xxx // 表名
		"tableId": xxx //表 ID
		"columnName": xxx //欄位名
	}],
	"type": "xx" // INSTANT 或者 DB 或者 TABLE
}

返回參數

名稱	類型	描述	樣本值
	object
CreateOrderResult	object
OrderIds	array	建立成功的工單資訊。
	integer	工單號。	12***
RequestId	string	請求 ID。	427688B8-ADFB-4C4E-9D45-EF5C1FD6****
ErrorCode	string	錯誤碼。	UnknownError
ErrorMessage	string	錯誤資訊。	UnknownError
Success	boolean	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true

樣本

正常返回樣本

JSON格式

{
  "CreateOrderResult": {
    "OrderIds": [
      0
    ]
  },
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

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