調用ListDoctorJobs API批量擷取任務運行資訊-開源巨量資料平台 E-MapReduce-阿里雲

通過EMR Doctor批量擷取任務基本運行資訊。

介面說明

list realtime jobs by yarn

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

emr:ListDoctorJobs

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。	cn-hangzhou
ClusterId	string	是	叢集 ID。	c-b933c5aac8fe****
NextToken	string	否	標記當前開始讀取的位置。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	否	一次擷取的最大記錄數。	20
StartRange	object	否	開始時間範圍，過濾開始時間在一個時間範圍內的任務。
StartTime	integer	否	任務提交時間起始範圍，Unix 時間戳記，單位毫秒。	1683340662016
EndTime	integer	否	任務提交時間結束範圍，Unix 時間戳記，單位毫秒。	1683340662020
EndRange	object	否	結束時間範圍，過濾出結束時間在一個時間範圍內的任務。
StartTime	integer	否	任務結束時間起始範圍，Unix 時間戳記，單位毫秒。	1679135111960
EndTime	integer	否	任務結束時間結束範圍，Unix 時間戳記，單位毫秒。	1666865137099
AppIds	array	否	任務提交到 YARN 的 IDs，用於過濾工作清單。	null
	string	否	YARN 的任務 ID。	application_1643475036865_******
Users	array	否	任務提交的使用者列表，用於過濾工作清單。	null
	string	否	任務提交到 YARN 的使用者名稱稱。	DW
Queues	array	否	任務提交到 YARN 的隊列列表，用於過濾工作清單。	null
	string	否	任務提交到的 YARN 隊列名稱。	DW
Types	array	否	任務提交到 YARN 的引擎列表，用於過濾工作清單。	null
	string	否	任務提交到 YARN 的引擎類型。	SPARK
OrderType	string	否	排序方向。取值： ASC：升序排列。 DESC：降序排列。	ASC
OrderBy	string	否	排序欄位。取值： vcoreSeconds：任務 CPU 使用量。 memSeconds：任務記憶體使用量量。	vcoreSeconds

返回參數

名稱	類型	描述	樣本值
	object	返回資料
Data	array<object>	工作清單資訊。
	array<object>	任務資訊。
AppId	string	任務提交到 YARN 的 ID。	application_1607584549220_*****
AppName	string	任務名稱。	tpcds
User	string	任務提交使用者名稱。	DW
Queue	string	任務提交到 YARN 的隊列。	DW
State	string	應用執行狀態，取值說明： FINISHED：結束的。 FAILED：失敗的。 KILLED：中止的。	FINISHED
FinalStatus	string	應用執行結束狀態，取值說明： SUCCEEDED：成功的。 FAILED：失敗的。 KILLED：中止的。 ENDED: 結束的。 UNDEFINED：未定義的。	KILLED
Type	string	計算引擎類型。	SPARK
StartTime	integer	任務提交時間，Unix 時間戳記，單位毫秒。	1675180800000
LaunchTime	integer	任務啟動時間，Unix 時間戳記，單位毫秒。	1672148400000
ElapsedTime	integer	任務運行總時間，單位毫秒。	242
FinishTime	integer	任務結束時間，Unix 時間戳記，單位毫秒。	1683690929000
Metrics	object	指標資料。
VcoreSeconds	object	CPU 使用量。
Name	string	指標名稱。	vcoreSeconds
Value	integer	指標值。	11123
Unit	string	指標單位。	VCores * Sec
Description	string	指標描述。	Total vcore usage over time in seconds
MemSeconds	object	記憶體使用量量。
Name	string	指標名稱。	memSeconds
Value	integer	指標值。	12312312
Unit	string	指標單位。	MB * Sec
Description	string	指標描述。	Total memory usage over time in seconds
RequestId	string	請求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	返回讀取到的資料位元置。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	本次請求所返回的最大記錄條數。	20
TotalCount	integer	本次請求條件下的資料總量。	200

樣本

正常返回樣本

JSON格式

{
  "Data": [
    {
      "AppId": "application_1607584549220_*****",
      "AppName": "tpcds",
      "User": "DW",
      "Queue": "DW",
      "State": "FINISHED",
      "FinalStatus": "KILLED",
      "Type": "SPARK",
      "StartTime": 1675180800000,
      "LaunchTime": 1672148400000,
      "ElapsedTime": 242,
      "FinishTime": 1683690929000,
      "Metrics": {
        "VcoreSeconds": {
          "Name": "vcoreSeconds\n",
          "Value": 11123,
          "Unit": "VCores * Sec\n",
          "Description": "Total vcore usage over time in seconds\n"
        },
        "MemSeconds": {
          "Name": "memSeconds",
          "Value": 12312312,
          "Unit": "MB * Sec\n",
          "Description": "Total memory usage over time in seconds\n"
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ConflictParameters	Parameters that must not be used together. %s	多個參數間存在衝突。
400	IncompleteSignature	The request signature is invalid.	API請求籤名不合法。
400	InvalidAction	The action %s requested is invalid.	不合法的Action。
400	InvalidParameter	The specified parameter %s is not valid.	參數錯誤。
400	InvalidParameterValue	The input parameter %s is invalid or out of range.	參數值超出範圍。
400	MissingAction	The action %s requested is missing.	缺少Action參數
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	參數缺失。
400	NotAuthorized	You do not have permission to perform this action. %s	沒有許可權。
400	ThrottlingException	The request was denied due to request throttling. %s	限流。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	內部錯誤。
404	ResourceNotFound	The resource not found by %s.	請求的資源未找到。
503	ServiceFailure	The request has failed due to a temporary failure of %s service.	依賴的阿里雲其他服務不可用。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	請求逾時或者服務不可用。

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

變更歷史

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