All Products
Search

This Product

    ApsaraDB for MyBase:ModifyDedicatedHostGroupAttribute

    Document Center

    ApsaraDB for MyBase:ModifyDedicatedHostGroupAttribute

    Last Updated:Mar 01, 2024

    Modifies configurations such as the CPU overcommit ratio, memory usage, storage overcommit ratio, and resource allocation policy for a dedicated cluster.

    Operation description

    For more information, see Manage dedicated clusters.

    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
    RegionIdstringNo

    The region ID of the dedicated cluster. For more information, see Region IDs.

    		cn-hangzhou
    DedicatedHostGroupIdstringYes

    The dedicated cluster ID.

    Note You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated cluster ID.
    		dhg-h5i4p331f509****
    DedicatedHostGroupDescstringNo

    The name of the dedicated cluster.

    		mysql-cluster
    CpuAllocationRatiointegerNo

    The CPU overcommit ratio of the dedicated cluster. Valid values: 100 to 300.

    Note If you change the CPU overcommit ratio to 300%, the total CPU resources of all instances are three times the actual CPU resources. This maximizes the use of CPU resources.
    		300
    MemAllocationRatiointegerNo

    The maximum memory usage of each host in the dedicated cluster. Valid values: 0 to 100.

    		100
    DiskAllocationRatiointegerNo

    The storage overcommit ratio of the dedicated cluster. Valid values: 100 to 200.

    		200
    AllocationPolicystringNo

    The policy that is used to allocate resources in the dedicated cluster. Valid values:

    • Evenly: The system preferentially deploys database instances on the hosts where no resources or fewer resources are allocated. This maximizes system stability.
    • Intensively: The system preferentially deploys database instances on the hosts that are created earlier and have more allocated resources. This maximizes resource utilization.
    		Intensively
    HostReplacePolicystringNo

    The policy that is used to handle host failures. Valid values:

    • Auto: The system automatically replaces faulty hosts.
    • Manual: You must manually replace faulty hosts.
    Note You can select a policy based on your business requirements only for dedicated clusters that run MySQL. For dedicated clusters that run other database engines, the default value Auto is used.
    		Auto
    OpenPermissionstringNo

    Specifies whether to grant the host OS permissions. Valid values:

    • 0: no.
    • 1: yes.
    Note You can grant the host OS permissions based on your business requirements only when you create dedicated clusters that run MySQL, SQL Server, or PostgreSQL. For dedicated clusters that run other database engines, the default value 0 is used.
    		0

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidUserId.NotSupportThe userid have no permission.-
    403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.The user is not authorized to operate on the specified resource.
    404InvalidDedicatedHostGroup.NotFoundThe specified cluster does not exist.

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