GetDataQualityAlertRule - DataWorks - Alibaba Cloud ドキュメントセンター

アラートルール ID に基づいて、データ品質モニタリングおよびアラートルールの詳細を照会します。

操作説明

DataWorks ベーシック版以上をご購入いただく必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:GetDataQualityAlertRule

get

*All Resource

*

なし

リクエスト構文

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	監視対象 ID。	113647
Notification	object	アラート通知設定。
Channels	array	チャンネルでは、メールと SMS の両方を同時に設定できます。その他の場合は、1つのチャンネルのみ設定できます。
	string	アラートチャンネル。 Dingding メール Weixin Feishu 電話 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` の場合、Alibaba Cloud アカウント ID を入力します。 ReceiverType が `ShiftSchedule` の場合、勤怠表 ID を入力します。 ReceiverType が `WebhookUrl`、`DingdingUrl`、`FeishuUrl`、または `WeixinUrl` の場合、対応する URL を入力します。	https://oapi.dingtalk.com/robot/send?access_token=a30bae7******

例

成功レスポンス

JSONJSON

{
  "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******"
          ]
        }
      ]
    }
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。