創(chuàng)建工單。
接口說(shuō)明
為了降低創(chuàng)建工單的難度,如果您需要?jiǎng)?chuàng)建以下類型的工單,請(qǐng)調(diào)用專用接口創(chuàng)建。
- 普通數(shù)據(jù)變更工單:調(diào)用 CreateDataCorrectOrder 接口。
- 歷史數(shù)據(jù)清理工單:調(diào)用 CreateDataCronClearOrder 接口。
- 數(shù)據(jù)導(dǎo)入工單:調(diào)用 CreateDataImportOrder 接口。
- 無(wú)鎖變更工單:調(diào)用 CreateFreeLockCorrectOrder 接口。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dms:CreateOrder | create | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Tid | long | 否 | 租戶 ID,可通過(guò)調(diào)用接口 GetUserActiveTenant 或 ListUserTenants 獲取該參數(shù)的值。 | 3*** |
Comment | string | 是 | 輸入工單描述信息。 | test |
PluginParam | object | 是 | 創(chuàng)建工單參數(shù),格式為 JSON 形式的字符串。每個(gè)工單類型的參數(shù)設(shè)置不一致,詳情請(qǐng)參見表格下方的PluginParam 參數(shù)補(bǔ)充說(shuō)明。 | {PluginParam_test} |
RelatedUserList | string | 是 | 工單相關(guān)人用戶 ID 列表,多個(gè)相關(guān)人用半角逗號(hào)(,)隔開。 | user1,user2 |
PluginType | string | 是 | 工單類型,取值請(qǐng)參見 PluginType 參數(shù)說(shuō)明。 | DATA_EXPORT |
AttachmentKey | string | 否 | 上傳附件成功后返回的附件 Key,可通過(guò)調(diào)用接口 GetUserUploadFileJob 獲取該參數(shù)的值。 | test_AttachmentKey |
PluginParam 參數(shù)補(bǔ)充說(shuō)明
# 結(jié)構(gòu)設(shè)計(jì)
{
"title": "test", // 標(biāo)題
"description": "test", // 描述
"dbId": 11****, // 基準(zhǔn)庫(kù)
"logic": false, // 是否邏輯庫(kù)
"relatedIds": [], // 變更相關(guān)人用戶 ID
}
# 數(shù)據(jù)導(dǎo)出
{
"classify": "原因分類", // 原因分類
"dbId": 17****, // 導(dǎo)出庫(kù) id
"exeSQL": "select 1", // 導(dǎo)出 SQL
"logic": false, // 是否邏輯庫(kù)
"ignoreAffectRows": false, // 是否忽略校驗(yàn)影響行數(shù)
"affectRows": 1, // 用戶預(yù)估影響行數(shù)
"ignoreAffectRowsReason": "" // 忽略影響行數(shù)校驗(yàn)原因
}
如果您需要?jiǎng)?chuàng)建更多類型的工單,請(qǐng)?zhí)峤还巫稍儭?
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"CreateOrderResult": {
"OrderIds": [
0
]
},
"RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6****",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|