GetInstanceStatusStatistic-DataWorks(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

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

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	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 (production environment) and DEV (development environment).	PROD
BizDate	string	Yes	The business date for which to retrieve the number of instances in each state. 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 manual task 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 business flow workflow	MANUAL
SchedulerPeriod	string	No	The scheduling cycle. Valid values: MINUTE: minute. HOUR: hour. DAY: day. WEEK: week. MONTH: 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 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

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.