Use ListSuccessInstanceAmount to query the trend of successfully run auto triggered instances - DataWorks - Alibaba Cloud - DataWorks

Retrieves the trend of successfully completed instance counts at different hours on the business date for periodic instances generated on that date.

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 ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID.	9527

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	952795279527ab****
InstanceStatusTrend	object	The trend data of successfully completed instance counts at different hours on the business date.
TodayTrend	array<object>	The trend for the current business date.
	object	The response struct.
TimePoint	string	The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.	01:00
Count	integer	The number of instances that are successfully run.	10
YesterdayTrend	array<object>	The trend for the day before the business date.
	object	The response struct.
TimePoint	string	The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.	01:00
Count	integer	The number of instances that are successfully run.	10
AvgTrend	array<object>	The historical average trend.
	object	The response struct.
TimePoint	string	The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.	01:00
Count	integer	The number of instances that are successfully run.	10

Examples

Success response

JSON format

{
  "RequestId": "952795279527ab****",
  "InstanceStatusTrend": {
    "TodayTrend": [
      {
        "TimePoint": "01:00",
        "Count": 10
      }
    ],
    "YesterdayTrend": [
      {
        "TimePoint": "01:00",
        "Count": 10
      }
    ],
    "AvgTrend": [
      {
        "TimePoint": "01:00",
        "Count": 10
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	Forbidden.Wkbench.ProjectNoPermission	You are not authorized to access the workspace.
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.