CallbackExtension - 返回扩展程序对扩展点事件的检查结果

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

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"
}

错误码

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

变更历史

更多信息,参考变更详情