CreateServiceAccount - PolarDB - Alibaba Cloud Documentation Center

Creates a service account.

Operation description

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:CreateServiceAccount

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region in which the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-*********
ServiceAccountType	string	Yes	The type of the service account.	METADATA_READONLY

Response elements

Element	Type	Description	Example
	object
Message	string	The additional information returned. If the request is successful, success is returned. If the request fails, the corresponding error code is returned.	*****
RequestId	string	The request ID.	6BA32080EEA
Success	boolean	Indicates whether the request is successful.	True
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The authentication principal type.	222
NoPermissionType	string	NoPermissionType	ImplicitDeny
PolicyType	string	The policy type.	PRIORITY
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==
Data	object	The returned policy details.
RequestId	string	The request ID.	1E5DCFFC-A00D-****-836E-73318F8CA577
AccountName	string	The account name.	polardbx_meta_ro
ServiceAccountType	string	The type of the service account.	服务账号类型
Status	string	The instance status.	Active
AlreadyExists	boolean	Indicates whether the account already exists.	False
TaskId	integer	The task ID.	2209883

Examples

Success response

JSON format

{
  "Message": "*****",
  "RequestId": "6BA32080EEA",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  },
  "Data": {
    "RequestId": "1E5DCFFC-A00D-****-836E-73318F8CA577",
    "AccountName": "polardbx_meta_ro",
    "ServiceAccountType": "服务账号类型",
    "Status": "Active",
    "AlreadyExists": true,
    "TaskId": 2209883
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.