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

プロジェクト内のデータ品質アラートルールの一覧を照会します。

操作説明

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:ListDataQualityAlertRules

list

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	プロジェクト ID です。	10001
DataQualityScanId	integer	任意	アラートルールが対象とするデータ品質モニターの ID です。	10001
SortBy	string	任意	ソートフィールドの一覧です。最終更新時刻や作成時刻などのフィールドをサポートしています。形式は「SortField+SortOrder (Desc/Asc)」で、Asc がデフォルトです。有効な値は以下のとおりです。 CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageNumber	integer	必須	結果のページ番号です。	1
PageSize	integer	必須	1 ページあたりに返されるレコード数です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答です。
RequestId	string	リクエスト ID です。	0bc14115***159376359
PageInfo	object	アラートルールの構成です。
TotalCount	integer	返されたエントリの総数です。	335
PageNumber	integer	現在のページ番号です。	1
PageSize	integer	1 ページあたりのレコード数です。	10
DataQualityAlertRules	array<object>	アラートルール構成の一覧です。
	array<object>	アラートルールの構成です。
Condition	string	アラート条件です。	results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }
Target	object	データ品質アラートルールの監視対象です。
Type	string	監視対象のタイプです。DataQualityScan のみサポートされています。	DataQualityScan
Ids	array	監視対象 ID の一覧です。
	integer	監視対象の ID です。	7638999336
ProjectId	integer	プロジェクト ID です。	59094
Id	integer	データ品質モニターアラートルールの ID です。	26433
Notification	object	アラート通知の構成です。
Receivers	array<object>	アラート受信者です。
	object	アラート受信者です。
Extension	string	アラート受信者に必要な追加構成です。ReceiverType が DingdingUrl の場合、`{"atAll":true}` を設定して全メンバーをメンションできます。	{"atAll":true}
ReceiverType	string	アラート受信者のタイプです。 ShiftSchedule WebhookUrl FeishuUrl TaskOwner WeixinUrl DingdingUrl DataQualityScanOwner AliUid	AliUid
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******
Channels	array	Channels では、Email と Sms の両方を同時に設定できます。それ以外の場合、1 つのチャンネルのみ設定可能です。
	string	アラートチャンネルです。 Mail Weixin Feishu Phone Sms Webhook	Sms

例

成功レスポンス

JSONJSON

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 335,
    "PageNumber": 1,
    "PageSize": 10,
    "DataQualityAlertRules": [
      {
        "Condition": "results.any { r -> r.status == 'fail' && r.rule.severity == 'High' }",
        "Target": {
          "Type": "DataQualityScan",
          "Ids": [
            7638999336
          ]
        },
        "ProjectId": 59094,
        "Id": 26433,
        "Notification": {
          "Receivers": [
            {
              "Extension": "{\"atAll\":true}",
              "ReceiverType": "AliUid",
              "ReceiverValues": [
                "https://oapi.dingtalk.com/robot/send?access_token=a30bae7******"
              ]
            }
          ],
          "Channels": [
            "Sms"
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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