调用GetBaselineStatus获取基线实例的详情。

调试

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

请求参数

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

系统规定参数。取值:GetBaselineStatus

BaselineId Long 1234

基线的ID。

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

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

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 Object

基线实例的详情。

Status String SAFE

基线的状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。

Owner String 9527952795****

基线责任人的阿里云UID。多个责任人之间使用英文逗号(,)分隔。

FinishTime Long 1553443200000

当FinishStatus(基线实例完成状态)为FINISH(已完成)时,返回基线实例的完成时间戳。

ProjectId Long 1234

基线所在工作空间的ID。

Priority Integer 1

基线的优先级,取值范围为{1,2,5,7,8}。

EndCast Long 1553443200000

基线实例的预计产出时间戳。

InGroupId Integer 1

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

BaselineName String 基线名称

基线的名称。

BaselineId Long 1234

基线的ID。

FinishStatus String UNFINISH

基线实例是否完成,包括UNFINISH(未完成)和FINISH(已完成)。

Bizdate Long 1553443200000

业务日期时间戳。

Buffer Float 1200

基线实例的余量,单位为秒。

SlaTime Long 1553443200000

基线实例的承诺时间戳。

ExpTime Long 1553443200000

基线实例的预警时间戳。

LastInstance Object

最晚实例信息。

Status String SUCCESS

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

Owner String 9527952795****

节点责任人的阿里云UID。

FinishTime Long 1553443200000

实例的实际完成时间戳。

NodeName String 节点名称

节点的名称。

ProjectId Long 1234

节点所在工作空间的ID。

InstanceId Long 12345

实例的ID。

EndCast Long 1553443200000

实例的预计完成时间戳。

NodeId Long 1234

节点的ID。

BlockInstance Object

关键实例信息。

Status String SUCCESS

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

Owner String 9527952795****

节点责任人的阿里云UID。

FinishTime Long 1553443200000

实例的实际完成时间戳。

NodeName String 节点名称

节点的名称。

ProjectId Long 1234

节点所在工作空间的ID。

InstanceId Long 12345

实例的ID。

EndCast Long 1553443200000

实例的预计完成时间戳。

NodeId Long 1234

节点的ID。

示例

请求示例

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

正常返回示例

XML格式

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

<GetBaselineStatusResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <Status>SAFE</Status>
        <Owner>9527952795****</Owner>
        <FinishTime>1553443200000</FinishTime>
        <ProjectId>1234</ProjectId>
        <Priority>1</Priority>
        <EndCast>1553443200000</EndCast>
        <InGroupId>1</InGroupId>
        <BaselineName>基线名称</BaselineName>
        <BaselineId>1234</BaselineId>
        <FinishStatus>UNFINISH</FinishStatus>
        <Bizdate>1553443200000</Bizdate>
        <Buffer>1200</Buffer>
        <SlaTime>1553443200000</SlaTime>
        <ExpTime>1553443200000</ExpTime>
        <LastInstance>
            <Status>SUCCESS</Status>
            <Owner>9527952795****</Owner>
            <FinishTime>1553443200000</FinishTime>
            <NodeName>节点名称</NodeName>
            <ProjectId>1234</ProjectId>
            <InstanceId>12345</InstanceId>
            <EndCast>1553443200000</EndCast>
            <NodeId>1234</NodeId>
        </LastInstance>
        <BlockInstance>
            <Status>SUCCESS</Status>
            <Owner>9527952795****</Owner>
            <FinishTime>1553443200000</FinishTime>
            <NodeName>节点名称</NodeName>
            <ProjectId>1234</ProjectId>
            <InstanceId>12345</InstanceId>
            <EndCast>1553443200000</EndCast>
            <NodeId>1234</NodeId>
        </BlockInstance>
    </Data>
</GetBaselineStatusResponse>

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" : {
    "Status" : "SAFE",
    "Owner" : "9527952795****",
    "FinishTime" : 1553443200000,
    "ProjectId" : 1234,
    "Priority" : 1,
    "EndCast" : 1553443200000,
    "InGroupId" : 1,
    "BaselineName" : "基线名称",
    "BaselineId" : 1234,
    "FinishStatus" : "UNFINISH",
    "Bizdate" : 1553443200000,
    "Buffer" : 1200,
    "SlaTime" : 1553443200000,
    "ExpTime" : 1553443200000,
    "LastInstance" : {
      "Status" : "SUCCESS",
      "Owner" : "9527952795****",
      "FinishTime" : 1553443200000,
      "NodeName" : "节点名称",
      "ProjectId" : 1234,
      "InstanceId" : 12345,
      "EndCast" : 1553443200000,
      "NodeId" : 1234
    },
    "BlockInstance" : {
      "Status" : "SUCCESS",
      "Owner" : "9527952795****",
      "FinishTime" : 1553443200000,
      "NodeName" : "节点名称",
      "ProjectId" : 1234,
      "InstanceId" : 12345,
      "EndCast" : 1553443200000,
      "NodeId" : 1234
    }
  }
}

错误码

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.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. 系统内部错误,请稍后再试。

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