CreateUser - Hologres - Alibaba Cloud Documentation Center

Adds a RAM user or an STS account to a Hologres instance. Once added, the account can be used to log on to the instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /api/v1/instances/{instanceId}/createUser HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The ID of the instance.	hgpostcn-cn-zpr3426vm002

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. The user name must be prefixed with "p4_" for RAM users (e.g., p4_234253434) and "v4_" for STS accounts (e.g., v4_3234134).	p4_2346134
superUser	boolean	No	Specifies whether the user is a superuser.	false

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Success	string	Indicates whether the operation succeeded. A value of "true" indicates success, and "false" indicates failure.	true
ErrorCode	string	The error code.	null
ErrorMessage	string	The error message.	null
HttpStatusCode	string	The HTTP status code.	200
Data	boolean	Returns true on success and false on failure.	true

Examples

Success response

JSON format

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "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.