Get a list of baselines by using ListBaselines - DataWorks - Alibaba Cloud - DataWorks

Queries baselines in a DataWorks workspace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Owner	string	No	The owner.	3726346****
ProjectId	integer	Yes	The DataWorks workspace ID. Log on to the DataWorks console and go to the Workspace page to obtain the ID.	123456
Priority	string	No	The priority of the baseline. Valid values: {1,3,5,7,8}.	1
Enable	boolean	No	Specifies whether the baseline is enabled.	true
BaselineTypes	string	No	The baseline type. Valid values: DAILY and HOURLY. Separate multiple values with commas (,).	DAILY
SearchText	string	No	A keyword in the baseline name for fuzzy search.	baselineName
PageNumber	integer	Yes	The page number. Pages start from 1. Default value: 1. Maximum value: 30.	1
PageSize	integer	Yes	The number of entries per page. Default value: 10. Maximum value: 100.	100

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	103630001
ErrorMessage	string	The error message.	The user does not exist. 276571706358178756
HttpStatusCode	integer	The HTTP status code.	200
Data	object	The data returned.
PageNumber	string	The page number.	1
PageSize	string	The number of entries per page.	10
TotalCount	string	The total number of baselines returned.	100
Baselines	array<object>	The baselines.
	array<object>
BaselineId	integer	The baseline ID.	1234
ProjectId	integer	The workspace ID.	9527
BaselineType	string	The type of the baseline. Valid values: DAILY and HOURLY.	DAILY
Priority	integer	The priority of the baseline. Valid values: {1,2,5,7,8}.	1
Owner	string	The Alibaba Cloud account ID of the baseline owner. Separate multiple IDs with commas (,).	952795****
BaselineName	string	The name of the baseline.	BaselineName
Enabled	boolean	Indicates whether the baseline is enabled.	true
AlertEnabled	boolean	Indicates whether alerting is enabled.	true
AlertMarginThreshold	integer	The alert margin threshold of the baseline instance, in minutes.	30
OverTimeSettings	array<object>	The committed completion time settings.
	object
Cycle	integer	The cycle for the committed completion time. For daily baselines, the value is 1. For hourly baselines, the maximum value is 24.	1
Time	string	The committed completion time in hh:mm format. Valid values: hh [0,47], mm [0,59].	00:00
RequestId	string	The request ID.	952795279527ab****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.