文档

CallbackExtension

更新时间:

用于在DataWorks平台使用过程中触发扩展点时,通过调用CallbackExtension接口,将扩展程序对扩展点事件的检查结果返回给DataWorks平台。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String CallbackExtension

系统规定参数。取值:CallbackExtension

ExtensionCode String 8abcb91f-d266-4073-b907-2ed670378ed1

扩展程序唯一编码。

MessageId String 034********091

DataWorks开放消息的消息ID。当触发扩展点事件后,您可以从接收到的事件消息中获取消息ID。

消息格式,可参考消息格式

CheckResult String FAIL

扩展程序对本次扩展点事件的检查状态。取值如下:

  • OK:扩展程序对本次扩展点事件检查通过。
  • FAIL:扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错,以免影响后续程序的正常执行。
  • WARN:扩展程序对本次扩展点事件检查通过,但存在警告。
CheckMessage String 命中xxx规则,请修改后重试

当CheckResult设置为FAIL,提供FAIL原因

返回数据

名称

类型

示例值

描述

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

唯一的请求ID

Success String true

调用是否成功。取值如下:

true:调用成功。

false:调用失败。

示例

请求示例

http(s)://[Endpoint]/?Action=CallbackExtension
&ExtensionCode=8abcb91f-d266-4073-b907-2ed670378ed1
&MessageId=03400b03-b721-4c34-8727-2d6884077091
&CheckResult=FAIL
&CheckMessage=命中xxx规则,请修改后重试
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CallbackExtensionResponse>
    <RequestId>7C352CB7-CD88-50CF-9D0D-E81BDF020E7F</RequestId>
    <Success>true</Success>
</CallbackExtensionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈