GetDataQualityAlertRule - 擷取資料品質警示規則 - DataWorks

根據警示規則ID查詢對應的資料品質監控警示規則詳情。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:GetDataQualityAlertRule

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	否	資料品質監控警示規則 ID。	113642

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	0bc14115****159376359
DataQualityAlertRule	object	資料品質監控警示規則。
Id	integer	資料品質監控警示規則 ID。	21045
Condition	string	資料品質監控警示規則警示條件。	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
ProjectId	integer	專案 ID。	90912
Target	object	資料品質監控警示規則關注目標。
Type	string	監控對象的類型，只支援 `DataQualityScan`。	DataQualityScan
Ids	array	監控目標 ID 列表。
	integer	監控物件識別碼。	113647
Notification	object	警示通知配置。
Channels	array	Channels 中，除可以同時設定 Email 和 Sms 外，其他的情況都只能設定一種渠道。
	string	警示通道。 Dingding Mail Weixin Feishu Phone Sms Webhook	Dingding
Receivers	array<object>	警示接收對象。
	object	警示接收對象。
Extension	string	警示對象需要的額外配置，當 ReceiverType 為 DingdingUrl，支援設定 `{"atAll":true}` @所有人。	{"atAll":true}
ReceiverType	string	警示接收物件類型。 ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	TaskOwner
ReceiverValues	array	警示接收對象值。
	string	警示接收對象值。當 ReceiverType 為 AliUid 時填阿里雲 UID 當 ReceiverType 為 ShiftSchedule 時填值班表 ID 當 ReceiverType 為 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 時填入對應的 URL。	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

樣本

正常返回樣本

JSON格式

{
  "RequestId": "0bc14115****159376359",
  "DataQualityAlertRule": {
    "Id": 21045,
    "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
    "ProjectId": 90912,
    "Target": {
      "Type": "DataQualityScan",
      "Ids": [
        113647
      ]
    },
    "Notification": {
      "Channels": [
        "Dingding"
      ],
      "Receivers": [
        {
          "Extension": "{\"atAll\":true}",
          "ReceiverType": "TaskOwner",
          "ReceiverValues": [
            "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
          ]
        }
      ]
    }
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。