调用GetBaselineKeyPath获取基线实例的关键路径。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetBaselineKeyPath | 系统规定参数。取值: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]。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 | HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** | 本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
ErrorMessage | String | The specified parameters are invalid. | 错误信息。 |
ErrorCode | String | 1031203110005 | 错误码。 |
Success | Boolean | true | 调用是否成功。 |
Data | Array of Data | 关键路径信息。 |
|
Owner | String | 9527952**** | 节点责任人的阿里云UID。 |
NodeName | String | 节点名称 | 节点的名称。 |
Bizdate | Long | 1553443200000 | 实例的业务日期时间戳。 |
ProjectId | Long | 1234 | 节点所在工作空间的ID。 |
InstanceId | Long | 12345 | 实例的ID。 |
PrgType | Integer | 10 | 节点类型,常用的节点类型包括数据集成(23)、MaxCompute SQL(10)、Shell(6)和虚节点(99)。 |
NodeId | Long | 1234 | 节点的ID。 |
InGroupId | Integer | 1 | 实例周期号,取值范围为[1,288]。 |
Runs | Array of Runs | 实例的运行记录。 |
|
Status | String | SUCCESS | 实例的状态,包括NOT_RUN(未运行)、WAIT_TIME(等待时间)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(校检中)、CHECKING_CONDITION(条件检测中)、FAILURE(运行失败)和SUCCESS(运行成功)。 |
AbsTime | Long | 1553531402000 | 实例的预计开始运行时间+历史平均运行时长得到的时间戳。 |
BeginRunningTime | Long | 1553531401000 | 实例实际开始运行的时间戳。 |
CycTime | Long | 1553443200000 | 实例的定时时间戳。 |
Owner | String | 9527952**** | 节点责任人的阿里云UID。 |
FinishTime | Long | 1553531401000 | 实例的实际运行结束时间戳。 |
ProjectId | Long | 1234 | 节点所在工作空间的ID。 |
BeginCast | Long | 1553531686000 | 实例预计开始运行的时间戳。 |
InstanceId | Long | 1234 | 实例的ID。 |
EndCast | Long | 1553531687000 | 实例的预计运行结束时间戳。 |
BeginWaitResTime | Long | 1553531401000 | 实例开始进入等待资源状态的时间戳。 |
InGroupId | Integer | 1 | 实例周期号,取值范围为[1,288]。 |
NodeName | String | 节点名称 | 节点的名称。 |
Bizdate | Long | 1553443200000 | 实例的业务日期时间戳。 |
BeginWaitTimeTime | Long | 1553531400000 | 实例开始进入等待时间状态的时间戳。 |
NodeId | Long | 1234 | 节点的ID。 |
Topics | Array of Topics | 实例关联的事件信息。 |
|
TopicName | Long | 1234 | 事件的名称。 |
InstanceId | Long | 1234 | 实例的ID。 |
TopicId | Long | 1234 | 事件的ID。 |
AddTime | Long | 1553531401000 | 事件发现时间戳。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetBaselineKeyPath
&BaselineId=1234
&Bizdate=2020-07-07T00:00:00+0800
&InGroupId=1
&公共请求参数
正常返回示例
XML
格式
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>节点名称</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>节点名称</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
格式
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" : "节点名称",
"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" : "节点名称",
"Bizdate" : 1553443200000,
"BeginWaitTimeTime" : 1553531400000,
"NodeId" : 1234
},
"Topics" : {
"TopicName" : 1234,
"InstanceId" : 1234,
"TopicId" : 1234,
"AddTime" : 1553531401000
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
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 | Invalid.Wkbench.BaselineStatusNotExist | The BaselineStatus does not exist. | 基线实例不存在。 |
访问错误中心查看更多错误码。