ListBaselines - 获取基线列表 - 大数据开发治理平台 DataWorks

该接口用于获取基线列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Owner	string	否	责任人	3726346****
ProjectId	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。	123456
Priority	string	否	基线的优先级，取值范围为{1,3,5,7,8}。	1
Enable	boolean	否	是否开启基线，包括 true（可用）和 false（不可用）。	true
BaselineTypes	string	否	基线的类型，包括 DAILY（天基线）和 HOURLY（小时基线）。多个类型之间使用英文逗号（,）分隔。	DAILY
SearchText	string	否	基线名称的搜索关键字。	baselineName
PageNumber	integer	是	分页查询页码。大于等于 1 的正整数，默认为 1，最大为 30。	1
PageSize	integer	是	每页显示的条数，默认为 10 条，最大 100 条。	100

返回参数

名称	类型	描述	示例值
	object	OpenApiResultModel
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码。	103630001
ErrorMessage	string	调用失败时，返回的错误信息。	The user does not exist. 276571706358178756
HttpStatusCode	integer	HTTP 返回码。	200
Data	object	返回的基线列表。
PageNumber	string	当前的页数。	1
PageSize	string	每页的大小。	10
TotalCount	string	基线的总数。	100
Baselines	array<object>	基线列表。
baselines	object	基线配置。
BaselineId	long	基线的 ID。	1234
ProjectId	long	基线所在工作空间的 ID。	9527
BaselineType	string	基线类型，包括 DAILY（天基线）和 HOURLY（小时基线）。	DAILY
Priority	integer	基线的优先级，取值范围为{1,2,5,7,8}。	1
Owner	string	基线责任人的阿里云 UID。有多个责任人时，使用英文逗号（,）分隔。	952795****
BaselineName	string	基线的名称。	BaselineName
Enabled	boolean	基线是否开启，包括 true（可用）和 false（不可用）。	true
AlertEnabled	boolean	是否开启告警，包括 true（开启）和 false（关闭）。	true
AlertMarginThreshold	integer	基线实例的预警阈值，单位为分钟。	30
OverTimeSettings	array<object>	基线承诺时间设置。
overTimeSettings	object	周期配置。
Cycle	integer	承诺时间对应的周期，天基线为 1，小时基线可以配置最多 24 个周期。	1
Time	string	承诺时间，hh:mm 格式，hh 的取值范围为[0,47]，mm 的取值范围为[0,59]。	00:00
RequestId	string	本次调用的唯一 id。出现错误后，您可以根据该 ID 排查问题。	952795279527ab****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorCode": "103630001",
  "ErrorMessage": "The user does not exist. 276571706358178756",
  "HttpStatusCode": 200,
  "Data": {
    "PageNumber": "1",
    "PageSize": "10",
    "TotalCount": "100",
    "Baselines": [
      {
        "BaselineId": 1234,
        "ProjectId": 9527,
        "BaselineType": "DAILY",
        "Priority": 1,
        "Owner": "952795****",
        "BaselineName": "BaselineName",
        "Enabled": true,
        "AlertEnabled": true,
        "AlertMarginThreshold": 30,
        "OverTimeSettings": [
          {
            "Cycle": 1,
            "Time": "00:00"
          }
        ]
      }
    ]
  },
  "RequestId": "952795279527ab****"
}

错误码

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