GetBaselineKeyPath - DataWorks - Alibaba Cloud Documentation Center

The information about the events that are associated with the instance.

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
BaselineId	long	Yes	The name of the event.	1234
Bizdate	string	Yes	The ID of the instance.	2020-07-07T00:00:00+0800
InGroupId	integer	Yes	The ID of the event.	1

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The timestamp when the event was found.	200
Data	array<object>	The information about the key path.
Data	object
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	9527952****
NodeName	string	The name of the node.
Bizdate	long	The data timestamp of the instance.	1553443200000
ProjectId	long	The ID of the workspace to which the node belongs.	1234
InstanceId	long	The instance ID.	12345
PrgType	integer	The type of the node. Valid values: 23, 10, 6, and 99. The value 23 indicates that the node is a Data Integration node. The value 10 indicates that the node is a MaxCompute SQL node. The value 6 indicates that the node is a Shell node. The value 99 indicates that the node is a zero load node.	10
NodeId	long	The node ID.	1234
InGroupId	integer	The ID of the scheduling cycle of the instance. Valid values: 1 to 288.	1
Runs	array<object>	The running records of the instance.
Runs	object
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
AbsTime	long	The timestamp obtained by adding the predicted time when the instance started to run to the historical average running duration of the instance.	1553531402000
BeginRunningTime	long	The timestamp of the actual time when the instance started to run.	1553531401000
FinishTime	long	The timestamp of the actual time when the instance finished running.	1553531401000
BeginCast	long	The timestamp of the predicted time when the instance started to run.	1553531686000
EndCast	long	The timestamp of the predicted time when the instance finished running.	1553531687000
BeginWaitResTime	long	The timestamp when the instance started to wait for resources.	1553531401000
BeginWaitTimeTime	long	The timestamp when the instance started to wait for the scheduling time.	1553531400000
Topics	array<object>	The information about the events that are associated with the instance.
Topics	object
TopicName	string	The name of the event.	1234
InstanceId	long	The instance ID.	1234
TopicId	long	The event ID.	1234
AddTime	long	The timestamp when the event was found.	1553531401000

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": [
    {
      "Owner": "9527952****",
      "NodeName": "",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InstanceId": 12345,
      "PrgType": 10,
      "NodeId": 1234,
      "InGroupId": 1,
      "Runs": [
        {
          "Status": "SUCCESS",
          "AbsTime": 1553531402000,
          "BeginRunningTime": 1553531401000,
          "FinishTime": 1553531401000,
          "BeginCast": 1553531686000,
          "EndCast": 1553531687000,
          "BeginWaitResTime": 1553531401000,
          "BeginWaitTimeTime": 1553531400000
        }
      ],
      "Topics": [
        {
          "TopicName": "1234",
          "InstanceId": 1234,
          "TopicId": 1234,
          "AddTime": 1553531401000
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.	-
500	Forbidden.Wkbench.BaselineNoPermission	You are not authorized to access the baseline.	You are not authorized to access the baseline.
500	Forbidden.Wkbench.ProjectNoPermission	You are not authorized to access the workspace.	You are not authorized to access the workspace.
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	Invalid.Wkbench.BaselineStatusNotExist	The BaselineStatus does not exist.	The BaselineStatus does not exist.

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

Change history

Change time	Summary of changes	Operation
2023-03-16	The Error code has changed. The response structure of the API has changed	View Change Details