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