调用GetBaselineKeyPath获取基线实例的关键路径。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetBaselineKeyPath

要执行的操作。

BaselineId Long 1234

基线的ID。

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

业务日期,需要使用yyyy-MM-dd'T'HH:mm:ssZ的UTC格式。

InGroupId Integer 1

基线实例周期号。天基线为1,小时基线的取值范围为[1,24]。

RegionId String cn-shanghai

可用区的唯一标识。

返回数据

名称 类型 示例值 描述
Data Array

关键路径信息。

Bizdate Long 1553443200000

实例的业务日期时间戳。

InGroupId Integer 1

实例周期号,取值范围为[1,288]。

InstanceId Long 12345

实例的ID。

NodeId Long 1234

节点的ID。

NodeName String 节点名称

节点的名称。

Owner String 9527952****

节点责任人的阿里云UID。

PrgType Integer 10

节点类型,常用的节点类型包括数据集成(23)、MaxCompute SQL(10)、Shell(6)和虚节点(99)。

ProjectId Long 1234

节点所在工作空间的ID。

Runs Array

实例的运行记录。

AbsTime Long 1553531402000

实例的预计开始运行时间+历史平均运行时长得到的时间戳。

BeginCast Long 1553531686000

实例预计开始运行的时间戳。

BeginRunningTime Long 1553531401000

实例实际开始运行的时间戳。

BeginWaitResTime Long 1553531401000

实例开始进入等待资源状态的时间戳。

BeginWaitTimeTime Long 1553531400000

实例开始进入等待时间状态的时间戳。

Bizdate Long 1553443200000

实例的业务日期时间戳。

CycTime Long 1553443200000

实例的定时时间戳。

EndCast Long 1553531687000

实例的预计运行结束时间戳。

FinishTime Long 1553531401000

实例的实际运行结束时间戳。

InGroupId Integer 1

实例周期号,取值范围为[1,288]。

InstanceId Long 1234

实例的ID。

NodeId Long 1234

节点的ID。

NodeName String 节点名称

节点的名称。

Owner String 9527952****

节点责任人的阿里云UID。

ProjectId Long 1234

节点所在工作空间的ID。

Status String SUCCESS

实例的状态,包括NOT_RUN(未运行)、WAIT_TIME(等待时间)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(校检中)、CHECKING_CONDITION(条件检测中)、FAILURE(运行失败)和SUCCESS(运行成功)。

Topics Array

实例关联的事件信息。

AddTime Long 1553531401000

事件发现时间戳。

InstanceId Long 1234

实例的ID。

TopicId Long 1234

事件的ID。

TopicName Long 1234

事件的名称。

ErrorCode String 1031203110005

错误码。

ErrorMessage String The specified parameters are invalid.

错误信息。

HttpStatusCode Integer 200

HTTP返回码。

RequestId String 0000-ABCD-EFG****

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetBaselineKeyPath
&BaselineId=1234
&Bizdate=2020-07-07T00:00:00+0800
&InGroupId=1
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <PrgType>10</PrgType>
    <Owner>9527952****</Owner>
    <InstanceId>1234</InstanceId>
    <NodeName>节点名称</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>节点名称</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>节点名称</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 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": [
        {
            "PrgType": 10,
            "Owner": "9527952****",
            "InstanceId": 1234,
            "NodeName": "节点名称",
            "ProjectId": 1234,
            "NodeId": 1234,
            "Bizdate": 1553443200000,
            "InGroupId": 1
        },
        {
            "Topics": [
                {
                    "Status": "SUCCESS",
                    "Owner": "9527952****",
                    "InstanceId": 1234,
                    "NodeName": "节点名称",
                    "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": "节点名称",
                    "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
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline. 无对应的基线权限。
500 Forbidden.Wkbench.ProjectNoPermission 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服务,请尝试其它地域。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.Wkbench.ServiceError An internal error occurred. 服务开小差了。
500 Invalid.Wkbench.Parameter The specified parameters are invalid. 参数错误。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. 该资源已经达到您的使用上限,请提交工单进行咨询。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 Invalid.Wkbench.BaselineStatusNotExist The BaselineStatus does not exist. 基线实例不存在。

访问错误中心查看更多错误码。