Use GetInstanceStatusStatistic to query the number of instances in each state - DataWorks - Alibaba Cloud - DataWorks

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	Yes	The DataWorks workspace ID. You can obtain the ID on the Workspace page of the DataWorks console.	1234
ProjectEnv	string	Yes	The runtime environment. Valid values: PROD and DEV.	PROD
BizDate	string	Yes	The business date for which to query instance status statistics. Format: yyyy-MM-dd.	2020-01-01
SchedulerType	string	No	The scheduling type of the node. Valid values: NORMAL: auto triggered node MANUAL: manually triggered node PAUSE: paused node SKIP: dry-run node	NORMAL
DagType	string	No	The type of the directed acyclic graph (DAG). Valid values: MANUAL: DAG for a manually triggered workflow SMOKE_TEST: DAG for a smoke testing workflow SUPPLY_DATA: DAG for a data backfill instance BUSINESS_PROCESS_DAG: DAG for a one-time workflow DAILY MANUAL SMOKE_TEST SUPPLY_DATA BUSINESS_PROCESS_DAG	MANUAL
SchedulerPeriod	string	No	The scheduling cycle. Valid values: MINUTE HOUR DAY WEEK MONTH	DAY

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0000-ABCD-EFG****
StatusCount	object	The numbers of instances in different states.
FailureCount	integer	The number of instances that failed to run.	1
WaitTimeCount	integer	The number of instances that are waiting to run.	1
RunningCount	integer	The number of instances that are running.	1
SuccessCount	integer	The number of instances that ran successfully.	1
TotalCount	integer	The total number of instances returned.	1
NotRunCount	integer	The number of instances that have not run.	1
WaitResCount	integer	The number of instances that are waiting for resources.	1

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EFG****",
  "StatusCount": {
    "FailureCount": 1,
    "WaitTimeCount": 1,
    "RunningCount": 1,
    "SuccessCount": 1,
    "TotalCount": 1,
    "NotRunCount": 1,
    "WaitResCount": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.