GetTopicInfluence - 获取事件影响的基线实例列表

更新时间:
复制 MD 格式

调用GetTopicInfluence获取事件影响的基线实例列表。

接口说明

调用时需指定 DataWorks 已开通的地域。RegionId 是用于地域路由的主机级参数;历史成功调用通过 dataworks-vpc.{regionId}.aliyuncs.com 形式的 VPC 端点完成。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

TopicId

integer

是

事件的 ID。

1234

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 返回码。

200

RequestId

string

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

0000-ABCD-EFG****

ErrorMessage

string

错误信息。

The specified parameters are invalid.

ErrorCode

string

错误码。

1031203110005

Success

boolean

调用是否成功。

true

Data

object

事件影响的基线实例列表。

TopicId

integer

事件的 ID。

1234

Influences

array<object>

影响的基线实例列表。

object

Status

string

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

SAFE

Owner

string

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

952795****

BaselineName

string

基线的名称。

Baseline name

BaselineId

integer

基线的 ID。

12345

Bizdate

integer

基线实例的业务日期时间戳。

1553356800000

Buffer

integer

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

360

ProjectId

integer

基线所在工作空间的 ID。

1234

Priority

integer

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

1

InGroupId

integer

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

1

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "TopicId": 1234,
    "Influences": [
      {
        "Status": "SAFE",
        "Owner": "952795****",
        "BaselineName": "Baseline name",
        "BaselineId": 12345,
        "Bizdate": 1553356800000,
        "Buffer": 360,
        "ProjectId": 1234,
        "Priority": 1,
        "InGroupId": 1
      }
    ]
  }
}

错误码

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.
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.
500 Invalid.Wkbench.TopicNotExist The topic does not exist.
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.

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

变更历史

更多信息,参考变更详情。