Query baseline instance details with GetBaselineStatus - DataWorks - Alibaba Cloud - DataWorks

Retrieves the status of a baseline instance.

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
BaselineId	integer	Yes	The ID of the baseline.	1234
Bizdate	string	Yes	The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC.	2020-07-07T00:00:00+0800
InGroupId	integer	Yes	The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.	1

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The ID of the request. You can use the ID to troubleshoot issues.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The specified parameters are invalid.
ErrorCode	string	The error code returned.	1031203110005
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the baseline instance.
Status	string	The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time.	SAFE
Owner	string	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).	9527952795****
FinishTime	integer	The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.	1553443200000
ProjectId	integer	The ID of the workspace to which the baseline belongs.	1234
Priority	integer	The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.	1
EndCast	integer	The timestamp of the predicted time when the baseline instance finished running.	1553443200000
InGroupId	integer	The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.	1
BaselineName	string	The name of the baseline.	Baseline name
BaselineId	integer	The ID of the baseline.	1234
FinishStatus	string	The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running.	UNFINISH
Bizdate	integer	The data timestamp of the baseline instance.	1553443200000
Buffer	number	The margin of the baseline instance. Unit: seconds.	1200
SlaTime	integer	The timestamp of the committed completion time of the baseline instance.	1553443200000
ExpTime	integer	The timestamp of the alerting time of the baseline instance.	1553443200000
LastInstance	object	The information about the last generated instance.
Status	string	The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.	SUCCESS
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	9527952795****
FinishTime	integer	The timestamp of the actual time when the instance finished running.	1553443200000
NodeName	string	The name of the node.	Node name
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
InstanceId	integer	The ID of the instance.	12345
EndCast	integer	The timestamp of the predicted time when the instance finished running.	1553443200000
NodeId	integer	The ID of the node.	1234
BlockInstance	object	The information about the key instance.
Status	string	The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.	SUCCESS
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	9527952795****
FinishTime	integer	The timestamp of the actual time when the instance finished running.	1553443200000
NodeName	string	The name of the node.	Node name
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
InstanceId	integer	The ID of the instance.	12345
EndCast	integer	The timestamp of the predicted time when the instance finished running.	1553443200000
NodeId	integer	The ID of the node.	1234

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "Status": "SAFE",
    "Owner": "9527952795****",
    "FinishTime": 1553443200000,
    "ProjectId": 1234,
    "Priority": 1,
    "EndCast": 1553443200000,
    "InGroupId": 1,
    "BaselineName": "Baseline name",
    "BaselineId": 1234,
    "FinishStatus": "UNFINISH",
    "Bizdate": 1553443200000,
    "Buffer": 1200,
    "SlaTime": 1553443200000,
    "ExpTime": 1553443200000,
    "LastInstance": {
      "Status": "SUCCESS",
      "Owner": "9527952795****",
      "FinishTime": 1553443200000,
      "NodeName": "Node name",
      "ProjectId": 1234,
      "InstanceId": 12345,
      "EndCast": 1553443200000,
      "NodeId": 1234
    },
    "BlockInstance": {
      "Status": "SUCCESS",
      "Owner": "9527952795****",
      "FinishTime": 1553443200000,
      "NodeName": "Node name",
      "ProjectId": 1234,
      "InstanceId": 12345,
      "EndCast": 1553443200000,
      "NodeId": 1234
    }
  }
}

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.
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.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.