ListBaselineStatuses - 获取基线实例列表

更新时间:
复制 MD 格式

调用ListBaselineStatuses获取基线实例列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页的页数。默认值为 1,最小值为 1,最大值为 30。

1

PageSize

integer

每页显示的条数,默认值为 10,最大值为 100。

10

Bizdate

string

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

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

Priority

string

基线的优先级,取值范围为{1,3,5,7,8}。多个优先级之间使用英文逗号(,)分隔。

1,3,5,7,8

SearchText

string

搜索关键字,支持基线名称和基线 ID,如果输入小时基线 ID,则会返回该小时基线所有实例。

关键词

Owner

string

基线责任人的阿里云 UID。

9527952795****

TopicId

integer

相关事件的 ID。

1234

FinishStatus

string

基线实例是否完成,包括 UNFINISH(未完成)、FINISH(已完成)。多个状态之间使用英文逗号(,)分隔。

FINISH,UNFINISH

Status

string

基线的状态,包括 ERROR(异常)、SAFE(安全)、DANGROUS(预警)和 OVER(破线)。多个状态之间使用英文逗号(,)分隔。

SAFE,DANGROUS,OVER

BaselineTypes

string

基线的类型,包括 DAILY(天基线)和 HOURLY(小时基线)。多个类型之间使用英文逗号(,)分隔。

DAILY,HOURLY

返回参数

名称

类型

描述

示例值

object

返回数据。

HttpStatusCode

integer

HTTP 返回码。

200

RequestId

string

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

0000-ABCD-EFG****

ErrorMessage

string

错误信息。

The specified parameters are invalid.

ErrorCode

string

错误码。

Invalid.Tenant.ConnectionNotExists

Success

boolean

调用是否成功。

true

Data

object

返回的基线实例列表。

PageNumber

integer

当前的页数。

1

PageSize

integer

每页的大小。

10

TotalCount

integer

基线实例的总数。

100

BaselineStatuses

array<object>

基线实例列表。

object

基线实例列表信息。

Status

string

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

SAFE

Owner

string

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

9527952795****

FinishTime

integer

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

1553531400000

ProjectId

integer

基线所在工作空间的 ID。

1234

Priority

integer

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

1

EndCast

integer

基线实例的预计完成时间。

1553531400000

InGroupId

integer

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

1

BaselineName

string

基线的名称。

基线名称

BaselineId

integer

基线的 ID。

1234

FinishStatus

string

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

UNFINISH

Bizdate

integer

业务日期时间戳。

1553443200000

Buffer

integer

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

1800

SlaTime

integer

基线实例的实际完成时间。

格式示例为 13 位数字,例如 1553531400000

1553531400000

ExpTime

integer

基线实例的预警时间。

格式示例为 13 位数字,例如 1553531400000

1553531400000

BaselineType

string

基线的类型,包括 DAILY(天基线)和 HOURLY(小时基线)。

基线类型

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "BaselineStatuses": [
      {
        "Status": "SAFE",
        "Owner": "9527952795****",
        "FinishTime": 1553531400000,
        "ProjectId": 1234,
        "Priority": 1,
        "EndCast": 1553531400000,
        "InGroupId": 1,
        "BaselineName": "基线名称",
        "BaselineId": 1234,
        "FinishStatus": "UNFINISH",
        "Bizdate": 1553443200000,
        "Buffer": 1800,
        "SlaTime": 1553531400000,
        "ExpTime": 1553531400000,
        "BaselineType": "基线类型"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area.
500 InternalError.System An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 没有权限,请授权
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.
429 Throttling.User Your request is too frequent. Try again later.

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

变更历史

更多信息,参考变更详情