Use CreateDedicatedHostAccount to create a dedicated host account - ApsaraDB for MyBase - Alibaba Cloud - ApsaraDB for MyBase

Operation description

Each host can have only one host account. You must delete the existing host account before you can create a new one. For more information, see Create a host account.

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

cddc:CreateDedicatedHostAccount

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DedicatedHostId	string	Yes	The ID of the dedicated host. You can call the DescribeDedicatedHosts operation to query the ID.	ch-bp10a5id3boqi****
AccountName	string	Yes	The custom name of the host account. The name must be 2 to 16 characters in length. The name must start with a letter and end with a letter or a digit. The name can contain only lowercase letters, digits, and underscores (_).	test
AccountPassword	string	Yes	The password of the host account. Password requirements: The password must be 6 to 32 characters in length. The password must contain uppercase letters, lowercase letters, digits, and special characters. Special characters include: `!@#$%^&()_+-=` Note* If your database engine is SQL Server, the password cannot contain the account name, regardless of case.	testxxxxxx
RegionId	string	No	The region ID of the dedicated host. You can call the DescribeDedicatedHostAttribute operation to query the region ID.	cn-hangzhou
BastionInstanceId	string	No	The ID of the associated bastion host. You can view the ID on the Bastion Hosts page in the cloud database dedicated cluster console.	bastionhost-cn-xxxxxxxxxxx
AccountType	string	No	The type of the host account. Valid values: Normal: standard account. Admin: administrator account. For more information about the permissions of host accounts, see Host account permissions.	Admin
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can use the client to generate the value. The token can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCz*******

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	D6E068C3-25BC-455A-85FE-45F0B22E12AS

Examples

Success response

JSON format

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E12AS"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccountPassword.Format	The account password format is invalid.	The account password format is invalid.
403	InvalidAction.NotSupport	The host status does not support the operation.	The host status does not support the operation.
404	HostInfo.NotFound	The host is not found.	The host is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.