All Products
Search
Document Center

DataWorks:ListBaselineConfigs

Last Updated:Sep 18, 2024

Queries a list of baselines.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

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

1
PageSizeintegerYes

The number of entries per page. Valid values: 1 to 100. Default value: 10.

10
OwnerstringNo

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

95279527****
ProjectIdlongYes

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

1234
PrioritystringNo

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

1,3,5,7,8
UseflagbooleanNo

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

true
BaselineTypesstringNo

The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple baseline types with commas (,).

DAILY,HOURLY
SearchTextstringNo

The keyword in the baseline name, which is used to search for the baseline.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

0000-ABCD-EFG****
ErrorMessagestring

The error message.

The specified parameters are invalid.
ErrorCodestring

The error code.

1031203110005
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of baselines returned.

100
Baselinesarray<object>

The list of baselines.

object
HourSlaDetailstring

The committed completion 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,47]. Valid values of 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

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

true
Ownerstring

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

952795****
ProjectIdlong

The ID of the workspace to which the baseline belongs.

9527
Priorityinteger

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

1
SlaMinuinteger

The minute in the alerting time of the day-level baseline. Valid values: [0, 59].

30
SlaHourinteger

The hour in the committed completion time of the day-level baseline. Valid values: [0, 47].

9
BaselineIdlong

The baseline ID.

1234
BaselineNamestring

The name of the baseline.

HourExpDetailstring

The alerting 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,47]. Valid values of 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

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

true
ExpHourinteger

The hour in the alerting time of the day-level baseline. Valid values: [0, 47].

7
BaselineTypestring

The type of the baseline. Valid values: DAILY and HOURLY.

DAILY
ExpMinuinteger

The minute in the alerting time of the day-level baseline. Valid values: [0, 59].

30

Examples

Sample success responses

JSONformat

{
  "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
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
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.-
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.-
500InternalError.SystemAn internal system error occurred. Try again later.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history