Queries baselines.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListBaselineConfigs

The operation that you want to perform. Set the value to ListBaselineConfigs.

RegionId String Yes cn-shanghai

The ID of the region in which the DataWorks workspace resides. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

PageNumber Integer Yes 1

The number of the page to return. Valid values: 1 to 30. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.

Owner String No 95279527****

The ID of the Alibaba Cloud account used by the baseline owner.

ProjectId Long Yes 1234

The ID of the workspace. You can call the ListProjects operation to query the ID.

Priority String No 1,3,5,7,8

The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. Separate multiple priorities with commas (,).

Useflag Boolean No true

Specifies whether to enable the baseline. Valid values: true and false.

BaselineTypes String No DAILY,HOURLY

The type of the baseline. Valid values: DAILY and HOURLY. A value of DAILY indicates that the baseline is a day-level baseline. A value of HOURLY indicates that the baseline is an hour-level baseline. Separate multiple baseline types with commas (,).

SearchText String No Keyword

The keyword in the baseline name used to search for the baseline.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-EFG****

The unique ID of the request. You can troubleshoot issues based on the ID.

ErrorMessage String The specified parameters are invalid.

The error message returned.

ErrorCode String 1031203110005

The error code returned.

Success Boolean true

Indicates whether the request is successful.

Data Object

The return results of the request.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned on each page.

TotalCount Integer 100

The total number of baselines returned.

Baselines Array of Baselines

The list of baselines.

HourSlaDetail String null

The committed time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.

IsDefault Boolean true

Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.

Owner String 952795****

The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).

ProjectId Long 9527

The ID of the workspace to which the baseline belongs.

Priority Integer 1

The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.

SlaMinu Integer 30

The minute in the alert time of the day-level baseline. Valid values: 0 to 59.

SlaHour Integer 9

The hour in the committed time of the day-level baseline. Valid values: 0 to 47.

BaselineId Long 1234

The ID of the baseline.

BaselineName String Baseline name

The name of the baseline.

HourExpDetail String null

The alert time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.

UseFlag Boolean true

Indicates whether the baseline is enabled. Valid values: true and false.

ExpHour Integer 7

The hour in the alert time of the day-level baseline. Valid values: 0 to 47.

BaselineType String DAILY

The type of the baseline. Valid values: DAILY and HOURLY. A value of DAILY indicates that the baseline is a day-level baseline. A value of HOURLY indicates that the baseline is an hour-level baseline.

ExpMinu Integer 30

The minute in the alert time of the day-level baseline. Valid values: 0 to 59.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListBaselineConfigs
&PageNumber=1
&PageSize=10
&Owner=95279527****
&ProjectId=1234
&Priority=1,3,5,7,8
&Useflag=true
&BaselineTypes=DAILY,HOURLY
&SearchText=Keyword
&<Common request parameters>

Sample success responses

XML format

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

<ListBaselineConfigsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <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"}</HourSlaDetail>
            <IsDefault>true</IsDefault>
            <Owner>952795****</Owner>
            <ProjectId>9527</ProjectId>
            <Priority>1</Priority>
            <SlaMinu>30</SlaMinu>
            <SlaHour>9</SlaHour>
            <BaselineId>1234</BaselineId>
            <BaselineName>Baseline name</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"}</HourExpDetail>
            <UseFlag>true</UseFlag>
            <ExpHour>7</ExpHour>
            <BaselineType>DAILY</BaselineType>
            <ExpMinu>30</ExpMinu>
        </Baselines>
    </Data>
</ListBaselineConfigsResponse>

JSON format

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

Error codes

HTTP status code Error code Error message Description
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The error message returned because your quota for the resource has been reached. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. The error message returned because the DataWorks API is unavailable in this region. Try another region.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.