GetBaseline - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a baseline based on its ID.

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
BaselineId	long	Yes	The baseline ID. You can call the ListBaselines operation to query the ID.	123456
ProjectId	long	Yes	The ID of the workspace to which the baseline belongs. You can call the ListBaselines operation to query the ID.	10000

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	1031203110005
ErrorMessage	string	The error message.	The specified parameters are invalid
HttpStatusCode	integer	The HTTP status code.	200
Data	object	The data returned.
BaselineId	long	The baseline ID.	1001
BaselineName	string	The name of the baseline.	Test baseline
ProjectId	long	The workspace ID.	10000
Owner	string	The owner.	9527952****
Priority	integer	The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.	1
BaselineType	string	The type of the baseline. Valid values: DAILY HOURLY	DAILY
OverTimeSettings	array<object>	The settings of the committed completion time of the baseline.
OverTimeSetting	object
Cycle	integer	The period corresponding to the commitment time. The space-based line is 1, and the hourly baseline can be configured for up to 24 cycles.	1
Time	string	Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].	00:00
Enabled	boolean	Indicates whether the baseline is enabled.	true
NodeIds	array	The node IDs.
NodeId	long	Node ID.	700003****
AlertEnabled	boolean	Indicates whether the alerting feature is enabled. Valid values: true false	true
AlertMarginThreshold	integer	The alert margin threshold. Unit: minutes.	60
AlertSettings	array<object>	The alert settings.
AlertSetting	object	Baseline alert configuration
AlertType	string	Alert type BASELINE: baseline TOPIC: event	BASELINE
AlertMethods	array	Alert method list
AlertMethod	string	The alert method. The values are as follows: MAIL: MAIL SMS: SMS PHONE: voice DINGROBOTS: DingTalk robot WEBHOOKS: Webhook	MAIL
SilenceStartTime	string	The start time of the silence. Format: HH:mm:ss	00:00:00
SilenceEndTime	string	The end time of the silence. The format is HH:mm:ss.	00:00:00
AlertInterval	integer	The event alert interval, in seconds.	900
AlertMaximum	integer	The maximum number of event alerts.	1
DingRobots	array<object>	DingTalk robot list.
DingRobot	object	DingTalk robot configuration.
WebUrl	string	DingTalk robot address	https://oapi.dingtalk.com/robot/send?access_token=xxx
AtAll	boolean	Whether @ everyone.	true
Webhooks	array	webhook list.
Webhook	string	The webhook addresses of the Enterprise WeChat or flying book Robot. Separate multiple webhook addresses with commas (,). alertMethods must include WEBHOOKS alert methods. Only DataWorks Enterprise Edition is supported. Available regions: China(Shanghai), China(Chengdu), China(Zhangjiakou), China(Beijing), China(Hangzhou), China(Shenzhen), China (Hong Kong), Central Europe 1 (Frankfurt), and Southeast Asia Pacific 1 (Singapore).	https://open.feishu.cn/open-apis/bot/v2/hook/xxx
TopicTypes	array	The list of Event Alert types.
TopicType	string	The type of the event alert. SLOW ERROR	SLOW
BaselineAlertEnabled	boolean	The baseline alarm switch. true false	false
AlertRecipientType	string	The type of alert recipient. OWNER: task owner OTHER: designated person SHIFT: SCHEDULE-duty table	OWNER
AlertRecipient	string	Alert recipient details. AlertRecipientType is OWNER: empty AlertRecipientType is SHIFT_SCHEDULE: duty table uid AlertRecipientType is OTHER: uid list, multiple UIDs are in English, split	123123
RequestId	string	The request ID.	ecb967ec-c137-48a5-860****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1031203110005",
  "ErrorMessage": "The specified parameters are invalid",
  "HttpStatusCode": 200,
  "Data": {
    "BaselineId": 1001,
    "BaselineName": "Test baseline",
    "ProjectId": 10000,
    "Owner": "9527952****",
    "Priority": 1,
    "BaselineType": "DAILY",
    "OverTimeSettings": [
      {
        "Cycle": 1,
        "Time": "00:00"
      }
    ],
    "Enabled": true,
    "NodeIds": [
      0
    ],
    "AlertEnabled": true,
    "AlertMarginThreshold": 60,
    "AlertSettings": [
      {
        "AlertType": "BASELINE",
        "AlertMethods": [
          "MAIL"
        ],
        "SilenceStartTime": "00:00:00",
        "SilenceEndTime": "00:00:00",
        "AlertInterval": 900,
        "AlertMaximum": 1,
        "DingRobots": [
          {
            "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=xxx",
            "AtAll": true
          }
        ],
        "Webhooks": [
          "https://open.feishu.cn/open-apis/bot/v2/hook/xxx"
        ],
        "TopicTypes": [
          "SLOW"
        ],
        "BaselineAlertEnabled": false,
        "AlertRecipientType": "OWNER",
        "AlertRecipient": "123123"
      }
    ]
  },
  "RequestId": "ecb967ec-c137-48a5-860****"
}

Error codes

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