Call GetBaselineKeyPath get embedded in the baseline instance of critical path.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required GetBaselineKeyPath

The operation that you want to perform.

BaselineId Long Yes 1234

The ID of the baseline.

Bizdate String Required 2020-07-07T00:00:00+0800

Business date in the yyyy-MM-dd'T'HH:mm:ssZ UTC format.

InGroupId Integer Yes 1

The cycle number of the baseline instance. The Tianji line is 1. The value range of the hour baseline is [1,24].

RegionId String Required cn-shanghai

The unique identifier of the zone.

Response parameters

Parameter Type Example Description
Data Array

The critical path information.

Bizdate Long 1553443200000

The date-based timestamp of the database instance.

InGroupId Integer 1

The cycle number of the instance. Valid values: 1 to 288.

InstanceId Long 12345

The ID of the instance.

NodeId Long 1234

The ID of the node.

NodeName String The name of the node

The name of the node.

Owner String 9527952****

The UID of the node owner.

PrgType Integer 10

The type of the node. Common node types include data integration (23), MaxCompute SQL(10), Shell(6), and virtual node (99).

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Runs Array

The running records of the instance.

AbsTime Long 1553531402000

The timestamp obtained by the estimated running time of the instance + average running time of the instance.

BeginCast Long 1553531686000

The timestamp when the instance is expected to start running.

BeginRunningTime Long 1553531401000

The timestamp when the instance starts to run.

BeginWaitResTime Long 1553531401000

The timestamp when the instance enters the waiting for resources state.

BeginWaitTimeTime Long 1553531400000

The timestamp when the instance enters the wait time state.

Bizdate Long 1553443200000

The date-based timestamp of the database instance.

CycTime Long 1553443200000

The timestamp of the instance.

EndCast Long 1553531687000

The estimated end time of the instance.

FinishTime Long 1553531401000

The end time of the operation performed on the instance.

InGroupId Integer 1

The cycle number of the instance. Valid values: 1 to 288.

InstanceId Long 1234

The ID of the instance.

NodeId Long 1234

The ID of the node.

NodeName String The name of the node

The name of the node.

Owner String 9527952****

The UID of the node owner.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Status String SUCCESS

The status of an instance, including NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS.

Topics Array

The event information associated with the instance.

AddTime Long 1553531401000

The time when the event was discovered.

InstanceId Long 1234

The ID of the instance.

TopicId Long 1234

The ID of the event.

TopicName Long 1234

The name of the event.

ErrorCode String 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetBaselineKeyPath
&BaselineId=1234
&Bizdate=2020-07-07T00:00:00+0800
&InGroupId=1
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <PrgType>10</PrgType>
    <Owner>9527952****</Owner>
    <InstanceId>1234</InstanceId>
    <NodeName> node name </NodeName>
    <ProjectId>1234</ProjectId>
    <NodeId>1234</NodeId>
    <Bizdate>1553443200000</Bizdate>
    <InGroupId>1</InGroupId>
</Data>
<Data>
    <Topics>
        <Status>SUCCESS</Status>
        <Owner>9527952****</Owner>
        <InstanceId>1234</InstanceId>
        <NodeName> node name </NodeName>
        <ProjectId>1234</ProjectId>
        <BeginWaitTimeTime>1553531400000</BeginWaitTimeTime>
        <CycTime>1553443200000</CycTime>
        <BeginRunningTime>1553531401000</BeginRunningTime>
        <Bizdate>1553443200000</Bizdate>
        <InGroupId>1</InGroupId>
        <BeginCast>1553531686000</BeginCast>
        <AbsTime>1553531402000</AbsTime>
        <FinishTime>1553531401000</FinishTime>
        <NodeId>9527</NodeId>
        <BeginWaitResTime>1553531401000</BeginWaitResTime>
        <EndCast>1553531687000</EndCast>
    </Topics>
    <Topics>
        <InstanceId>1234</InstanceId>
        <TopicId>1234</TopicId>
        <AddTime>1553531401000</AddTime>
        <TopicName>1234</TopicName>
    </Topics>
    <Runs>
        <Status>SUCCESS</Status>
        <Owner>9527952****</Owner>
        <InstanceId>1234</InstanceId>
        <NodeName> node name </NodeName>
        <ProjectId>1234</ProjectId>
        <BeginWaitTimeTime>1553531400000</BeginWaitTimeTime>
        <CycTime>1553443200000</CycTime>
        <BeginRunningTime>1553531401000</BeginRunningTime>
        <Bizdate>1553443200000</Bizdate>
        <InGroupId>1</InGroupId>
        <BeginCast>1553531686000</BeginCast>
        <AbsTime>1553531402000</AbsTime>
        <FinishTime>1553531401000</FinishTime>
        <NodeId>1234</NodeId>
        <BeginWaitResTime>1553531401000</BeginWaitResTime>
        <EndCast>1553531687000</EndCast>
    </Runs>
    <Runs>
        <InstanceId>1234</InstanceId>
        <TopicId>1234</TopicId>
        <AddTime>1553531401000</AddTime>
        <TopicName>1234</TopicName>
    </Runs>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid. </ErrorMessage>
<Success>true</Success>

JSON format

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

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline. No baseline permissions exist.
500 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace. You have no permission to use a workspace.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. DataWorks API service is not available in this region. Please try another region.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The service was open.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The parameters are invalid.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The number of resources has reached the upper limit. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
500 Invalid.Wkbench.BaselineStatusNotExist The BaselineStatus does not exist. The specified baseline instance does not exist.

For a list of error codes, visit the API Error Center.