觸發一次任務立即運行。
接口說明
說明
因為
JobID
聯合ScheduleTime
是唯一索引,所以同一個任務連續調用 ExecuteJob 接口的時,每次要 sleep 一秒,否則任務有可能會失敗。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
edas:ManageSchedulerxJobTrigger | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobId | long | 是 | 任務 ID,在控制臺的任務管理頁面中獲取。 | 92583 |
InstanceParameters | string | 否 | 本次觸發攜帶參數,可以是任意字符串, | test |
Namespace | string | 是 | 命名空間 ID,在控制臺的命名空間頁面中獲取。 | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
NamespaceSource | string | 否 | 特殊第三方才需要填寫。 | schedulerx |
GroupId | string | 是 | 應用 ID,在控制臺的應用管理頁面中獲取。 | testSchedulerx.defaultGroup |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
CheckJobStatus | boolean | 否 | 是否檢查任務狀態,取值如下:true:任務啟用才能執行任務。false:任務不啟用也可以執行任務。 | true |
DesignateType | integer | 否 | 指定機器的類型,取值如下:1:指定 worker。2:指定 label | 1 |
Worker | string | 否 | 應用的 worker 地址,需要先通過 GetWokerList 接口返回 workerAddress | xxxxxxx@127.0.0.1:222 |
Label | string | 否 | worker 的標簽 | gray |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "groupid not exist groupId: testSchedulerx.defaultGroup namespace: adcfc35d-e2fe-4fe9-bbaa-20e90ffc****",
"RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108****",
"Success": true,
"Data": {
"JobInstanceId": 11111111
},
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-10-21 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2022-12-26 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2021-12-30 | OpenAPI 入參發生變更 | 查看變更詳情 |
2021-12-20 | OpenAPI 入參發生變更 | 查看變更詳情 |