レート制限ポリシーを取得

GET https://{tenantDomain}/api/v2/rate-limit-policies

レート制限ポリシーを取得する

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/rate-limit-policies \
  --header 'Authorization: Bearer <token>'

200

{
  "next": "<string>",
  "rate_limit_policies": [
    {
      "configuration": {},
      "consumer_selector": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

resource · enum<string>

レート制限ポリシーで保護される API。

利用可能なオプション: oauth_authentication_api

consumer · enum<string>

レート制限ポリシーが適用されるコンシューマー。

利用可能なオプション: client

consumer_selector · string

ポリシーが適用される、コンシューマー内の識別子またはカテゴリ。サポート対象の値: 特定のクライアントを ID で対象にする client_id:<client_id>、URI で CIMD クライアントを対象にする client_id:<cimd_uri>、すべての CIMD クライアントを対象にする cimd_clients、すべてのサードパーティ クライアントを対象にする third_party_clients、または、明示的に対象として指定されていない任意のコンシューマー識別子にポリシーを適用する default。

Maximum string length: 255

take · integer

1 ページあたりの結果数。デフォルトは 50 です。

必須範囲: 1 <= x <= 100

from · string

ページネーション用のカーソル。

Maximum string length: 1000

レスポンス

200

application/json

レート制限ポリシーを正常に取得しました。

next · string

結果の次ページで "from" クエリパラメーターとして使用するカーソルです。

rate_limit_policies · object[]

Show child attributes