All Products
Search

This Product

    ApsaraDB for MyBase:CreateDedicatedHostGroup

    Document Center

    ApsaraDB for MyBase:CreateDedicatedHostGroup

    Last Updated:Aug 28, 2026

    Creates a dedicated cluster.

    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 parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. See Region IDs.

    cn-hangzhou
    Engine

    string

    Yes

    The database engine of the dedicated cluster. Valid values:

    • MySQL

    • SQL Server

    MySQL
    CpuAllocationRatio

    integer

    No

    The CPU overcommit ratio of the dedicated cluster.

    Note

    Unit: %. Valid values: 100 to 300. Default: 200, meaning allocated CPU is twice the actual CPU to maximize utilization.

    200
    MemAllocationRatio

    integer

    No

    The maximum memory usage of each host in the dedicated cluster.

    Note

    Unit: %. Valid values: 0 to 100. Default: 100.

    100
    DiskAllocationRatio

    integer

    No

    The storage overcommit ratio of the dedicated cluster.

    Note

    Unit: %. Valid values: 100 to 300. Default: 200, meaning allocated storage is twice the actual storage to maximize usage. Not applicable to SQL Server clusters.

    200
    AllocationPolicy

    string

    No

    The resource allocation policy for the dedicated cluster. Valid values:

    • Evenly (default): Deploys instances on hosts with no or fewer allocated resources to maximize stability.

    • Intensively: Deploys instances on older hosts with more allocated resources to maximize utilization.

    Evenly
    VPCId

    string

    Yes

    The VPC ID. Find this in the VPC console under VPCs.

    vpc-t4n7v5m6icc0a4314****
    HostReplacePolicy

    string

    No

    The host failure handling policy. Valid values:

    • Auto (default): The system automatically replaces faulty hosts.

    • Manual: You must manually replace faulty hosts.

    Note

    When you create a dedicated cluster that runs MySQL, you can select a policy based on your business requirements. Other database engines use Auto.

    Auto
    ClientToken

    string

    Yes

    The client token for idempotent requests. Must be unique across requests, contain only ASCII characters, and not exceed 64 characters.

    ETnLKlblzczshOTUbOCz*******
    OpenPermission

    integer

    No

    Specifies whether to grant host OS permissions. Valid values:

    • 0: no.

    • 1: yes.

    Note

    Configurable only for MySQL or SQL Server clusters. Other database engines default to 0. Required to be 1 for SQL Server clusters.

    1
    DedicatedHostGroupDesc

    string

    No

    The dedicated cluster name. Must be 1 to 64 characters, start with a letter, and can contain letters, digits, underscores (_), and hyphens (-).

    mysqlcluster

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    C6592723-09E1-4248-A78E-12AB00D7A79D
    DedicatedHostGroupId

    string

    The dedicated cluster ID.

    dhg-7a9********

    Examples

    Success response

    JSON format

    {
  "RequestId": "C6592723-09E1-4248-A78E-12AB00D7A79D",
  "DedicatedHostGroupId": "dhg-7a9********"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 Permission.NotSupport You are not authorized to perform this action. You are not authorized to perform the action.
    404 ClustersTemplateNotFound Key account cluster is not supported for the region. Key account cluster is not supported for the region.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.