レート制限ポリシーの作成

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

レート制限ポリシーを作成する

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/rate-limit-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {},
  "consumer_selector": "<string>"
}
'

201

{
  "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.

ボディ

application/jsonapplication/x-www-form-urlencoded

configuration · object · 必須

レート制限ポリシーの設定。

Option 1

Option 2

Option 3

Show child attributes

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

resource · enum<string> · 必須

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

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

レスポンス

201

application/json

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

configuration · object · 必須

レート制限ポリシーの設定。

Option 1

Option 2

Option 3

Show child attributes

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

id · string<rate-limit-policy-id> · 必須

レート制限ポリシーの一意の識別子。

Maximum string length: 26

resource · enum<string> · 必須

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

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

created_at · string<date-time>

このレート制限ポリシーが作成された日時。

updated_at · string<date-time>

このレート制限ポリシーが最後に更新された日時。