用于在数据开发过程中触发扩展点时,通过调用UpdateIDEEventResult接口,将扩展程序对扩展点事件的检查结果返回给DataWorks的数据开发系统。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateIDEEventResult

要执行的操作。

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

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

RegionId String cn-zhangjiakou

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

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

扩展程序的唯一标识。您可以登录DataWorks控制台,进入开放平台的Extensions页签查看标识。

CheckResult String OK

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

  • OK:扩展程序对本次扩展点事件检查通过。
  • FAIL:扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错,以免影响后续程序的正常执行。
  • WARN:扩展程序对本次扩展点事件检查通过,但存在警告。
CheckResultTip String Succeeded

扩展程序对本次扩展点事件进行检查的摘要信息。该信息会显示在您当前的开发页面上,当本次检查存在警告或者检查不通过时,您可以通过该摘要信息快速定位原因。

返回数据

名称 类型 示例值 描述
RequestId String 8abcb91f-d266-4073-b907-2ed670378ed1

请求的唯一标识,用于后续错误排查使用。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateIDEEventResult
&MessageId=8abcb91f-d266-4073-b907-2ed670378ed1
&ExtensionCode=8abcb91f-d266-4073-b907-2ed670378ed1
&CheckResult=OK
&CheckResultTip=Succeeded
&公共请求参数

正常返回示例

XML格式

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

<UpdateIDEEventResultResponse>
    <RequestId>8abcb91f-d266-4073-b907-2ed670378ed1</RequestId>
</UpdateIDEEventResultResponse>

JSON格式

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

{
  "RequestId" : "8abcb91f-d266-4073-b907-2ed670378ed1"
}

错误码

HttpCode 错误码 错误信息 描述
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. 您被限制访问,请开通DataWorks企业版或旗舰版。
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. 系统内部错误,请稍后再试。

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