Queries the number of instances that are in each state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetInstanceStatusStatistic

The operation that you want to perform. Set the value to GetInstanceStatusStatistic.

ProjectId Long Yes 1234

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.

ProjectEnv String Yes PROD

The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.

BizDate String Yes 2020-01-01

The date on which the numbers of instances in different states are obtained. Specify the date in the yyyy-MM-dd format.

SchedulerType String No NORMAL

The scheduling type of the node. Valid values:

  • NORMAL: auto triggered node
  • MANUAL: manually triggered node
  • PAUSE: paused node
  • SKIP: dry-run node
DagType String No MANUAL

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

Response parameters

Parameter Type Example Description
RequestId String 0000-ABCD-EFG****

The ID of the request. You can use the ID to search for logs and troubleshoot issues based on the logs.

StatusCount Object

The numbers of instances in different states.

FailureCount Integer 1

The number of instances that failed to run.

WaitTimeCount Integer 1

The number of instances that are waiting to run.

RunningCount Integer 1

The number of instances that are running.

SuccessCount Integer 1

The number of instances that are successfully run.

TotalCount Integer 1

The total number of instances.

NotRunCount Integer 1

The number of instances that are not run.

WaitResCount Integer 1

The number of instances that are waiting for resources.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetInstanceStatusStatistic
&ProjectId=1234
&ProjectEnv=PROD
&BizDate=2020-01-01
&SchedulerType=NORMAL
&DagType=MANUAL
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetInstanceStatusStatisticResponse>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <StatusCount>
        <FailureCount>1</FailureCount>
        <WaitTimeCount>1</WaitTimeCount>
        <RunningCount>1</RunningCount>
        <SuccessCount>1</SuccessCount>
        <TotalCount>1</TotalCount>
        <NotRunCount>1</NotRunCount>
        <WaitResCount>1</WaitResCount>
    </StatusCount>
</GetInstanceStatusStatisticResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.