GetInstanceStatusStatistic - DataWorks - Alibaba Cloud Documentation Center

Queries the number of instances that are in each state.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	1234
ProjectEnv	string	Yes	The runtime environment. Valid values: PROD and DEV.	PROD
BizDate	string	Yes	The date on which the numbers of instances in different states are obtained. Specify the date in the yyyy-MM-dd format.	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 parameters

Parameter	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 are successfully run.	1
TotalCount	integer	The total number of instances returned.	1
NotRunCount	integer	The number of instances that are not run.	1
WaitResCount	integer	The number of instances that are waiting for resources.	1

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-07	The request parameters of the API has changed	View Change Details