[VMC on AWS] NSX VMC ポリシー API を使用して 1000 個以上のオブジェクトを表示できない

Products

• VMware Cloud on AWS

Issue/Introduction

この記事では、NSX VMC Policy API を使用して全てのオブジェクトを取得する方法をご紹介します。

Symptoms:
免責事項：これは英文の記事「[VMC on AWS] Unable to list more than 1000 objects using NSX VMC Policy API」の日本語訳です。記事はベストエフォートで翻訳を進めているため、ローカライズ化コンテンツは最新情報ではない可能性があります。最新情報は英語版の記事で参照してください。

NSX VMC Policy API を使用して 1,000 個以上のオブジェクトを一覧表示できません。例えば、以下のように REST API を使用して VMC NSX-T のグループを表示する場合、最大で 1,000 個までしか表示されません。

https://nsx-xxx-xxx-xxx-xxx.rp.vmwarevmc.com/vmc/reverse-proxy/api/orgs/${org_id}/sddcs/${sddc_id}/policy/api/v1/infra/domains/cgw/groups

Cause

API では全てのオブジェクトの情報を取得できますが、個々のリクエストで返される結果は最大で 1,000 個となります。

Resolution

result_count を使用してオブジェクトのエントリの総数を決定し、cursor プロパティを使用して繰り返し処理を行う必要があります。もし、合計で 10,000 個のオブジェクトがある場合、10 回の API コールを行う必要があります (それぞれ 1,000 個ずつ結果を返します)。

例えば、/infra.domains/cgw/groups を取得すると以下のような結果になります。

  "result_count" : 10000,
  "sort_by" : "display_name",
  "sort_ascending" : true,
  "cursor" : "00041000"

次の 1,000 個を取得する場合、/infra/domains/cgw/groups?cursor=00041000 のように URL を指定します。

詳細は以下の記事を参照してください。

NSX VMC Policy API API Guide
https://vdc-download.vmware.com/vmwb-repository/dcr-public/62b26deb-b411-41e5-82ad-9375d3777cbe/66dc4337-e5ad-402a-9718-eb6854861775/nsx_api_vmc.html

Additional Information

VMware は現在、デベロッパー サポート サービスを提供しており、ベストプラクティス、サンプル コード、およびガイダンスを提供しています。さらにサポートが必要な場合は、VMware SDK および API サポート プログラムの購入をご検討ください。

VMware SDK and API Support
https://www.vmware.com/support/services/sdk.html

VMware SDK Developer Support Program (1029840)
https://kb.vmware.com/s/article/1029840