APIキーの設定変更
/console/v1/accounts/{accountId}/projects/{projectId}/keys/{keyId}APIキーの名前、有効期限、ルール、設定を変更します。
認証
Authorizationstring必須Bearer <マネジメントトークン> の形式で指定します。
詳しくは認証を参照してください。
パスパラメーター
accountIdstring必須組織のID。
コンソールのURLの /accounts/ に続く部分です。
projectIdstring必須プロジェクトのID。
プロジェクト一覧の projectId で取得できます。
keyIdstring必須APIキーのID。
APIキー一覧の keyId で取得できます。
リクエストボディ
変更するフィールドだけを指定します。
keyAliasstringAPIキーの名前。 1〜100文字で指定します。
expiresInDaysinteger有効期限までの日数。 1〜3650の整数で指定します。 有効期限は、リクエストの時点から数えた日時になります。
ruleIdstring | null適用するルールのID。
null を指定すると、ルールの適用を解除します。
inheritSettingsstring[]個別の指定を取り消す設定の名前の配列。
["rpmLimit"] のように指定します。
取り消した設定は、ルールの値またはデフォルト値に戻ります。
maxBudgetMicroJpyinteger | null予算の上限。
円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。
rpmLimitinteger | null1分あたりのリクエスト数(RPM)の上限。
tpmLimitinteger | null1分あたりのトークン数(TPM)の上限。
modelsstring[]利用を許可するモデルのID(UUID)の配列。
推論APIの model に指定するIDとは異なります。
空の場合は、組織で許可されているすべてのモデルを利用できます。
autoCandidatesstring[]model に auto を指定したときに、候補にするモデルのID(UUID)の配列。
routingStrategystring | nullauto の候補から選ぶ方法。
cheapest を指定すると、価格の安い順に選びます。
fallbackModelsstring[]指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。
forceAutobooleanauto 以外のモデルの指定を拒否するかどうか。
guardrailsarrayリクエストをモデルへ送る前に行う検査(ガードレール)。
pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。
詳しくはガードレールを参照してください。
レスポンス
keyobject変更後のAPIキー。
フィールドを表示フィールドを非表示
keyIdstringAPIキーのID。
keyAliasstringAPIキーの名前。
projectIdstringプロジェクトのID。
ruleIdstring | null適用しているルールのID。
expiresAtstring有効期限(ISO 8601)。
blockedboolean無効にしているかどうか。
spendMicroJpyinteger | null利用額。 円の金額を1,000,000倍した整数です。 APIキー一覧でのみ値が入ります。
budgetDurationstring | null予算の期間。
day、week、month のいずれかです。
nextBudgetResetAtstring | null次に予算がリセットされる日時。
maxBudgetMicroJpyinteger | null予算の上限。
円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。
rpmLimitinteger | null1分あたりのリクエスト数(RPM)の上限。
tpmLimitinteger | null1分あたりのトークン数(TPM)の上限。
modelsstring[]利用を許可するモデルのID(UUID)の配列。
推論APIの model に指定するIDとは異なります。
空の場合は、組織で許可されているすべてのモデルを利用できます。
autoCandidatesstring[]model に auto を指定したときに、候補にするモデルのID(UUID)の配列。
routingStrategystring | nullauto の候補から選ぶ方法。
cheapest を指定すると、価格の安い順に選びます。
fallbackModelsstring[]指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。
forceAutobooleanauto 以外のモデルの指定を拒否するかどうか。
guardrailsarrayリクエストをモデルへ送る前に行う検査(ガードレール)。
pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。
詳しくはガードレールを参照してください。
individualSettingsobjectこのAPIキーに個別に指定した設定。
settingSourcesobject設定ごとの値の出どころ。
rule(ルール)、individual(個別の指定)、default(デフォルト値)のいずれかです。
エラー
エラーの形式はエラーを参照してください。
| ステータスコード | error | 原因 |
|---|---|---|
400 | bad_request | リクエストボディの形式や値が正しくない、または指定したルールやモデルを利用できない |
401 | console_authentication_failed | マネジメントトークンが正しくない、または有効期限が切れている |
403 | console_authorization_denied | 操作する権限がない、または組織やプロジェクトが有効な状態ではない |
404 | not_found | リソースが見つからない、またはIDの形式が正しくない |
503 | console_keys_unavailable | サービスが一時的に利用できない |