GetBaselineKeyPath

Updated at:

Retrieves the critical path 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 business date in the yyyy-MM-dd'T'HH:mm:ssZ UTC format.

2020-07-07T00:00:00+0800

InGroupId

integer

Yes

The cycle number of the baseline instance. The value is 1 for a daily baseline. Valid values for an hourly baseline: [1,24].

1

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The unique ID of the request. You can use this ID to troubleshoot issues.

0000-ABCD-EFG****

ErrorMessage

string

The error message.

The specified parameters are invalid.

ErrorCode

string

The error code.

1031203110005

Success

boolean

Indicates whether the request was successful.

true

Data

array<object>

The critical path information.

array<object>

Owner

string

The Alibaba Cloud UID of the node owner.

9527952****

NodeName

string

The name of the node.

Node name

Bizdate

integer

The timestamp of the business date of the instance.

1553443200000

ProjectId

integer

The ID of the workspace to which the node belongs.

1234

InstanceId

integer

The ID of the instance.

123456

PrgType

integer

The node type. Common node types include Data Integration (23), MaxCompute SQL (10), Shell (6), and virtual node (99).

10

NodeId

integer

The ID of the node.

1234

InGroupId

integer

The cycle number of the instance. Valid values: [1,288].

1

Runs

array<object>

The run records of the instance.

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

integer

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

integer

The timestamp of the actual time when the instance started to run.

1553531401000

FinishTime

integer

The timestamp of the actual time when the instance finished running.

1553531401000

BeginCast

integer

The timestamp of the predicted time when the instance started to run.

1553531686000

EndCast

integer

The timestamp of the predicted time when the instance finished running.

1553531687000

BeginWaitResTime

integer

The timestamp when the instance started to wait for resources.

1553531401000

BeginWaitTimeTime

integer

The timestamp when the instance started to wait for the scheduling time.

1553531400000

Topics

array<object>

The event information associated with the instance.

object

TopicName

string

The name of the event.

1234

InstanceId

integer

The instance ID.

1234

TopicId

integer

The event ID.

1234

AddTime

integer

The timestamp when the event was found.

1553531401000

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": [
    {
      "Owner": "9527952****",
      "NodeName": "Node name",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InstanceId": 123456,
      "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

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