機能の概要
このAPIは、新しいAI APIキーを作成するために使用します。作成されたAPIキーは、指定された組織とプロジェクトに帰属します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/maas/apikeys
リクエストパラメータ
リクエストヘッダー
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| Authorization | string | はい | IAM認証情報。 | -u ak:sk |
| requestId | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-Request-Id | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-OB-Org-Id | string | はい | 組織ID。すべてのAPIで必須です。 | org-xxxxxxxx |
| X-OB-Project-Id | string | はい | プロジェクトID。すべてのAPIで必須です。 | proj-xxxxxxxx |
| X-Ob-Product | string | いいえ | 出力元製品識別子。指定時はサポートされている製品の列挙値である必要があります。 | - |
クエリパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| uid | string | いいえ | アカウントID。ネットワークからの入力が必要です。欠落している場合はINVALID_PARAMETERを返します。 | - |
リクエストボディ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| name | string | はい | APIキーの名前。 | my-api-key |
| action | string | はい | APIキーの権限操作。 | read |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | object | 戻されるデータオブジェクト。 |
| data.apiKey | string | 新しく作成されたAPIキーの値。 |
| data.name | string | APIキーの名前。 |
| data.createdAt | string | APIキーの作成日時。 |
| requestId | string | このリクエストの一意の識別子。 |
| server | string | リクエストを処理したサーバーアドレス。 |
| success | boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl -X POST \
https://api-cloud.oceanbase.com/api/v2/maas/apikeys \
-H 'X-OB-Org-Id: org-xxxxxxxx' \
-H 'X-OB-Project-Id: proj-xxxxxxxx' \
-H 'Content-Type: application/json' \
-u '<Your AK:SK>' \
-d '{
"name": "my-api-key",
"action": "read"
}'
戻り値例
{
"data": {
"apiKey": "sk_xxxxxxxxxxxxxxxx",
"name": "my-api-key",
"createdAt": "2023-10-12T09:45:30Z"
},
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}