UpdateIDEEventResult

Updated at:

Returns the check result of an extension point event to Data Studio after the extension point event is triggered during data development and checked by an extension.

Operation description

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:*

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

MessageId

string

No

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

For the message format, see Message format.

8abcb91f-d266-4073-b907-2ed670378ed1

ExtensionCode

string

No

The unique identifier 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 identifier.

8abcb91f-d266-4073-b907-2ed670378ed1

CheckResult

string

No

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 warning is reported.

OK

CheckResultTip

string

No

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

Succeeded

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

8abcb91f-d266-4073-b907-2ed670378ed1

Examples

Success response

JSON format

{
  "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.
500 InternalError.System An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. No permission, please authorize
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.