ListBaselines - DataWorks - Alibaba Cloud Documentation Center

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListBaselines	The operation that you want to perform. Set the value to ListBaselines.
Owner	String	No	3726346****	The owner.
ProjectId	Long	Yes	123456	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.
Priority	String	No	1	The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.
Enable	Boolean	No	true	Specifies whether to enable the baseline. Valid values: true and false.
BaselineTypes	String	No	DAILY	The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is a day-level baseline. The value HOURLY indicates that the baseline is an hour-level baseline. You can specify multiple types. Separate multiple types with commas (,).
SearchText	String	No	baselineName	The keyword in the baseline name, which is used to search for the baseline.
PageNumber	Integer	Yes	1	The page number. Pages start from page 1. Valid values: 1 to 30. Default value: 1.
PageSize	Integer	Yes	100	The number of entries per page. Valid values: 1 to 100. Default value: 10.

Response parameters


Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
ErrorCode	String	103630001	The error code.
ErrorMessage	String	The user does not exist. 276571706358178756	The error message returned if the call failed.
HttpStatusCode	Integer	200	The HTTP status code.
Data	Object		The data returned.
PageNumber	String	1	The page number.
PageSize	String	10	The number of entries per page.
TotalCount	String	100	The total number of baselines returned.
Baselines	Array of baselines		The baselines.
BaselineId	Long	1234	The ID of the baseline.
ProjectId	Long	9527	The ID of the workspace to which the baseline belongs.
BaselineType	String	DAILY	The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is a day-level baseline. The value HOURLY indicates that the baseline is an hour-level baseline.
Priority	Integer	1	The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.
Owner	String	952795****	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).
BaselineName	String	BaselineName	The name of the baseline.
Enabled	Boolean	true	Indicates whether the baseline is enabled. Valid values: true and false.
AlertEnabled	Boolean	true	Indicates whether the alerting feature is enabled. Valid values: true and false.
AlertMarginThreshold	Integer	30	The alert margin threshold for the baseline instance. Unit: minutes.
OverTimeSettings	Array of overTimeSettings		The settings of the committed completion time of the baseline.
Cycle	Integer	1	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.
Time	String	00:00	The committed completion time. The time is in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.
RequestId	String	952795279527ab****	The request ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListBaselines
&Owner=3726346****
&ProjectId=123456
&Priority=1
&Enable=true
&BaselineTypes=DAILY
&SearchText=baselineName
&PageNumber=1
&PageSize=100
&<Common request parameters>

Sample success responses

XML format

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

<ListBaselinesResponse>
    <Success>true</Success>
    <ErrorCode>103630001</ErrorCode>
    <ErrorMessage>The user does not exist. 276571706358178756</ErrorMessage>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Baselines>
            <BaselineId>1234</BaselineId>
            <ProjectId>9527</ProjectId>
            <BaselineType>DAILY</BaselineType>
            <Priority>1</Priority>
            <Owner>952795****</Owner>
            <BaselineName>BaselineName</BaselineName>
            <Enabled>true</Enabled>
            <AlertEnabled>true</AlertEnabled>
            <AlertMarginThreshold>30</AlertMarginThreshold>
            <OverTimeSettings>
                <Cycle>1</Cycle>
                <Time>00:00</Time>
            </OverTimeSettings>
        </Baselines>
    </Data>
    <RequestId>952795279527ab****</RequestId>
</ListBaselinesResponse>

JSON format

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

{
  "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, see Service error codes.