APIを使用したマシングループの詳細の取得

この記事では、APIを使用してZscaler Private Access (ZPA)のマシン グループのユース ケースを管理する方法について説明します。すべてのAPIはレート制限されています。詳細は、「レート制限について」を参照してください。

すべてのマシングループの詳細を取得する

すべてのマシン グループの詳細を取得するには、以下の操作を行ってください。

  1. GET要求をmachine-group-controllerの次のエンドポイントに送信します：/mgmtconfig/v1/admin/customers/{customerId}/machineGroup。
  2. リクエストエンドポイントで、顧客のZPAテナントIDであるcustomerIdを提供します。例：/mgmtconfig/v1/admin/customers/72057615512764416/machineGroup。
  • {
  "totalPages": "1",
  "list": [
    {
      "id": "73196561382769734",
      "creationTime": "1612770231",
      "modifiedBy": "73196561382768641",
      "name": "Example machine group 1 DND",
      "enabled": true
    }
  ]
}
    閉じる

正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

本APIはページネーションに対応しています。ページ分割されたレスポンスを取得する手順は次のとおりです。

  1. GET要求を次のエンドポイントに送信します：/mgmtconfig/v1/admin/customers/{customerId}/machineGroup?page=1&pagesize=20。
  2. リクエストエンドポイントに以下を提供します。
  • [customerId]：顧客のZPAテナントIDです。
  • ページおよびページサイズのパラメータに有効な値。

例：/mgmtconfig/v1/admin/customers/217246660302995456/machineGroup?page=1&pagesize=2.

  • {
  "totalPages": "2",
  "list": [
    {
      "id": "217246660303025140",
      "creationTime": "1624496602",
      "modifiedBy": "217246660303023906",
      "name": "test_machine_group",
      "enabled": true,
      "description": "test_machine_group"
    },
    {
      "id": "217246660303023893",
      "creationTime": "1594844294",
      "modifiedBy": "72057594037935690",
      "name": "Test",
      "enabled": true,
      "description": "test"
    }
  ]
}
    閉じる

提供されない場合、デフォルトのページサイズは20です。最大ページサイズは500です。

正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

このAPIは、機能とフィールドで検索する検索オプションをサポートしています。機能とフィールドで検索する手順は次の通りです。

  1. GET要求を次のエンドポイントに送信します：/mgmtconfig/v1/admin/customers/73186051597795328/machineGroup&search={searchString}。
  2. リクエストエンドポイントに以下を提供します。
  • [customerId]：顧客のZPAテナントIDです。
  • 有効な検索文字列の値。検索文字列の値はfieldName operator fieldValueの形式です。有効なフィールドとフィルターの値に対応する検索文字列の値のみがサポートされています。たとえば、この文字列name%20LIKE%20123は、フィルター値123に対して[次の値を含む](LIKE)演算子を使用して、[名前]のフィルターでサポートされます。

次に例を示します:/mgmtconfig/v1/admin/customers/73186051597795328/machineGroup&search=name%20LIKE%20123。

  • {
  "totalPages": "2",
  "totalCount": "2",
  "list": [
    {
      "id": "72057594037987359",
      "modifiedTime": "1646157983",
      "creationTime": "1610701957",
      "modifiedBy": "72057594038052745",
      "name": "123",
      "enabled": true,
      "description": "/><img src=x onerror=alert(document.cookie)>"
    }
  ]
}
    閉じる

ZPA APIポータルまたはリファレンス ガイドを使用してAPI呼び出しを行う場合、検索フィールドの文字列に文字は必要ありません。たとえば、name%20LIKE%20123はname LIKE 123です。

正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

特定のマシン　グループの詳細を取得する

特定のマシングループの詳細を取得する方法：

  1. GET要求をmachine-group-controllerの次のエンドポイントに送信します：/mgmtconfig/v1/admin/customers/{customerId}/machineGroup/{Id}。
  2. リクエストエンドポイントに以下の値を指定する。
  • [customerId]：顧客のZPAテナントIDです。
  • id：目的のコンピュータ グループのID。

例：/mgmtconfig/v1/admin/customers/72057615512764416/machineGroup/73196561382769734。

  • {
  "id": "73196561382769734",
  "creationTime": "1612770231",
  "modifiedBy": "73196561382768641",
  "name": "Example machine group 1 DND",
  "enabled": true
}
    閉じる

正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。