Returns the check result of an extension point event to DataStudio after the extension point event is triggered and an extension checks the extension point event.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateIDEEventResult

The operation that you want to perform.

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

The ID of the message. You can obtain the ID from the received message when the extension point event is triggered.

RegionId String No cn-zhangjiakou

The ID of the region in which the DataWorks workspace resides. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

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

The ID of the extension. You can log on to the DataWorks console and go to the Extensions tab of the Open Platform page to view the ID.

CheckResult String No OK

The check status of the extension point event. Valid values:

  • OK: The event passes the check.
  • FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.
  • WARN: The event passes the check, but an alert is reported.
CheckResultTip String No Succeeded

The summary information of the check result. The information is displayed in DataStudio. If an alert is reported or the event fails the check, you can troubleshoot errors based on the information.

Response parameters

Parameter Type Example Description
RequestId String 8abcb91f-d266-4073-b907-2ed670378ed1

The ID of the request. You can troubleshoot errors based on the ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateIDEEventResult
&MessageId=8abcb91f-d266-4073-b907-2ed670378ed1
&ExtensionCode=8abcb91f-d266-4073-b907-2ed670378ed1
&CheckResult=OK
&CheckResultTip=Succeeded
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

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

Error codes

HTTP status code Error code Error message Description
400 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.