文档

GetBaselineStatus - 获取基线实例的详情

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

名称类型必填描述示例值
BaselineIdlong

基线的 ID。

1234
Bizdatestring

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

2020-07-07T00:00:00+0800
InGroupIdinteger

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

1

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 返回码。

200
RequestIdstring

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

0000-ABCD-EFG****
ErrorMessagestring

错误信息。

The specified parameters are invalid.
ErrorCodestring

错误码。

1031203110005
Successboolean

调用是否成功。

true
Dataobject

基线实例的详情。

Statusstring

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

SAFE
Ownerstring

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

9527952795****
FinishTimelong

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

1553443200000
ProjectIdlong

基线所在工作空间的 ID。

1234
Priorityinteger

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

1
EndCastlong

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

1553443200000
InGroupIdinteger

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

1
BaselineNamestring

基线的名称。

基线名称
BaselineIdlong

基线的 ID。

1234
FinishStatusstring

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

UNFINISH
Bizdatelong

业务日期时间戳。

1553443200000
Bufferfloat

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

1200
SlaTimelong

基线实例的承诺时间戳。

1553443200000
ExpTimelong

基线实例的预警时间戳。

1553443200000
LastInstanceobject

最晚实例信息。

Statusstring

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

SUCCESS
Ownerstring

节点责任人的阿里云 UID。

9527952795****
FinishTimelong

实例的实际完成时间戳。

1553443200000
NodeNamestring

节点的名称。

节点名称
ProjectIdlong

节点所在工作空间的 ID。

1234
InstanceIdlong

实例的 ID。

12345
EndCastlong

实例的预计完成时间戳。

1553443200000
NodeIdlong

节点的 ID。

1234
BlockInstanceobject

关键实例信息。

Statusstring

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

SUCCESS
Ownerstring

节点责任人的阿里云 UID。

9527952795****
FinishTimelong

实例的实际完成时间戳。

1553443200000
NodeNamestring

节点的名称。

节点名称
ProjectIdlong

节点所在工作空间的 ID。

1234
InstanceIdlong

实例的 ID。

12345
EndCastlong

实例的预计完成时间戳。

1553443200000
NodeIdlong

节点的 ID。

1234

示例

正常返回示例

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
    }
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.该地域还未开放DataWorks的API服务,请尝试其它地域。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)