文档

ListBaselineConfigs - 获取基线列表

更新时间:

调用ListBaselineConfigs获取基线列表。

调试

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

授权信息

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

请求参数

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

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

1
PageSizeinteger

每页返回的数据行数。默认值为 10,最小值为 1,最大值为 100。

10
Ownerstring

基线责任人的阿里云 UID。

95279527****
ProjectIdlong

工作空间的 ID。您可以通过 ListProjects 接口获取工作空间 ID。

1234
Prioritystring

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

1,3,5,7,8
Useflagboolean

是否开启,包括 true(开启)和 false(未开启)。

true
BaselineTypesstring

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

DAILY,HOURLY
SearchTextstring

基线名称的搜索关键字。

基线名称搜索关键字

返回参数

名称类型描述示例值
object

返回数据结构。

HttpStatusCodeinteger

HTTP 返回码。

200
RequestIdstring

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

0000-ABCD-EFG****
ErrorMessagestring

错误信息。

The specified parameters are invalid.
ErrorCodestring

错误码。

1031203110005
Successboolean

调用是否成功。

true
Dataobject

返回的基线列表。

PageNumberinteger

当前的页数。

1
PageSizeinteger

每页的大小。

10
TotalCountinteger

基线的总数。

100
Baselinesarray<object>

基线列表。

object

返回数据结构。

HourSlaDetailstring

小时基线的承诺时间配置(JSON 格式),key 为周期号,value 为 hh:mm 格式。hh 的取值范围为[0,47],mm 的取值范围为[0,59]。

{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}
IsDefaultboolean

是否为工作空间的默认基线,包括 true(是)和 false(否)。

true
Ownerstring

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

952795****
ProjectIdlong

基线所在工作空间的 ID。

9527
Priorityinteger

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

1
SlaMinuinteger

天基线的预警分钟,取值范围为[0, 59]。

30
SlaHourinteger

天基线的承诺小时,取值范围为[0, 47]。

9
BaselineIdlong

基线的 ID。

1234
BaselineNamestring

基线的名称。

基线名称
HourExpDetailstring

小时基线的预警时间配置(JSON 格式),key 为周期号,value 为 hh:mm 格式。hh 的取值范围为[0,47],mm 的取值范围为[0,59]。

{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}
UseFlagboolean

基线是否开启,包括 true(开启)和 false(未开启)。

true
ExpHourinteger

天基线的预警小时,取值范围为[0, 47]。

7
BaselineTypestring

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

DAILY
ExpMinuinteger

天基线的预警分钟,取值范围为[0, 59]。

30

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Baselines": [
      {
        "HourSlaDetail": "{\"1\":\"03:58\",\"2\":\"04:58\",\"3\":\"05:58\",\"4\":\"06:58\",\"5\":\"07:58\",\"6\":\"08:58\",\"7\":\"09:58\",\"8\":\"10:58\",\"9\":\"11:58\",\"10\":\"12:58\",\"11\":\"13:58\",\"12\":\"14:58\",\"13\":\"15:58\",\"14\":\"16:58\",\"15\":\"17:58\",\"16\":\"18:58\",\"17\":\"19:58\",\"18\":\"20:58\",\"19\":\"21:58\",\"20\":\"22:58\",\"21\":\"23:58\",\"22\":\"24:58\",\"23\":\"25:58\",\"24\":\"26:58\"}",
        "IsDefault": true,
        "Owner": "952795****",
        "ProjectId": 9527,
        "Priority": 1,
        "SlaMinu": 30,
        "SlaHour": 9,
        "BaselineId": 1234,
        "BaselineName": "基线名称",
        "HourExpDetail": "{\"1\":\"03:28\",\"2\":\"04:28\",\"3\":\"05:28\",\"4\":\"06:28\",\"5\":\"07:28\",\"6\":\"08:28\",\"7\":\"09:28\",\"8\":\"10:28\",\"9\":\"11:28\",\"10\":\"12:28\",\"11\":\"13:28\",\"12\":\"14:28\",\"13\":\"15:28\",\"14\":\"16:28\",\"15\":\"17:28\",\"16\":\"18:28\",\"17\":\"19:28\",\"18\":\"20:28\",\"19\":\"21:28\",\"20\":\"22:28\",\"21\":\"23:28\",\"22\":\"24:28\",\"23\":\"25:28\",\"24\":\"26:28\"}",
        "UseFlag": true,
        "ExpHour": 7,
        "BaselineType": "DAILY",
        "ExpMinu": 30
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史