APIを使用した、切断されたApp Connectorの自動削除の設定

この記事では、ZPA クラウドサービスAPIを使用して、切断されたApp Connectorの自動削除を設定する方法について説明します。すべてのAPIはレート制限されています。詳細は、レート制限についての詳しい説明を参照してください。

切断されたApp Connectorの自動削除を設定する

切断されたApp Connectorの自動削除を設定するには、次の手順を実行します。

  1. POSTリクエストをconnector-controllerの次のエンドポイントに送信します:/mgmtconfig/v1/customer/{customerId}/connectorSchedule
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

たとえば、/mgmtconfig/v1/customer/145259576743165952/connectorSchedule

  1. 要求のコンテキストに関する情報を提供するために、リクエスト ヘッダーを含めます。
  • [コンテンツタイプ]:application/json
  • [認証]:Bearer<access_token>
  1. 次のJSONペイロードを使用し、次の詳細を入力して、自動削除の頻度を設定します。
  • [customerId]:顧客のZPAテナントIDです。
  • frequency:切断されたApp Connectorを削除対象とする頻度を設定します。サポートされている値はdaysです。
  • frequencyInterval: App Connectorが切断されてから削除対象とみなされるまでの日数。サポートされる最小値は5です。

成功した場合、Code 204 No Contentのレスポンスが返されます。これは、App Connector設定で自動削除の頻度が正常に有効化されたことを意味します。詳細については、APIレスポンス コードとエラー メッセージを参照してください。

切断されたApp Connectorの自動削除の頻度を取得する

切断されたApp Connectorの自動削除の頻度を取得するには、次の操作を実行します。

  1. GETリクエストをconnector-controllerの次のエンドポイントに送信します:/mgmtconfig/v1/customer/{customerId}/connectorSchedule
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

たとえば、/mgmtconfig/v1/customer/145259576743165952/connectorSchedule

  • {
       "id": 9,
       "frequencyInterval": 5,  
       "frequency": "days",
       "enabled": true,
       "customerId": 145259576743165952,
       "deleteDisabled": true,  
    }
    
    閉じる

応答が成功すると、コード200が返されます。詳細は、API応答コードとエラー メッセージを参照してください。

切断されたApp Connectorの自動削除の頻度を更新する

切断されたApp Connectorの自動削除の頻度を更新するには、次の操作を実行します。

  1. PUTリクエストをconnector-controllerの次のエンドポイントに送信します:/mgmtconfig/v1/customer/{customerId}/connectorSchedule/{id}
  2. リクエストエンドポイントに以下を提供します。

たとえば、/mgmtconfig/v1/customer/145259576743165952/connectorSchedule/9

  1. 要求のコンテキストに関する情報を提供するために、リクエスト ヘッダーを含めます。
  • [コンテンツタイプ]:application/json
  • [認証]:Bearer<access_token>
  1. 次のJSONペイロードを使用し、次の詳細を入力して、自動削除の頻度を設定します。
  • [customerId]:顧客のZPAテナントIDです。
  • frequency:切断されたApp Connectorを削除する頻度を設定します。サポートされている値はdaysです。
  • frequencyInterval:自動削除の頻度がトリガーされる間隔。サポートされる最小値は5です。

成功した場合、Code 204 No Contentのレスポンスが返されます。これは、App Connector設定で自動削除の頻度が正常に更新されたことを意味します。詳細については、APIレスポンス コードとエラー メッセージを参照してください。

フィールドの定義の追加

フィールド説明必須
アイド顧客のApp Connector自動削除設定の一意の識別子。このフィールドは、App Connector設定の頻度を更新するため、PUTリクエストでのみ必要です。いいえ

整数

サポートされる最小値は5です。

頻度切断されたApp Connectorを削除する、設定された頻度。はい

文字列

サポートされている値: days

frequencyInterval設定された頻度の値の間隔。サポートされる最小値は5です。はい整数
deleteDisabledfrequencyIntervalfrequencyの値に基づいて、App Connectorが切断された状態にある場合に、削除の対象になるかどうかを示します。はいブール値:truefalse
有効App Connectorを削除するための設定が有効か無効かを示しますはいブール値:truefalse