ListBaselines - DataWorks - Alibaba Cloud Documentation Center

Obtains 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
Owner	string	No	The owner.	3726346****
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.	123456
Priority	string	No	The priority of the baseline. Valid values: {1,3,5,7,8}.	1
Enable	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. You can specify multiple types. Separate multiple types with commas (,).	DAILY
SearchText	string	No	The keyword in the baseline name, which is used to search for the baseline.	baselineName
PageNumber	integer	Yes	The page number. Pages start from page 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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	103630001
ErrorMessage	string	The error message returned if the request failed.	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.
baselines	object
BaselineId	long	The baseline ID.	1234
ProjectId	long	The ID of the workspace to which the baseline belongs.	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 ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).	952795****
BaselineName	string	The name of the baseline.	BaselineName
Enabled	boolean	Indicates whether the baseline is enabled. Valid values: true and false.	true
AlertEnabled	boolean	Indicates whether the alerting feature is enabled. Valid values: true and false.	true
AlertMarginThreshold	integer	The alert margin threshold for the baseline instance. Unit: minutes.	30
OverTimeSettings	array<object>	The settings of the committed completion time of the baseline.
overTimeSettings	object
Cycle	integer	The cycle that corresponds to the committed completion time. For a day-level baseline, the value of this parameter is 1. For an hour-level baseline, the value of this parameter cannot exceed 24.	1
Time	string	The committed completion time in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].	00:00
RequestId	string	The request ID.	952795279527ab****

Examples

Sample success responses

JSONformat

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

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