1 つのプロジェクトでの 1 つのアラート構成の状態を切り替える

PATCH /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}
サービス アカウント DigestAuth

指定されたプロジェクト内の、指定されたアラート設定を有効化または無効化します。現在有効になっている場合は、このリソースによってアラート設定が無効化されます。現在無効になっている場合は、このリソースによってアラート設定が有効化されます。

注: このエンドポイントは、アラート設定の有効化または無効化の状態のみを更新します。その他の設定を更新するには、「1 つのアラート設定の更新」をご覧ください。

このリソースは現在も改訂中であり、変更される可能性があります。

ロールの要件
  • プロジェクト アラート マネージャー
1 つのアラート構成の更新

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

  • alertConfigId string 必須

    このアラートをトリガーしたアラート設定を識別する一意の 24 桁の 16 進数文字列です。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

  • pretty ブール値

    レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

    デフォルト値はfalseです。

    Prettyprint
application/ JSON

body 必須

指定されたプロジェクト内の指定されたアラート構成を有効または無効にします。

  • enabled ブール値

    指定されたプロジェクトで指定されたアラート構成を有効にするか無効にするかを示すフラグ。

応答

  • 200 application/ JSON

    OK

    次の 1 つ：
    その他のアラート構成 オブジェクト アプリ Services アラート構成 オブジェクト App Services メトリクス アラート構成 オブジェクト 請求しきい値アラート構成 オブジェクト クラスター アラート構成 オブジェクト Cps バックアップしきい値アラート構成 オブジェクト 暗号化のキー アラート構成 オブジェクト ホスト アラート構成 オブジェクト ホスト メトリクス アラート構成 オブジェクト インテリジェントワークロードマネジメントアラート構成 オブジェクト NDS オートスケーリング アラート構成 オブジェクト X509 ユーザー認証アラート構成 オブジェクト レプリカセット アラート構成 オブジェクト ReplicaSetThresholdAlertConfigViewForNdsGroup オブジェクト サーバーレス アラート構成 オブジェクト Flex Alert Configuration オブジェクト ストリーム プロセッサのアラート構成 オブジェクト ストリーム プロセッサ メトリクス アラート構成 オブジェクト