用于在數據開發過程中觸發擴展點時,通過將擴展程序對擴展點事件的檢查結果返回給數據開發系統。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dataworks:* | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MessageId | string | 否 | DataWorks 開放消息的消息 ID。當觸發擴展點事件后,您可以從接收到的事件消息中獲取消息 ID。 消息格式,可參考消息格式。 | 8abcb91f-d266-4073-b907-2ed670378ed1 |
ExtensionCode | string | 否 | 擴展程序的唯一標識。您可以登錄 DataWorks 控制臺,進入開放平臺的 Extensions 頁簽查看標識。 | 8abcb91f-d266-4073-b907-2ed670378ed1 |
CheckResult | string | 否 | 擴展程序對本次擴展點事件的檢查狀態。取值如下:
| OK |
CheckResultTip | string | 否 | 擴展程序對本次擴展點事件進行檢查的摘要信息。該信息會顯示在您當前的開發頁面上,當本次檢查存在警告或者檢查不通過時,您可以通過該摘要信息快速定位原因。 | Succeeded |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系統內部錯誤,請稍后再試。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 沒有權限,請授權 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 對該資源的請求已超過您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系統繁忙,請稍后再試。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的請求過于頻繁,請嘗試放緩請求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系統內部錯誤,請稍后再試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史