All Products
Search

This Product

    DataWorks:ListBaselineStatuses

    Document Center

    DataWorks:ListBaselineStatuses

    Last Updated:Mar 30, 2026

    Queries a list of baseline instances.

    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
    PageNumber

    integer

    Yes

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

    1
    PageSize

    integer

    Yes

    The number of entries to return on each page. Default value: 10. Maximum value: 100.

    10
    Bizdate

    string

    Yes

    The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC.

    2020-07-07T00:00:00+0800
    Priority

    string

    No

    The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. Multiple priorities are separated by commas (,).

    1,3,5,7,8
    SearchText

    string

    No

    The keyword of the baseline name used to search for the baseline.

    Keyword of the baseline name

    Owner

    string

    No

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

    9527952795****
    TopicId

    integer

    No

    The ID of the event.

    1234
    FinishStatus

    string

    No

    The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running. Multiple states are separated by commas (,).

    FINISH,UNFINISH
    Status

    string

    No

    The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time. Multiple states are separated by commas (,).

    SAFE,DANGROUS,OVER
    BaselineTypes

    string

    No

    The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is scheduled by day. The value HOURLY indicates that the baseline is scheduled by hour. Multiple types are separated by commas (,).

    DAILY,HOURLY

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    HttpStatusCode

    integer

    The HTTP status code returned.

    200
    RequestId

    string

    The ID of the request. You can use the ID to troubleshoot issues.

    0000-ABCD-EFG****
    ErrorMessage

    string

    The error message returned.

    The specified parameters are invalid.
    ErrorCode

    string

    The error code returned.

    Invalid.Tenant.ConnectionNotExists
    Success

    boolean

    Indicates whether the request was successful.

    true
    Data

    object

    The data returned.

    PageNumber

    integer

    The page number of the returned page.

    1
    PageSize

    integer

    The number of entries returned per page.

    10
    TotalCount

    integer

    The total number of baseline instances.

    100
    BaselineStatuses

    array<object>

    The list of baseline instances.

    object

    The information about the baseline instances.

    Status

    string

    The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.

    SAFE
    Owner

    string

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

    9527952795****
    FinishTime

    integer

    The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.

    1553531400000
    ProjectId

    integer

    The ID of the workspace to which the baseline belongs.

    1234
    Priority

    integer

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

    1
    EndCast

    integer

    The timestamp of the predicted time when the baseline instance finished running.

    1553531400000
    InGroupId

    integer

    The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: [1,24]. The ID of a day-level cycle is 1.

    1
    BaselineName

    string

    The name of the baseline.

    Baseline name

    BaselineId

    integer

    The baseline ID.

    1234
    FinishStatus

    string

    The status of the baseline instance. Valid values: UNFINISH and FINISH.

    UNFINISH
    Bizdate

    integer

    The data timestamp.

    1553443200000
    Buffer

    integer

    The margin of the baseline instance. Unit: seconds.

    1800
    SlaTime

    integer

    The timestamp of the actual time when the baseline instance finished running.

    1553531400000
    ExpTime

    integer

    The timestamp of the alerting time of the baseline instance.

    1553531400000
    BaselineType

    string

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

    DAILY,HOURLY

    Examples

    Success response

    JSON format

    {
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "BaselineStatuses": [
      {
        "Status": "SAFE",
        "Owner": "9527952795****",
        "FinishTime": 1553531400000,
        "ProjectId": 1234,
        "Priority": 1,
        "EndCast": 1553531400000,
        "InGroupId": 1,
        "BaselineName": "Baseline name",
        "BaselineId": 1234,
        "FinishStatus": "UNFINISH",
        "Bizdate": 1553443200000,
        "Buffer": 1800,
        "SlaTime": 1553531400000,
        "ExpTime": 1553531400000,
        "BaselineType": "DAILY"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    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.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.