获取基线配置列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListBaselines

系统规定参数。取值:ListBaselines

Owner String 3726346****

责任人

ProjectId Long 123456

DataWorks工作空间的ID。您可以登录DataWorks控制台,进入工作空间配置页面获取工作空间ID。

Priority String 1

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

Enable Boolean true

是否开启基线,包括true(可用)和false(不可用)。

BaselineTypes String DAILY

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

SearchText String baselineName

基线名称的搜索关键字。

PageNumber Integer 1

分页查询页码。大于等于1的正整数,默认为1,最大为30。

PageSize Integer 100

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

返回数据

名称 类型 示例值 描述
Success Boolean true

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
ErrorCode String 103630001

错误码。

ErrorMessage String The user does not exist. 276571706358178756

调用失败时,返回的错误信息。

HttpStatusCode Integer 200

HTTP返回码。

Data Object

返回的基线列表。

PageNumber String 1

当前的页数。

PageSize String 10

每页的大小。

TotalCount String 100

基线的总数。

Baselines Array of baselines

基线列表。

BaselineId Long 1234

基线的ID。

ProjectId Long 9527

基线所在工作空间的ID。

BaselineType String DAILY

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

Priority Integer 1

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

Owner String 952795****

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

BaselineName String BaselineName

基线的名称。

Enabled Boolean true

基线是否开启,包括true(可用)和false(不可用)。

AlertEnabled Boolean true

是否开启告警,包括true(开启)和false(关闭)。

AlertMarginThreshold Integer 30

基线实例的预警阈值,单位为分钟。

OverTimeSettings Array of overTimeSettings

基线承诺时间设置。

Cycle Integer 1

承诺时间对应的周期,天基线为1,小时基线可以配置最多24个周期。

Time String 00:00

承诺时间,hh:mm格式,hh的取值范围为[0,47],mm的取值范围为[0,59]。

RequestId String 952795279527ab****

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListBaselines
&Owner=3726346****
&ProjectId=123456
&Priority=1
&Enable=true
&BaselineTypes=DAILY
&SearchText=baselineName
&PageNumber=1
&PageSize=100
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
}

错误码

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