Call ListBaselineConfigs Obtaining baseline list.

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 Required ListBaselineConfigs

The operation that you want to perform.

PageNumber Integer Yes 1

The number of pages that are returned. The default value is 1, the minimum value is 1, and the maximum value is 30.

PageSize Integer Yes 10

The number of returned data rows per page. The default value is 10, the minimum value is 1, and the maximum value is 100.

ProjectId Long Yes 1234

The ID of the DataWorks workspace.

RegionId String Required cn-shanghai

The unique identifier of the zone.

Owner String No 95279527****

The Alibaba Cloud UID, which is the baseline owner.

Priority String No 1,3,5,7,8

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

Useflag Boolean No true

Specifies whether to enable the feature. Valid values: true and false.

BaselineTypes String No DAILY,HOURLY

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

SearchText String No The keyword for searching the baseline name.

The keyword used to search for the baseline name.

Response parameters

Parameter Type Example Description
Data Struct

The returned list of baselines.

Baselines Array

The list of baselines.

BaselineId Long 1234

The ID of the baseline.

BaselineName String Baseline check

The name of the baseline.

BaselineType String DAILY

The type of the baseline. Valid values: DAILY and HOURLY.

ExpHour Integer 7

The warning hours of Apsara infrastructure management framework line. The value range is [0, 47].

ExpMinu Integer 30

The warning minute of Apsara infrastructure management framework line. The value range is [0, 59].

HourExpDetail String {"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"}

The configuration of the warning time for the hour baseline in JSON format. The key indicates the period number. The value is in hh:mm format. The value range of hh is [0,47], and the value range of mm is [0,59].

HourSlaDetail String {"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"}

The commitment time (in JSON format) for the hour baseline. The key is the cycle number and the value is in hh:mm format. The value range of hh is [0,47], and the value range of mm is [0,59].

IsDefault Boolean true

Indicates whether the default baseline for the workspace is enabled. Valid values: true and false.

Owner String 952795****

The Alibaba Cloud UID of the owner of the baseline. When there are multiple responsible persons, separate them with commas (,).

Priority Integer 1

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

ProjectId Long 9527

The ID of the workspace to which the baseline belongs.

SlaHour Integer 9

The committed hours of the Apsara infrastructure management framework line. The value range is [0, 47].

SlaMinu Integer 30

The warning minute of Apsara infrastructure management framework line. The value range is [0, 59].

UseFlag Boolean true

Specifies whether the baseline is enabled. Valid values: true and false.

PageNumber Integer 1

The current page number.

PageSize Integer 10

The size of each page.

TotalCount Integer 100

The total number of baselines.

ErrorCode String 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFG****

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListBaselineConfigs
&PageNumber=1
&PageSize=10
&ProjectId=1234
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Baselines>
        <BaselineId>1234</BaselineId>
        <IsDefault>true</IsDefault>
        <ExpHour>7</ExpHour>
        <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"}</HourSlaDetail>
        <Owner>952795****</Owner>
        <ExpMinu>30</ExpMinu>
        <SlaHour>9</SlaHour>
        <Priority>1</Priority>
        <SlaMinu>30</SlaMinu>
        <ProjectId>1234</ProjectId>
        <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"}</HourExpDetail>
        <UseFlag>true</UseFlag>
        <BaselineType>DAILY</BaselineType>
        <BaselineName> baseline name </BaselineName>
    </Baselines>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid. </ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "Baselines": {
            "BaselineId": 1234,
            "IsDefault": true,
            "ExpHour": 7,
            "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\"}",
            "Owner": "952795****",
            "ExpMinu": 30,
            "SlaHour": 9,
            "Priority": 1,
            "SlaMinu": 30,
            "ProjectId": 1234,
            "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,
            "BaselineType": "DAILY",
            "BaselineName": "baseline name"
        }
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. DataWorks API service is not available in this region. Please try another region.
500 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace. You have no permission to use a workspace.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The service was open.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The parameters are invalid.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The number of resources has reached the upper limit. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
500 Forbidden.Wkbench.NoProject You have not joined any project. You have not joined any workspaces.

For a list of error codes, visit the API Error Center.