Queries the configurations of a baseline.

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 GetBaselineConfig

The operation that you want to perform. Set the value to GetBaselineConfig.

RegionId String Yes cn-shanghai

The region ID.

BaselineId Long Yes 1234

The ID of the baseline. You can call the GetNode operation to obtain the ID.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 401

The HTTP status code.

RequestId String ecb967ec-c137-48a5-860****

The ID of the request.

ErrorMessage String The specified parameters are invalid.

The error message.

ErrorCode String 1031203110005

The error code.

Success Boolean true

Indicates whether the request is successful.

Data Object

The details of the baseline.

HourSlaDetail String null

The committed time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.

IsDefault Boolean true

Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.

Owner String 9527952****

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

ProjectId Long 1234

The ID of the workspace.

Priority Integer 1

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

SlaMinu Integer 30

The minute in the committed time of the day-level baseline. Valid values: 0 to 59.

SlaHour Integer 9

The hour in the committed time of the day-level baseline. Valid values: 0 to 47.

BaselineId Long 1234

The ID of the baseline.

BaselineName String Baseline name

The name of the baseline.

HourExpDetail String null

The alert time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.

UseFlag Boolean true

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

ExpHour Integer 7

The hour in the alert time of the day-level baseline. Valid values: 0 to 47.

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.

ExpMinu Integer 30

The minute in the alert time of the day-level baseline. Valid values: 0 to 59.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetBaselineConfig
&BaselineId=1234
&<Common request parameters>

Sample success responses

XML format

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

<GetBaselineConfigResponse>
    <HttpStatusCode>401</HttpStatusCode>
    <RequestId>ecb967ec-c137-48a5-860****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <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>
        <IsDefault>true</IsDefault>
        <Owner>9527952****</Owner>
        <ProjectId>1234</ProjectId>
        <Priority>1</Priority>
        <SlaMinu>30</SlaMinu>
        <SlaHour>9</SlaHour>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
        <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>
        <ExpHour>7</ExpHour>
        <BaselineType>DAILY</BaselineType>
        <ExpMinu>30</ExpMinu>
    </Data>
</GetBaselineConfigResponse>

JSON format

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

{
  "HttpStatusCode" : 401,
  "RequestId" : "ecb967ec-c137-48a5-860****",
  "ErrorMessage" : "The specified parameters are invalid.",
  "ErrorCode" : 1031203110005,
  "Success" : true,
  "Data" : {
    "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\"}",
    "IsDefault" : true,
    "Owner" : "9527952****",
    "ProjectId" : 1234,
    "Priority" : 1,
    "SlaMinu" : 30,
    "SlaHour" : 9,
    "BaselineId" : 1234,
    "BaselineName" : "Baseline name",
    "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,
    "ExpHour" : 7,
    "BaselineType" : "DAILY",
    "ExpMinu" : 30
  }
}

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. The error message returned because the DataWorks API is unavailable in this region. Try another region.
500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline. The error message returned because you are not authorized to access the specified baseline.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The error message returned because a service error has occurred.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The error message returned because the values of one or more parameters are invalid.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The error message returned because your quota for the resource has been reached. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.

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