ListBaselineConfigs - DataWorks - Alibaba Cloud Documentation Center

Queries a list of baselines.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number. Valid values: 1 to 30. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
Owner	string	No	The ID of the Alibaba Cloud account used by the baseline owner.	95279527****
ProjectId	long	Yes	The workspace ID. You can call the ListProjects operation to query the ID.	1234
Priority	string	No	The priority of the baseline. Valid values: {1,3,5,7,8}. Separate multiple priorities with commas (,).	1,3,5,7,8
Useflag	boolean	No	Specifies whether to enable the baseline. Valid values: true and false.	true
BaselineTypes	string	No	The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple baseline types with commas (,).	DAILY,HOURLY
SearchText	string	No	The keyword in the baseline name, which is used to search for the baseline.	Baseline name search keywords

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message.	The specified parameters are invalid.
ErrorCode	string	The error code.	1031203110005
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of baselines returned.	100
Baselines	array<object>	The baselines.
Baselines	object	The returned result.
HourSlaDetail	string	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"}
IsDefault	boolean	Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.	true
Owner	string	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).	952795****
ProjectId	long	The ID of the workspace to which the baseline belongs.	9527
Priority	integer	The priority of the baseline. Valid values: {1,3,5,7,8}.	1
SlaMinu	integer	The minute in the alerting time of the day-level baseline. Valid values: [0, 59].	30
SlaHour	integer	The hour in the committed completion time of the day-level baseline. Valid values: [0, 47].	9
BaselineId	long	The baseline ID.	1234
BaselineName	string	The name of the baseline.	Baseline name
HourExpDetail	string	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"}
UseFlag	boolean	Indicates whether the baseline is enabled. Valid values: true and false.	true
ExpHour	integer	The hour in the alerting time of the day-level baseline. Valid values: [0, 47].	7
BaselineType	string	The type of the baseline. Valid values: DAILY and HOURLY.	DAILY
ExpMinu	integer	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": "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.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.	-
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.	-
500	InternalError.System	An internal system error occurred. Try again later.	-

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

Change history

Change time	Summary of changes	Operation

No change history