全部產品
Search
文件中心

DataWorks:CallbackExtension

更新時間:Jul 31, 2026

用於在 DataWorks 平台使用過程中觸發擴充點時,透過呼叫 CallbackExtension 介面,將擴充程式對擴充點事件的檢查結果返回給 DataWorks 平台。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

none

*All Resource

*

無 無

請求參數

名稱

類型

必填

描述

樣本值

ExtensionCode

string

是

擴充程式唯一編碼。

8abcb91f-d266-4073-b907-2****

MessageId

string

是

DataWorks 開放訊息的訊息 ID。當觸發擴充點事件後,您可以從接收到的事件訊息中獲取訊息 ID。

034********091

CheckResult

string

是

擴充程式對本次擴充點事件的檢查狀態。取值如下:

  • OK:擴充程式對本次擴充點事件檢查通過。

  • FAIL:擴充程式對本次擴充點事件檢查不通過。您需要檢視並及時處理錯誤,以免影響後續程式的正常執行。

  • WARN:擴充程式對本次擴充點事件檢查通過,但存在警告。

枚舉值:

  • OK :

    檢查通過。

  • FAIL :

    檢查不通過。

  • WARN :

    檢查通過但存在警告。

FAIL

CheckMessage

string

否

當 CheckResult 設定為 FAIL 時,提供 FAIL 原因。

The xxx rule is hit. Modify it and try again.

返回參數

名稱

類型

描述

樣本值

object

返回結果。

RequestId

string

唯一的請求 ID。

7C352CB7-CD88-50CF-9D0D-E81BDF020E7F

Success

string

呼叫是否成功。取值如下:

true:呼叫成功。

false:呼叫失敗。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF020E7F",
  "Success": "true"
}

錯誤碼

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

變更歷史

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