All Products
Search
Document Center

ApsaraDB for MyBase:ModifyDedicatedHostClass

Last Updated:Mar 01, 2024

Upgrades host specifications.

Operation description

After a host is created in a dedicated cluster, you can modify the specifications of the host based on your business requirements. The host specifications include the CPU and memory resources. For more information, see Upgrade host specifications.

Note When you upgrade the specifications of a host, the host restarts. The database instances that are running on the host also restart. For information about the impacts of a host restart, see Restart 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
RegionIdstringYescn-hangzhou
DedicatedHostIdstringYes

The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID.

ch-bp1fgj3kt7fsb****
TargetClassCodestringYes

The instance type to which you want the host to be upgraded. For more information, see Host specification details.

rds.c6.x4large
SwitchTimestringNo

The time when you want to upgrade the specifications of the host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note This parameter must be specified only when SwitchTimeMode is set to 2.
2021-07-13T07:14:22Z
SwitchTimeModestringNo

The execution mode that is used to upgrade host specifications. Valid values:

  • 0 (default): immediately upgrades host specifications.
  • 2: upgrades host specifications at a specified point in time.
Note If you set this parameter to 2, you must specify SwitchTime.
2

Response parameters

ParameterTypeDescriptionExample
object
DedicatedHostIdstring

The host ID.

ch-bp1fgj3kt7fsb****
RequestIdstring

The request ID.

D6E068C3-25BC-455A-85FE-45F0B22ESD12
TaskIdstring

The task ID.

10254125

Examples

Sample success responses

JSONformat

{
  "DedicatedHostId": "ch-bp1fgj3kt7fsb****",
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ESD12",
  "TaskId": "10254125"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidActionThe specified action is not valid.The specified action is not valid.

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