ListCheckProcesses-DataWorks(DataWorks)-阿里云帮助中心

Queries the check list of extension events.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The ID of the workspace.	123465
EventCode	string	Yes	The event code of the extension point.	commit-file
Operator	string	No	The ID of the operator.	123333
PageSize	integer	No	The number of entries per page in a paged query. This parameter is used for paging.	10
PageNumber	integer	No	The page number in a paged query. This parameter is used for paging. Default value: 1.	1
Status	string	No	The check status of the extension. Valid values: CHECKING: The check is in progress. PASSED: The check is passed. BLOCKED: The check is not passed. Valid values: BLOCKED : The check is not passed. CHECKING : The check is in progress. PASSED : The check is passed.	True
MessageId	string	No	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. For the message format, refer to Message format.	03400b03-b721-4c34-8727-2****1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	0000-ABCD-EF****
PagingInfo	object	The pagination information.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	12
CheckProcesses	array<object>	The details of the extension check processes.
	object
ProjectId	integer	The ID of the DataWorks workspace.	32563
Status	string	The check status of the extension. Valid values: CHECKING: The check is in progress. PASSED: The check is passed. BLOCKED: The check is not passed.	CHECKING
EventCode	string	The event code of the extension point.	commit-file
EventName	string	The name of the extension point event.	DnsEvent
EventNameEn	string	The English name of the event.	Pre-event for Node Commit
ProcessName	string	The name of the operation object, such as the file name or node name.	odps_sql_test
MessageId	string	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.	b824a5de-4223-4315-af3e-c4449d236db4
ProcessId	string	The process instance ID.	rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203
Operator	string	The ID of the operator.	297635

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EF****",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 12,
    "CheckProcesses": [
      {
        "ProjectId": 32563,
        "Status": "CHECKING",
        "EventCode": "commit-file",
        "EventName": "DnsEvent",
        "EventNameEn": "Pre-event for Node Commit",
        "ProcessName": "odps_sql_test",
        "MessageId": "b824a5de-4223-4315-af3e-c4449d236db4",
        "ProcessId": "rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203",
        "Operator": "297635"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.