一覧取得¶
GET /api/v1/alert_policy/list
概要¶
現在のワークスペースで未削除のアラートポリシー、バインド数、現在のアイデンティティの操作権限をページングして一覧表示します。
呼び出し前と使用手順¶
デフォルトでは pageIndex=1、pageSize=20 で、更新時間の降順に並びます。更新されていないレコードは作成時間で比較されます。有効および無効のポリシーが含まれます。content.data およびトップレベルの pageInfo を読み取ります。通知先のフィルタリングには英語のカンマで連結した UUID 文字列を使用し、複数のオブジェクトのいずれかが一致すれば選択されます。現在は設定テキストによるマッチングのため、正確な構造的関連性やターゲットの有効性を単独で証明することはできず、詳細を確認する必要があります。返される silentTimeout は互換表示の正規化が行われます。非ゼロの整数が 300 未満の場合は 300 となり、整数でない履歴値は 900 と表示されます。現在のバージョンではトップレベルの ruleTimezone が保存および表示されますが、実行時のキャッシュは履歴の alertOpt.ruleTimezone を読み取り、省略時は Asia/Shanghai です。他のタイムゾーンは保存に成功しただけでは有効になったと判断できず、連携側は実際の実行タイムゾーンに基づいて検証する必要があります。宣言されていない追加フィールドで公開パラメータを回避しないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| notifyObjectUUIDs | commaArray | オプションの通知先フィルターです。複数指定時はいずれかが一致すれば対象になります。実際の UUID 文字列を渡し、正規表現や JSON 配列は渡さないでください。特殊な正規表現文字は内部エラーを引き起こす可能性があります。 null 許可: False 例: notify_example取得または入力方法: 通知先一覧から 1 つまたは複数の UUID をコピーし、複数項目は英語のカンマで連結します(例: notify_a,notify_b)。 |
|
| pageIndex | integer | ページ番号。デフォルトは 1、最小値は 1 です。 null 許可: False $minValue: 1 例: 1取得または入力方法: 先頭ページは 1、以降はページごとに 1 ずつ増やします。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 20 です。 null 許可: False $maxValue: 100 $minValue: 1 例: 20取得または入力方法: 必要に応じて 1 から 100 までの整数を入力します。 |
|
| search | string | オプションの名前のあいまい検索です。 null 許可: True 例: 生产取得または入力方法: アラートポリシー名に含まれるテキストを入力します。省略または空白の場合、名前による絞り込みは行いません。 |
パラメータ補足¶
通知アクションを設定するための完全なフィールドについては、アラートポリシーを作成 v2を参照してください。この API では、checkerUUIDs、accountUUIDs、refFilter などの内部フィルターフィールドは宣言されていません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/alert_policy/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
現在のページのポリシー。結果がない場合は [] です。 |
| content.data[].id | integer または null | ポリシーレコード番号。作成レスポンスではまだ割り当てられていない場合があります。操作には uuid を使用します。 |
| content.data[].uuid | string | altpl_ アラートポリシー UUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース UUID。 |
| content.data[].name | string | ポリシー名。 |
| content.data[].desc | string | ポリシーの説明。 |
| content.data[].ruleTimezone | string | 保存済みエンティティのタイムゾーン。実行時の読み取り差異については使用手順を参照してください。タイムゾーンが有効になったことの証明にはなりません。 |
| content.data[].score | integer | ポリシーのスコアフィールド。作成時のデフォルトは 0 です。この公開リクエストではこのフィールドは提供されません。 |
| content.data[].openPermissionSet | boolean | カスタム操作権限のスイッチ。 |
| content.data[].permissionSet | array<string> |
操作可能なロール/メンバー/チームの識別子。 |
| content.data[].permissionSet[] | string | 単一の主体識別子。 |
| content.data[].status | integer | レコード状態。0 は有効、2 は無効、3 は削除済みです。一覧では未削除のポリシーが表示されます。 |
| content.data[].creator | string | 作成者のアイデンティティ。 |
| content.data[].updator | string | 最終更新者のアイデンティティ。 |
| content.data[].createAt | integer | 作成時間(Unix 秒)。 |
| content.data[].updateAt | integer | 更新時間(Unix 秒)。初期値は -1 です。 |
| content.data[].deleteAt | integer | 削除時間(Unix 秒)。未削除の場合は -1 です。 |
| content.data[].alertOpt | object | 保存済み設定: アラート通知設定オブジェクト。作成時に省略すると空の設定を保存でき、変更時は全体を置き換える形で渡します。オブジェクトを指定する場合、aggInterval は必須の検証フィールドです。 |
| content.data[].alertOpt.alertType | string | 保存済み設定: status はレベル別、member はメンバー別です。省略時は status がデフォルトです。2 つのモードでは targets の階層が異なるため、混在させないでください。 |
| content.data[].alertOpt.silentTimeout | integer | 保存済み設定: 統一の繰り返しアラート間隔。省略時の実行デフォルトは 900 秒です。0 は今回のラウンドで周期的な繰り返しを行わないことを意味します。非ゼロかつ 300 未満の場合は 300 秒として実行されます。null を渡さないでください。 |
| content.data[].alertOpt.silentTimeoutByStatusEnable | boolean | 保存済み設定: 作成時のデフォルトが false の場合は silentTimeout を使用します。true の場合は silentTimeoutByStatus に従って状態別の間隔を展開します。 |
| content.data[].alertOpt.silentTimeoutByStatus | array<object> |
保存済み設定: レベル別の繰り返し間隔配列。有効にする場合は、制御が必要なレベルを網羅する必要があります。このレベル別設定は、統一の silentTimeout における 300 秒の正規化を受けません。 |
| content.data[].alertOpt.silentTimeoutByStatus[] | object | 保存済み設定: レベル別間隔オブジェクト。 |
| content.data[].alertOpt.silentTimeoutByStatus[].status | string | 保存済み設定: 非セキュリティでは fatal/critical/error/warning/nodata/info/ALL を使用できます。セキュリティでは security_critical/security_high/security_medium/security_low/security_info/security_ALL を使用します。複数指定時は英語のカンマで連結し、スペースは入れません。 |
| content.data[].alertOpt.silentTimeoutByStatus[].silentTimeout | integer | 保存済み設定: 各グループで必須の繰り返し間隔(秒)。不正なレベルは内部エラーを引き起こす可能性があるため、送信前に検証してください。 |
| content.data[].alertOpt.aggInterval | integer | 保存済み設定: alertOpt を指定する場合に必須で、0 から 1800 秒です。0 は集約なしを意味し、byAI を選択しても有効な AI 集約が有効になるわけではありません。 |
| content.data[].alertOpt.aggFields | array<string> |
保存済み設定: フィールド一覧。定義済みでは df_monitor_checker_id、df_dimension_tags、df_label、CLUSTER を使用できます。byCustom モードでは業務固有のカスタムフィールドを使用でき、v2 の集約モードについては aggType を参照してください。 |
| content.data[].alertOpt.aggFields[] | string | 保存済み設定: 単一の集約フィールド。byCustom では実際のイベントフィールドに基づいて選択してください。表示名だけからフィールドを推測しないでください。 |
| content.data[].alertOpt.aggLabels | array<string> |
保存済み設定: タグによる集約のタグ値配列。df_label を選択する場合は空でない配列を指定する必要があります。 |
| content.data[].alertOpt.aggLabels[] | string | 保存済み設定: 単一のタグ値。 |
| content.data[].alertOpt.aggClusterFields | array<string> |
保存済み設定: スマート集約のテキストフィールド。CLUSTER を含める場合は、少なくとも df_title または df_message を選択する必要があります。 |
| content.data[].alertOpt.aggClusterFields[] | string | 保存済み設定: 単一のテキストフィールド。 |
| content.data[].alertOpt.alertTarget | array<object> |
保存済み設定: 通知ルール配列。status モードでは targets にレベル別アクションを配置し、member モードでは alertInfo 内でメンバーと通知方式を構成します。 |
| content.data[].alertOpt.alertTarget[] | object | 保存済み設定: ルールオブジェクト。フォールバックが必要な場合は、時間設定のないルールを明示的に追加してください。システムが自動的に補完するとは想定しないでください。 |
| content.data[].alertOpt.alertTarget[].name | string | 保存済み設定: オプションのルール名。最大 256 文字です。 |
| content.data[].alertOpt.alertTarget[].crontab | string | 保存済み設定: 周期開始時刻の式。crontabDuration とペアで指定する必要があります。カスタム日付方式とはどちらか一方を選択します。 |
| content.data[].alertOpt.alertTarget[].crontabDuration | integer | 保存済み設定: 周期ウィンドウの継続秒数。crontab を指定する場合は同時に指定する必要があります。繰り返し時間帯を設定しない場合は、両方とも省略します。 |
| content.data[].alertOpt.alertTarget[].customDateUUIDs | array<string> |
保存済み設定: カスタム日付セットの参照。最大 366 項目です。customStartTime、customDuration と一緒に指定し、crontabDuration で代用しないでください。 |
| content.data[].alertOpt.alertTarget[].customDateUUIDs[] | string | 保存済み設定: 単一の日付設定 UUID。 |
| content.data[].alertOpt.alertTarget[].customStartTime | string | 保存済み設定: カスタム日付当日の開始時刻。customDateUUIDs/customDuration と組み合わせて使用します。 |
| content.data[].alertOpt.alertTarget[].customDuration | integer | 保存済み設定: カスタム日付ウィンドウの継続秒数。日付セットおよび開始時刻と一緒に指定する必要があります。 |
| content.data[].alertOpt.alertTarget[].targets | array<object> |
保存済み設定: レベルモードのアクション配列。 |
| content.data[].alertOpt.alertTarget[].targets[] | object | 保存済み設定: 単一のレベルアクション。 |
| content.data[].alertOpt.alertTarget[].targets[].status | string | 保存済み設定: 必須のレベル選択。fatal、critical、error、warning、nodata、info を使用し、すべてを表す場合は大文字の ALL を使用します。複数指定時は英語のカンマで連結し、スペースは入れません。security ソースでは critical、high、medium、low、info または ALL を使用します。 |
| content.data[].alertOpt.alertTarget[].targets[].df_source | string | 保存済み設定: オプション。公開されたターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。 |
| content.data[].alertOpt.alertTarget[].targets[].to | array<string> |
保存済み設定: 必須の受信先配列。メンバー、チーム、通知先、またはメールアドレスを使用できます。エージェントアカウントでは、その有効なデフォルト Webhook を使用できます。 |
| content.data[].alertOpt.alertTarget[].targets[].to[] | string | 保存済み設定: member モードでは通常 email/sms/notify_ を使用します。status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかは、サイトおよびターゲットの設定によって異なります。 |
| content.data[].alertOpt.alertTarget[].targets[].tags | object | 保存済み設定: status モードではフィールド値でイベントを絞り込みます。member モードでは上位の alertInfo.filterString を使用する必要があり、ここでの tags はメンバー選択条件として扱われません。 |
| content.data[].alertOpt.alertTarget[].targets[].tags.字段 | array<object> |
保存済み設定: 単一フィールドの一致値配列。 |
| content.data[].alertOpt.alertTarget[].targets[].tags.字段[] | string | 保存済み設定: 単一の一致値。 |
| content.data[].alertOpt.alertTarget[].targets[].filterString | string | 保存済み設定: status モードで空でない場合は tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効な絞り込み入口として扱われません。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets | array<object> |
保存済み設定: オプションのエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] の場合はエスカレーションを設定しません。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[] | object | 保存済み設定: 単一のエスカレーションアクション。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].to | array<string> |
保存済み設定: member モードではエスカレーション受信メンバー/チームです。status モードではエスカレーション通知先で、メンバー/チーム/通知先/メールアドレスを使用できます。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].to[] | string | 保存済み設定: 単一のエスカレーション受信識別子。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].duration | integer | 保存済み設定: 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定され、複数の duration が自動的に累積されることはありません。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].toWay | array<string> |
保存済み設定: member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。 |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].toWay[] | string | 保存済み設定: 単一のエスカレーション通知方式。 |
| content.data[].alertOpt.alertTarget[].alertInfo | array<object> |
保存済み設定: member モードでのみ使用するメンバーグループ配列。status モードでは使用しません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[] | object | 保存済み設定: メンバーグループオブジェクト。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].name | string | 保存済み設定: オプションのメンバーグループ名。最大 256 文字です。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].memberInfo | array<string> |
保存済み設定: メンバーモードの通常通知における受信メンバー/チーム配列。エージェントアカウントを含めることができます。targets.to の通知方式と組み合わせます。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].memberInfo[] | string | 保存済み設定: 単一のメンバーまたはチーム識別子。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].filterString | string | 保存済み設定: メンバーグループレベルのイベント絞り込み。通常アクションとエスカレーションアクションの両方でこの条件を使用します。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets | array<object> |
保存済み設定: メンバーモードの通知方式/レベルアクション配列。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[] | object | 保存済み設定: 単一のレベルアクション。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].status | string | 保存済み設定: 必須のレベル選択。fatal、critical、error、warning、nodata、info を使用し、すべてを表す場合は大文字の ALL を使用します。複数指定時は英語のカンマで連結し、スペースは入れません。security ソースでは critical、high、medium、low、info または ALL を使用します。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].df_source | string | 保存済み設定: オプション。公開されたターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].to | array<string> |
保存済み設定: member モードでは通常 email、sms、または notify_ 通知先を使用し、通知方式を表します。実行レイヤーは直接のアカウント/チームなどのターゲットにも対応していますが、memberInfo と通知方式の組み合わせを優先することを推奨します。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].to[] | string | 保存済み設定: member モードでは通常 email/sms/notify_ を使用します。status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかは、サイトおよびターゲットの設定によって異なります。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags | object | 保存済み設定: status モードではフィールド値でイベントを絞り込みます。member モードでは上位の alertInfo.filterString を使用する必要があり、ここでの tags はメンバー選択条件として扱われません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags.字段 | array<object> |
保存済み設定: 単一フィールドの一致値配列。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags.字段[] | string | 保存済み設定: 単一の一致値。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].filterString | string | 保存済み設定: status モードで空でない場合は tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効な絞り込み入口として扱われません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets | array<object> |
保存済み設定: オプションのエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] の場合はエスカレーションを設定しません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[] | object | 保存済み設定: 単一のエスカレーションアクション。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to | array<string> |
保存済み設定: member モードではエスカレーション受信メンバー/チームです。status モードではエスカレーション通知先で、メンバー/チーム/通知先/メールアドレスを使用できます。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to[] | string | 保存済み設定: 単一のエスカレーション受信識別子。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].duration | integer | 保存済み設定: 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定され、複数の duration が自動的に累積されることはありません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay | array<string> |
保存済み設定: member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。 |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay[] | string | 保存済み設定: 単一のエスカレーション通知方式。 |
| content.data[].alertOpt.aggType | string | 保存済み設定: v2 のオプションモード。byFields はルール集約、byCluster はスマート集約、byAI は AI 集約、byCustom はカスタムフィールドのルール集約です。省略または null の場合は従来の aggFields ロジックに従います。集約には引き続き aggInterval>0 が必要です。 |
| content.data[].alertOpt.ignoreOK | boolean | 保存済み設定: v2 のオプション。正常レベルの通知を無視します。デフォルトは false です。 |
| content.data[].alertOpt.aggSendFirst | boolean | 保存済み設定: v2 のオプション。集約時に最初の 1 件をすぐに送信するかどうか。デフォルトは false です。aggInterval=0 の場合は有効な集約になりません。 |
| content.data[].creatorInfo | object | アイデンティティの表示情報。一致しない場合は {} で、以下のフィールドはアイデンティティに応じて任意です。 |
| content.data[].creatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.data[].creatorInfo.status | integer | アカウントレコードの状態。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースアカウントの状態。 |
| content.data[].creatorInfo.username | string | ログイン名。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.data[].creatorInfo.email | string | メールアドレスまたはシステムアイデンティティの表示値。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].updatorInfo | object | アイデンティティの表示情報。一致しない場合は {} で、以下のフィールドはアイデンティティに応じて任意です。 |
| content.data[].updatorInfo.uuid | string | アカウント UUID。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウントレコードの状態。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースアカウントの状態。 |
| content.data[].updatorInfo.username | string | ログイン名。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL。省略可能。 |
| content.data[].updatorInfo.email | string | メールアドレスまたはシステムアイデンティティの表示値。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].permissionSetInfo | object | permissionSet が存在する場合に提供されます。主体識別子をキーとする表示プロフィールのマッピングです。一致する主体がない場合は {} になります。 |
| content.data[].permissionSetInfo.标识 | object | アカウントの場合はアカウントプロフィール、ロール/チームの場合は通常 name と status です。 |
| content.data[].permissionSetInfo.标识.uuid | string | アカウント UUID。省略可能。 |
| content.data[].permissionSetInfo.标识.status | integer | アカウントレコードの状態。 |
| content.data[].permissionSetInfo.标识.wsAccountStatus | integer | ワークスペースアカウントの状態。 |
| content.data[].permissionSetInfo.标识.username | string | ログイン名。 |
| content.data[].permissionSetInfo.标识.name | string | 表示名。 |
| content.data[].permissionSetInfo.标识.iconUrl | string | アバター URL。省略可能。 |
| content.data[].permissionSetInfo.标识.email | string | メールアドレスまたはシステムアイデンティティの表示値。 |
| content.data[].permissionSetInfo.标识.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].permissionSetInfo.标识.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].permissionSetInfo.标识.acntWsNickname | string | ワークスペースのニックネーム。省略可能。 |
| content.data[].allow_operation | boolean または null | カスタム操作権限の判定。null は有効化されていないことを表し、引き続き API 権限に基づいて判定する必要があります。true/false は現在のアイデンティティに対するカスタム判定です。 |
| content.data[].ruleCount | integer | 現在集計されているバインド済みモニター/SLO/セキュリティルールの総数。 |
| content.data[].refCountInfo | object | 関連タイプ別にグループ化された件数。存在しないタイプは省略できます。 |
| content.data[].refCountInfo.trigger | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.self_built_trigger | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.smartMonitor | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.aiMonitor | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.slo | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.cspm | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.siem | integer | このタイプの関連件数。 |
| content.data[].refCountInfo.aba | integer | このタイプの関連件数。 |
| content.data[].refCheckerInfo | object | タイプ別にグループ化された関連モニター/SLO。フィールドは詳細のフラット配列とは異なります。 |
| content.data[].refCheckerInfo.类型 | array<object> |
trigger/self_built_trigger/smartMonitor/aiMonitor/slo などのタイプ配下の配列。 |
| content.data[].refCheckerInfo.类型[].uuid | string | モニター/SLO UUID。 |
| content.data[].refCheckerInfo.类型[].name | string | モニター/SLO 名。 |
| content.data[].refCheckerInfo.类型[].type | string | trigger/self_built_trigger/smartMonitor/aiMonitor/slo などのタイプ。 |
| content.data[].refCheckerInfo.类型[].status | integer | レコードの有効/無効状態。 |
| content.data[].refCheckerInfo.类型[].jsonScript | object | モニターが存在する場合のタイプ概要。SLO では省略できます。 |
| content.data[].refCheckerInfo.类型[].jsonScript.type | string または null | モニターの検出タイプ概要。 |
| content.data[].refSecurityRuleInfo | object | セキュリティルールタイプ別にグループ化された関連情報。 |
| content.data[].refSecurityRuleInfo.类型 | array<object> |
cspm/siem/aba などのタイプ配列。 |
| content.data[].refSecurityRuleInfo.类型[].uuid | string | セキュリティルール UUID。 |
| content.data[].refSecurityRuleInfo.类型[].name | string | セキュリティルール名。 |
| content.data[].refSecurityRuleInfo.类型[].type | string | セキュリティルールのタイプ(cspm/siem/aba など)。 |
| content.data[].refSecurityRuleInfo.类型[].status | integer | ルール状態。元の関連には削除済みルールが含まれる場合があります。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
| pageInfo | object | トップレベルのページング。 |
| pageInfo.pageIndex | integer | ページ番号。 |
| pageInfo.pageSize | integer | ページサイズ。 |
| pageInfo.count | integer | 現在のページの実際の件数。 |
| pageInfo.totalCount | integer | 一致する総件数。 |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "altpl_example",
"workspaceUUID": "wksp_example",
"name": "生产服务告警",
"desc": "生产服务异常通知与升级。",
"alertOpt": {
"alertType": "status",
"aggInterval": 0,
"silentTimeout": 900,
"alertTarget": [
{
"name": "默认通知",
"targets": [
{
"status": "critical",
"to": [
"notify_example"
]
}
]
}
]
},
"ruleTimezone": "Asia/Shanghai",
"score": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"ruleCount": 0,
"refCountInfo": {},
"refCheckerInfo": {},
"refSecurityRuleInfo": {},
"creatorInfo": {},
"updatorInfo": {},
"allow_operation": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 500 | ft.InternalServerError | ポリシー、バインド統計、権限、またはアカウントプロフィールの取得に失敗しました | 内部エラー | 後で再試行してください。失敗が続く場合は traceId を提供してください。 |