Deletes a RAM user or an STS account from a Hologres instance. Once deleted, the user can no longer log in to the instance. To restore access, call the CreateUser operation to add the user.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/instances/{instanceId}/dropUser HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The ID of the Hologres instance. |
hgprecn-cn-xxxxxxx |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request body. |
|
| userName |
string |
No |
The user name. Only RAM users and STS accounts are supported. Prefix the name with "p4_" for a RAM user (for example, p4_234253434) or "v4_" for an STS account (for example, v4_3234134). |
p4_234253434 |
| superUser |
string |
No |
Specifies whether the user is a superuser. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
EA8F0084-5831-5907-BB31-BD05D2617844 |
| Success |
string |
Indicates whether the request was successful. A value of "true" indicates success, and "false" indicates failure. |
true |
| ErrorCode |
string |
The error code that is returned if the request fails. |
null |
| ErrorMessage |
string |
The error message that is returned if the request fails. |
null |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
| Data |
boolean |
The result of the deletion. A value of true indicates success, and a value of false indicates failure. |
true |
Examples
Success response
JSON format
{
"RequestId": "EA8F0084-5831-5907-BB31-BD05D2617844",
"Success": "true",
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200",
"Data": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | NoPermission | RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.