獲取專業版應用任務調度概覽數據信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| edas:ReadSchedulerxOverviewQuery | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 區域 Region ID | cn-hangzhou |
| Namespace | string | 否 | 命名空間 UID | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| NamespaceSource | string | 否 | 命名空間來源，特殊第三方才需要填寫 | schedulerx |
| GroupId | string | 否 | 應用分組 ID | testSchedulerx.defaultGroup |
| Operate | string | 是 | 可選項
| query |
| MetricType | integer | 是 | 可選項
| 0 |
| StartTime | long | 是 | 數據起始時間戳（單位：秒），如：1684166400 | 1684166400 |
| EndTime | long | 否 | 數據結束時間戳（單位：秒），如：1684166400 不填默認為當前時間 | 1684166400 |
當前接口查詢數據信息對應控制臺概覽的三塊信息內容，相應請求參數配置要求如下
-
任務基礎信息：請求參數配置說明如下，Operate 設置“query”，MetricType 設置為“0”，StartTime 設置為當前時間戳
-
時間區間任務運行信息：請求參數配置說明如下，Operate 設置“query”，MetricType 設置為“1”，StartTime 設置為業務需要的查詢起始時間（不得早于 15 天，當前時序數據存儲有效期為 15 天）
-
時間區間任務運行時序信息：請求參數配置說明如下，Operate 設置“query_range”，MetricType 設置為“1”，StartTime 設置為業務需要的查詢起始時間（默認推薦當前 1 小時前，因返回每個時點信息量大不建議設置過早）
返回參數
Data 信息會根據三種數據讀取，返回不同格式的 JSON 內容，參考如下：
- 基礎信息：
{
"schedulerx_job_counter_disable": "4", // 禁用任務數
"schedulerx_job_counter_enable": "70", // 啟用任務數
"schedulerx_job_counter_all": "74", // 總任務數
"schedulerx_worker_counter": "2", // 在線機器數
"schedulerx_job_trigger_counter_running": "0" // 任務運行中實例數
}
- 時間區間任務運行信息：
{
"schedulerx_job_trigger_counter_success": "227", //
"schedulerx_job_trigger_counter_all": "225",
"schedulerx_job_trigger_counter_failed": "0"
}
- 時間區間任務運行時序信息：返回對應區間 任務觸發、運行成功、運行失敗三個數據項對應時點的統計信息
[
{
"data": [
[
1686110400000,
4
],
[
1686110460000,
5
]
],
"name": "觸發次數"
},
{
"data": [
[
1686110400000,
0
],
[
1686110460000,
0
]
],
"name": "執行失敗"
},
{
"data": [
[
1686110400000,
4
],
[
1686110460000,
5
]
],
"name": "執行成功"
}
]
示例
正常返回示例
JSON格式
{
"RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
"Code": 200,
"Success": true,
"Message": "No access permission for the namespace [***]",
"Data": "基礎信息：{\"schedulerx_job_counter_disable\": \"4\",\"schedulerx_job_trigger_counter_running\": \"0\",\"schedulerx_job_counter_enable\": \"70\",\"schedulerx_job_counter_all\": \"74\",\"schedulerx_worker_counter\": \"2\"}",
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-10-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |