GetBaseline-DataWorks(DataWorks)-阿里云帮助中心

Queries the configuration of a baseline by its ID.

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

Response elements

Element	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	integer	The baseline ID.	1001
BaselineName	string	The name of the baseline.	Test baseline
ProjectId	integer	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.
	object
Cycle	integer	The cycle number for the committed completion time. For a daily baseline, this value is 1. For an hourly baseline, up to 24 cycles can be configured.	1
Time	string	The committed completion time in hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.	00:00
Enabled	boolean	Indicates whether the baseline is enabled.	true
NodeIds	array	The node IDs.
	integer	The 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.
	array<object>	The baseline alert configuration.
AlertType	string	The alert type. Valid values: BASELINE: baseline alert TOPIC: event alert	BASELINE
AlertMethods	array	The alert methods.
	string	The alert method. Valid values: MAIL: email SMS: text message PHONE: phone call DINGROBOTS: DingTalk chatbot WEBHOOKS: Webhook	MAIL
SilenceStartTime	string	The start time of the silence period. Format: HH:mm:ss.	00:00:00
SilenceEndTime	string	The end time of the silence period. Format: HH:mm:ss.	00:00:00
AlertInterval	integer	The alert interval for event alerts. Unit: seconds.	900
AlertMaximum	integer	The maximum number of alerts for event alerts.	1
DingRobots	array<object>	The DingTalk chatbot configurations.
	object	The DingTalk chatbot configuration.
WebUrl	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=xxx
AtAll	boolean	Indicates whether to mention all group members.	true
Webhooks	array	The webhook URLs.
	string	The webhook URL of the WeCom or Lark chatbot. Separate multiple URLs with commas (,). The alertMethods parameter must include WEBHOOKS. This feature is available only in DataWorks Enterprise Edition. Supported 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 event alert types.
	string	The event alert type. Valid values: SLOW ERROR	SLOW
BaselineAlertEnabled	boolean	Indicates whether baseline alerting is enabled. Valid values: true false	false
AlertRecipientType	string	The alert recipient type. Valid values: OWNER: task owner OTHER: designated person SHIFT: on-duty schedule	OWNER
AlertRecipient	string	The alert recipient. The value varies based on AlertRecipientType: If AlertRecipientType is set to OWNER, leave this parameter empty. If AlertRecipientType is set to SHIFT, set this parameter to the UID of an on-duty schedule. If AlertRecipientType is set to OTHER, set this parameter to a list of UIDs separated by commas (,).	123123
RequestId	string	The request ID.	ecb967ec-c137-48a5-860****

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.