APIを使用したマシングループの詳細の取得
この記事では、APIを使用してZscaler Private Access (ZPA)のマシン グループのユース ケースを管理する方法について説明します。すべてのAPIはレート制限されています。詳細は、「レート制限について」を参照してください。
すべてのマシングループの詳細を取得する
すべてのマシン グループの詳細を取得するには、以下の操作を行ってください。
GET
要求をmachine-group-controllerの次のエンドポイントに送信します:/mgmtconfig/v1/admin/customers/{customerId}/machineGroup
。- リクエストエンドポイントで、顧客のZPAテナントIDである
customerId
を提供します。例:/mgmtconfig/v1/admin/customers/72057615512764416/machineGroup
。
正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。
本APIはページネーションに対応しています。ページ分割されたレスポンスを取得する手順は次のとおりです。
GET
要求を次のエンドポイントに送信します:/mgmtconfig/v1/admin/customers/{customerId}/machineGroup?page=1&pagesize=20
。- リクエストエンドポイントに以下を提供します。
- [
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は、機能とフィールドで検索する検索オプションをサポートしています。機能とフィールドで検索する手順は次の通りです。
GET
要求を次のエンドポイントに送信します:/mgmtconfig/v1/admin/customers/73186051597795328/machineGroup&search={searchString}
。- リクエストエンドポイントに以下を提供します。
- [
customerId
]:顧客のZPAテナントIDです。 - 有効な検索文字列の値。検索文字列の値は
fieldName operator fieldValue
の形式です。有効なフィールドとフィルターの値に対応する検索文字列の値のみがサポートされています。たとえば、この文字列name%20LIKE%20123
は、フィルター値123
に対して[次の値を含む](LIKE
)演算子を使用して、[名前]のフィルターでサポートされます。
次に例を示します:/mgmtconfig/v1/admin/customers/73186051597795328/machineGroup&search=name%20LIKE%20123
。
ZPA APIポータルまたはリファレンス ガイドを使用してAPI呼び出しを行う場合、検索フィールドの文字列に文字は必要ありません。たとえば、name%20LIKE%20123
はname LIKE 123
です。
正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。
特定のマシン グループの詳細を取得する
特定のマシングループの詳細を取得する方法:
GET
要求をmachine-group-controllerの次のエンドポイントに送信します:/mgmtconfig/v1/admin/customers/{customerId}/machineGroup/{Id}
。- リクエストエンドポイントに以下の値を指定する。
- [
customerId
]:顧客のZPAテナントIDです。 id
:目的のコンピュータ グループのID。
例:/mgmtconfig/v1/admin/customers/72057615512764416/machineGroup/73196561382769734
。
正常なレスポンスは、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。