Overview
Deletes an API key under a specified project based on its unique identifier (UUID).
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
DELETE /api/v2/maas/apikeys
Request parameters
Query
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| uid | string | No | Account ID, which is input from the network. If this parameter is missing, INVALID_PARAMETER is returned. | {uid} |
| id | string | Yes | The UUID of the API key to be deleted. | ak-xxxxxxxxxxxxxxxx |
Header
Parameter |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| Authorization | string | Yes | IAM authentication information. | -u ak:sk |
| requestId | string | No | Unique request identifier. | req-abc123 |
| X-Request-Id | string | No | Unique request identifier. | req-abc123 |
| X-OB-Org-Id | string | Yes | Organization ID, which is required for all APIs. | org-xxxxxxxx |
| X-OB-Project-Id | string | Yes | Project ID, which is required for all APIs. | proj-xxxxxxxx |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| action | string | Request action, corresponding to the request parameters.Actioncorresponds. |
| data | object | The returned data object. |
| error | object | Error message object. |
| message | string | The description of the request result. |
| requestId | string | The unique identifier of the request. |
| server | string | The server address that processes the request. |
| success | boolean | Whether the request was successful. |
Examples
Request example
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>'
Response example
{
"action": "DeleteAIServiceAPIKey",
"data": {},
"error": {},
"message": "success",
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}