Use CallbackExtension to send extension point event results - DataWorks - Alibaba Cloud - DataWorks

Returns the check result of an extension program for an extension point event to the DataWorks platform by calling the CallbackExtension operation when an extension point is triggered during the use of the DataWorks platform.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExtensionCode	string	Yes	The unique code of the extension program.	8abcb91f-d266-4073-b907-2****
MessageId	string	Yes	The message ID of the DataWorks open message. After an extension point event is triggered, you can obtain the message ID from the received event message.	034********091
CheckResult	string	Yes	The check status of the extension program for the extension point event. Valid values: OK: The extension program check for the extension point event passed. FAIL: The extension program check for the extension point event failed. View and resolve the error promptly to avoid affecting the normal execution of subsequent programs. WARN: The extension program check for the extension point event passed, but warnings exist. Valid values: OK : The check passed. FAIL : The check failed. WARN : The check passed but warnings exist.	FAIL
CheckMessage	string	No	The reason for the failure when CheckResult is set to FAIL.	The xxx rule is hit. Modify it and try again.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7C352CB7-CD88-50CF-9D0D-E81BDF020E7F
Success	string	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.