機能の概要
APIキーの一意の識別子（UUID）に基づき、指定されたプロジェクト内のAPIキーを削除します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/maas/apikeys
リクエストパラメータ
クエリパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| uid | string | いいえ | アカウントID。ネットワークで入力されます。欠落している場合、INVALID_PARAMETERを返します。 | {uid} |
| id | string | はい | 削除するAPIキーのUUID。 | ak-xxxxxxxxxxxxxxxx |
リクエストヘッダーパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| Authorization | string | はい | IAM認証情報。 | -u ak:sk |
| requestId | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-Request-Id | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-OB-Org-Id | string | はい | 組織ID。すべてのインターフェースで必須です。 | org-xxxxxxxx |
| X-OB-Project-Id | string | はい | プロジェクトID。すべてのインターフェースで必須です。 | proj-xxxxxxxx |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| action | string | リクエストアクション。リクエストパラメータActionに対応します。 |
| data | object | 返されるデータオブジェクト。 |
| error | object | エラー情報オブジェクト。 |
| message | string | リクエスト結果の説明情報。 |
| requestId | string | リクエストの一意の識別子。 |
| server | string | リクエストを処理したサーバーアドレス。 |
| success | boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl -X DELETE \
'https://api-cloud.oceanbase.com/api/v2/maas/apikeys' \
-H 'X-OB-Org-Id: {orgId}' \
-H 'X-OB-Project-Id: {projectId}' \
-H 'X-Request-Id: {requestId}' \
-u '<Your AK:SK>'
レスポンス例
{
"action": "DeleteAIServiceAPIKey",
"data": {},
"error": {},
"message": "success",
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}