GetBaselineKeyPath -

Queries the key path of a baseline instance.

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	Yes	GetBaselineKeyPath	The operation that you want to perform. Set the value to GetBaselineKeyPath.
BaselineId	Long	Yes	1234	The baseline ID.
Bizdate	String	Yes	2020-07-07T00:00:00+0800	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.
InGroupId	Integer	Yes	1	The ID of the 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.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	0000-ABCD-EFG****	The request ID.
ErrorMessage	String	The specified parameters are invalid.	The error message.
ErrorCode	String	1031203110005	The error code.
Success	Boolean	true	Indicates whether the request was successful.
Data	Array of Data		The information about the key path.
Owner	String	9527952****	The ID of the Alibaba Cloud account used by the node owner.
NodeName	String	Node name	The name of the node.
Bizdate	Long	1553443200000	The data timestamp of the baseline instance.
ProjectId	Long	1234	The ID of the workspace to which the node belongs.
InstanceId	Long	12345	The instance ID.
PrgType	Integer	10	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.
NodeId	Long	1234	The node ID.
InGroupId	Integer	1	The ID of the cycle of the baseline instance. Valid values: 1 to 288.
Runs	Array of Runs		The information about the baseline instance that was run.
Status	String	SUCCESS	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 node. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.
AbsTime	Long	1553531402000	The timestamp obtained by combining the predicted time when the baseline instance started to run with the historical average duration for which the baseline instance was running.
BeginRunningTime	Long	1553531401000	The timestamp of the actual time when the baseline instance started to run.
FinishTime	Long	1553531401000	The timestamp of the actual time when the baseline instance stopped running.
BeginCast	Long	1553531686000	The timestamp of the predicted time when the baseline instance started to run.
EndCast	Long	1553531687000	The timestamp of the predicted time when the baseline instance stopped running.
BeginWaitResTime	Long	1553531401000	The timestamp when the baseline instance started to wait for resources.
BeginWaitTimeTime	Long	1553531400000	The timestamp when the baseline instance started to wait to be run.
Topics	Array of Topics		The information about the events that are associated with the baseline instance.
TopicName	String	1234	The name of the event.
InstanceId	Long	1234	The instance ID.
TopicId	Long	1234	The event ID.
AddTime	Long	1553531401000	The timestamp when the event was found.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : 12345,
    "PrgType" : 10,
    "NodeId" : 1234,
    "InGroupId" : 1,
    "Runs" : {
      "Status" : "SUCCESS",
      "AbsTime" : 1553531402000,
      "BeginRunningTime" : 1553531401000,
      "CycTime" : 1553443200000,
      "Owner" : "9527952****",
      "FinishTime" : 1553531401000,
      "ProjectId" : 1234,
      "BeginCast" : 1553531686000,
      "InstanceId" : 1234,
      "EndCast" : 1553531687000,
      "BeginWaitResTime" : 1553531401000,
      "InGroupId" : 1,
      "NodeName" : "Node name",
      "Bizdate" : 1553443200000,
      "BeginWaitTimeTime" : 1553531400000,
      "NodeId" : 1234
    },
    "Topics" : {
      "TopicName" : 1234,
      "InstanceId" : 1234,
      "TopicId" : 1234,
      "AddTime" : 1553531401000
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
429	Throttling.Api	The request for this resource has exceeded your available limit.	The number of requests for the resource has exceeded the upper limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	The number of requests per day for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	Excessive requests have been submitted within a short period of time. Try again later.
500	Forbidden.Wkbench.BaselineNoPermission	You are not authorized to access the baseline.	You are not authorized to access the specified 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.	DataWorks API is unavailable in this region. Try another region.
500	InternalError.System	An internal system error occurred. Try again later.	An internal error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error occurred. Try again later.
500	Invalid.Wkbench.BaselineStatusNotExist	The BaselineStatus does not exist.	The baseline instance is not found.

For a list of error codes, see Service error codes.