All Products
Search
Document Center

ApsaraDB for MyBase:CreateDedicatedHostAccount

Last Updated:Oct 28, 2025

Creates an account for a host.

Operation description

Each host can have only one account. Before you create an account for a host, make sure that the existing account of the host is deleted. For more information, see Create an account for a host.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cddc:CreateDedicatedHostAccountcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DedicatedHostIdstringYes

The host ID. You can call the DescribeDedicatedHosts operation to query the host ID.

ch-bp10a5id3boqi****
AccountNamestringYes

The name of the host account.

  • The name must be 2 to 16 characters in length.
  • The name must start with a lowercase letter and end with a lowercase letter or a digit.
  • The name can contain lowercase letters, digits, and underscores (_).
test
AccountPasswordstringYes

The password of the host account.

  • The password must be 6 to 32 characters in length.
  • The password must contain three of the following character types: upper letters, lower letters, digits, and special characters.
  • The password can contain the following special characters: ! @ # $ % ^ & * ( ) _ + - =
Note If your host runs SQL Server, the password cannot contain the account name (case-insensitive).
testxxxxxx
RegionIdstringYes

The region ID of the host. You can call the DescribeDedicatedHostAttribute operation to query the region ID.

cn-hangzhou
BastionInstanceIdstringNo

The ID of the bastion host with which the host is associated. You can log on to the ApsaraDB for MyBase console and go to the Bastion Hosts page to view the bastion host ID.

bastionhost-cn-xxxxxxxxxxx
AccountTypestringNo

The type of the host account. Valid values:

  • Normal: standard account.
  • Admin: administrator account.

For more information, see Host permissions.

Admin
ClientTokenstringYes

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz*******

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D6E068C3-25BC-455A-85FE-45F0B22E12AS

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidAccountPassword.FormatThe account password format is invalid.The account password format is invalid.
403InvalidAction.NotSupportThe host status does not support the operation.The host status does not support the operation.
404HostInfo.NotFoundThe host is not found.The host is not found.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history