All Products
Search
Document Center

ApsaraDB for MyBase:CreateDedicatedHostAccount

Last Updated:Mar 01, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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.