APIキーの発行
/console/v1/accounts/{accountId}/projects/{projectId}/keysAPIキーを発行します。 発行は、次の2つの手順で行います。
- このAPIを呼び出して、レスポンスの
key.key(APIキーの値)を保存する。 - 60分以内に発行・再生成の確定を呼び出す。確定すると、APIキーを利用できる。
応答を受け取れなかった場合は、同じ operationId と attemptId のまま、recovery に true を指定して再送します。
認証
Authorizationstring必須Bearer <マネジメントトークン> の形式で指定します。
詳しくは認証を参照してください。
パスパラメーター
accountIdstring必須組織のID。
コンソールのURLの /accounts/ に続く部分です。
projectIdstring必須プロジェクトのID。
プロジェクト一覧の projectId で取得できます。
リクエストボディ
keyAliasstring必須APIキーの名前。 1〜100文字で指定します。
expiresInDaysinteger必須有効期限までの日数。 1〜3650の整数で指定します。
operationIdstring必須この操作を識別するためのID。
550e8400-e29b-41d4-a716-446655440000 のような形式のID(UUID)を、自分で生成して指定します。
確定するときに、URLに指定します。
attemptIdstring必須確定するときの照合に使うID。 UUIDを自分で生成して指定します。 確定するときに、同じ値をリクエストボディに指定します。
recoveryboolean必須再送かどうか。
最初のリクエストでは false、応答を受け取れずに再送する場合は true を指定します。
ruleIdstring | null適用するルールのID。 ルールで設定しているフィールドは、個別には指定できません。
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(プロンプトインジェクションの拒否)を指定できます。
詳しくはガードレールを参照してください。
レスポンス
operationIdstringリクエストで指定した値。
attemptIdstringリクエストで指定した値。
keyobject発行したAPIキー。
フィールドを表示フィールドを非表示
keystringAPIキーの値。 このレスポンスでのみ取得できます。
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の形式が正しくない |
409 | key_provisioning_conflict | 同じ operationId の操作がすでにある、または attemptId が一致しない |
503 | console_keys_unavailable | サービスが一時的に利用できない |