# Alibaba Cloud ApsaraDB for MyBase API

> Alibaba Cloud ApsaraDB for MyBase API on Apizie: 36 endpoints (Adds a self-managed MyBase instance, Creates hosts in a dedicated cluster, Creates a host account, Creates a dedicated cluster, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-cddc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cddc`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cddc
- Page: https://apizie.tech/api/cloud/aliyun-cddc
- OpenAPI: https://apizie.tech/api/cloud/aliyun-cddc/openapi.json

Alibaba Cloud OpenAPI for ApsaraDB for MyBase (cddc, version 2020-03-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a self-managed MyBase instance
`POST https://apizie.tech/v1/cloud:aliyun-cddc/add-prins-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| EcsInstanceId | string | no | The ID of the ECS instance to be managed |
| Engine | string | no | The database engine type that is used to filter hosts. Valid values: MySQL |
| Ip | string | no | The IP address |
| Port | string | no | The instance port number |
| Disk | string | no | The list of disks (JSON-encoded) |
| Username | string | no | The database username |
| Password | string | no | The database connection password |
| SecurityGroupId | string | no | The ID of the security group specified when adding the managed instance |
| Alias | string | no | The alias of the instance |
| Description | string | no | The instance description |

### Creates hosts in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/create-dedicated-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostGroupId | string | yes | The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated… |
| HostClass | string | yes | The instance type of the host. For information about the host instance types supported by different database engines, see… |
| PayType | string | yes | The billing method of the host. Set the value to prepaid |
| Period | string | no | The unit of the subscription duration. Valid values: Year Month |
| UsedTime | string | no | The subscription duration of the host. Valid values when Period is set to Year: 1 to 5.**** Valid values when Period is set to Month: 1 to 9 |
| ClientToken | string | yes | 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… |
| AutoRenew | string | no | Specifies whether to enable the auto-renewal feature. Valid values: true false If you do not specify this parameter, the default value… |
| ImageCategory | string | no | The image of the host. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition. WindowsWithMssqlStdLicense: SQL… |
| OsPassword | string | no | The password of the host. You can specify a password only when you create a host in a Proprietary MyBase dedicated cluster. The password… |
| HostStorageType | string | no | The disk type of the host. This parameter takes effect only for dedicated clusters that run Tair. Valid values: cloud_essd: PL1 enhanced… |
| HostStorage | string | no | The disk storage of the host. This parameter takes effect only for dedicated clusters that run Tair. Unit: GB. Valid values: 512 1024 1536… |
| RegionId | string | yes | The https://help.aliyun.com/document_detail/198326.html of the dedicated cluster |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/214103.html operation to query the most recent zone list |
| VSwitchId | string | yes | The vSwitch ID. You can view the vSwitch ID in the Virtual Private Cloud (VPC) console |
| ClusterType | string | no | The deployment type of the Self-managed MyBase cluster. Valid values: onACK and onECS |
| ClusterAlias | string | no | The alias of the Self-managed MyBase cluster |
| VpcID | string | no | The VPC ID of the Self-managed MyBase cluster |
| ClusterServices | string | no | The services associated with the instances in the Self-managed MyBase on Elastic Compute Service (ECS) cluster (JSON-encoded) |
| MyBaseEcsClass | string | no | The parameters of the instances in the Self-managed MyBase on Elastic Compute Service (ECS) cluster (JSON-encoded) |

### Creates a host account
`POST https://apizie.tech/v1/cloud:aliyun-cddc/create-dedicated-host-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to obtain this ID |
| AccountName | string | yes | The name of the host account. The name must meet the following requirements: The name must be 2 to 16 characters in length. The name must… |
| AccountPassword | string | yes | The password for the host account. The password must meet the following requirements: The password must be 6 to 32 characters in length.… |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/213010.html operation to obtain this ID |
| BastionInstanceId | string | no | The ID of the bastion instance. You can find this ID on the Bastion Instance List page of the Cloud Database Dedicated Cluster (CDDC)… |
| AccountType | string | no | The type of the host account. Valid values: Normal: A normal account. Admin: An administrator account. For more information about host… |
| ClientToken | string | no | A client-generated token that ensures request idempotence. The token is a string of up to 64 ASCII characters |

### Creates a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/create-dedicated-host-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| Engine | string | yes | The database engine of the dedicated cluster. Valid values: MySQL SQL Server |
| CpuAllocationRatio | integer | no | The CPU overcommit ratio of the dedicated cluster. Unit: %. Valid values: 100 to 300. Default value: 200, which specifies that the total… |
| MemAllocationRatio | integer | no | The maximum memory usage of each host in the dedicated cluster. Unit: %. Valid values: 0 to 100. Default value: 100 |
| DiskAllocationRatio | integer | no | The storage overcommit ratio of the dedicated cluster. Unit: %. Valid values: 100 to 300. Default value: 200, which specifies that the… |
| AllocationPolicy | string | no | The policy that is used to allocate resources in the dedicated cluster. Valid values: Evenly (default): The system preferentially deploys… |
| VPCId | string | yes | The ID of the virtual private cloud (VPC) where you want to create the dedicated cluster. You can log on to the VPC console and click VPCs… |
| HostReplacePolicy | string | no | The policy that is used to handle host failures. Valid values: Auto (default): The system automatically replaces faulty hosts. Manual: You… |
| ClientToken | string | yes | 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… |
| OpenPermission | integer | no | Specifies whether to grant the host OS permissions. Valid values: 0: no. 1: yes. When you create a dedicated cluster that runs MySQL or… |
| DedicatedHostGroupDesc | string | no | The name of the dedicated cluster. The name must be 1 to 64 characters in length and can contain letters, digits, underscores (_), and… |

### Create MyBase dedicated hosts. If cluster information is not provided, a MyBase dedicated cluster is…
`POST https://apizie.tech/v1/cloud:aliyun-cddc/create-my-base` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| DedicatedHostGroupDescription | string | no | The name of the dedicated cluster |
| Engine | string | yes | The database type. Valid values: alisql tair |
| SecurityGroupId | string | yes | The security group ID. Specify multiple security groups, separated by commas (,). Format: sg-t4neld965n89ocvt\\,sg-t4neld965n89ocvu\\ |
| ZoneId | string | yes | The zone ID. Call https://help.aliyun.com/document_detail/214103.html to query the zone ID for a region |
| VSwitchId | string | yes | The virtual switch ID |
| ECSClassList | string | yes | ECS specifications (JSON-encoded) |
| PayType | string | yes | The billing method. Only PrePaid is supported |
| Period | string | no | The subscription duration |
| ClientToken | string | no | Ensure the idempotence of the request. Generate a unique ASCII string on your client. The string must be up to 64 characters long |
| AutoRenew | string | no | Enable auto-renewal. Valid values: true: Enable. false (default): Disable |
| ImageId | string | no | The custom image ID. If you want to use the default image, do not specify this parameter |
| OsPassword | string | no | The logon password for the host. You can set it later. The password must meet the following requirements: It must be 8 to 30 characters in… |
| DedicatedHostGroupId | string | no | The ID of the existing MyBase dedicated cluster |
| PeriodType | string | no | The subscription type. Only Monthly is supported |
| VpcId | string | yes | The Virtual Private Cloud (VPC) ID |
| KeyPairName | string | no | The key pair name |
| PasswordInherit | string | no | Use the default password of the image. false (default): Do not use. true: Use. If you use the default password of the image, do not… |
| EcsHostName | string | no | For Windows operating systems: The host name must be 2 to 15 characters in length and can contain uppercase letters, lowercase letters,… |
| EcsInstanceName | string | no | The instance name. It must be 2 to 128 characters in length. It must start with an uppercase letter, a lowercase letter, or a Chinese… |
| EcsDeploymentSetId | string | no | The deployment set ID of the Elastic Compute Service (ECS) instance |
| EcsUniqueSuffix | string | no | Automatically add a sequential suffix to the HostName and InstanceName when you create multiple instances. The sequential suffix starts… |
| InternetChargeType | string | no | The network billing method. Valid values include the following: |
| InternetMaxBandwidthOut | integer | no | The maximum outbound public bandwidth, in Mbit/s. Valid values: 0 to 100. Default value: 0. If you set this parameter to a value greater… |
| AutoPay | string | no | Automatically pay when creating the host. false: Only generate an order without deducting fees. Manually confirm the payment on the My… |
| ResourceGroupId | string | no | The resource group ID |
| UserDataInBase64 | string | no | Indicates whether the custom data is Base64-encoded |
| UserData | string | no | The user-defined script data. The raw data can be up to 16 KB |
| Tags | string | no | The tag information of the host (JSON-encoded) |

### Creates a backup plan for a managed instance
`POST https://apizie.tech/v1/cloud:aliyun-cddc/create-prins-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The Region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| InstanceName | string | yes | The name of the self-managed instance |
| InstanceClass | string | yes | The specification of the backup plan. Valid values: micro small medium large xlarge |
| Period | string | yes | The unit of the purchase duration. Valid values: Month Year |
| UsedTime | integer | yes | The subscription duration. Valid values: If Period is set to Year, the values of UsedTime can be from 1 to 9. If Period is set to Month,… |
| EcsInstanceId | string | yes | The ID of the ECS instance to be backed up |
| BackupPeriod | string | yes | The full backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday You can select multiple values and separate… |
| BackupStartTime | string | yes | The backup start time in HH:mm format |
| BackupPlanName | string | no | The custom name for the backup plan |

### Deletes a host account
`POST https://apizie.tech/v1/cloud:aliyun-cddc/delete-dedicated-host-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to query the host ID |
| AccountName | string | yes | The name of the host account. The name can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase… |
| RegionId | string | no | The region ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the region ID |

### Deletes a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/delete-dedicated-host-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostGroupId | string | yes | The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated… |
| RegionId | string | no | The region ID of the dedicated cluster. For more information, see https://help.aliyun.com/document_detail/198326.html |

### Queries the parameter settings of a host in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-dedicated-host-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| DedicatedHostGroupId | string | yes | The ID of the dedicated cluster in which the host is created. You can log on to the ApsaraDB for MyBase console and go to the Dedicated… |

### Queries the information about disks on a host
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-dedicated-host-disks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| RegionId | string | no | The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the https://help.aliyun.com/document_detail/198326.html |

### Retrieves dedicated host group information for ApsaraDB for MyBase
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-dedicated-host-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | Region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostGroupId | string | no | Dedicated cluster ID. You can find this ID in the ApsaraDB for MyBase console under Clusters. If you leave this parameter empty, the… |
| ImageCategory | string | no | Host image category. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Always On Enterprise Edition Server Cluster Edition… |
| Engine | string | no | Filter dedicated hosts by database engine type. Valid values: MySQL SQL Server PostgreSQL Redis |

### Queries the information about hosts in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-dedicated-hosts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostGroupId | string | no | The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated… |
| OrderId | integer | no | The order ID. You can log on to the Billing Management console and go to the Orders page to view the order ID |
| HostType | string | no | The storage type of the host. Valid values: dhg_local_ssd: local SSD. dhg_cloud_ssd or dhg_cloud_essd: enhanced SSD (ESSD) |
| HostStatus | string | no | The state of the host. Valid values: 0: The host is being created. 1: The host is running. 2: The host is faulty. 3: The host is ready for… |
| AllocationStatus | string | no | Specifies whether instances can be deployed on the host. Valid values: Allocatable: Instances can be deployed on the host. Suspended:… |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/214103.html operation to query the most recent zone list |
| DedicatedHostId | string | no | The ID of the host in the dedicated cluster. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| PageNumbers | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| Tags | string | no | The tags that are added to the host. Each tag is a key-value pair that consists of TagKey and TagValue. You can specify a maximum of five… |

### Queries the information about host specifications
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-host-ecs-level-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DbType | string | yes | The database engine. Valid values: mysql mssql pgsql redis |
| RegionId | string | yes | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| ZoneId | string | yes | The zone ID |
| StorageType | string | yes | The storage type. Valid values: local_ssd: standard SSD. cloud_essd: PL1 enhanced SSD (ESSD). cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD |
| ImageCategory | string | no | The image of the host. Valid values: WindowsWithMssqlEntAlwaysonLicense: SQL Server Cluster Edition. WindowsWithMssqlStdLicense: SQL… |

### Queries the URL of a webshell that is used to access a host
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-host-web-shell` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to query the host ID |
| RegionId | string | yes | The region ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the region ID |
| ZoneId | string | yes | The zone ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the zone ID |

### Queries a DBS backup plan created on the MyBase managed instance page. An empty response indicates that no…
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-prins-backup-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The Region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| InstanceName | string | yes | The name of the self-managed instance |

### Queries a list of ECS instance information
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-prins-ecs-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| EcsInstanceId | string | no | The ECS instance ID |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number of the instance list. Start value: 1. Default value: 1 |
| VpcId | string | no | The ID of the virtual private cloud (VPC) where the cluster resides |
| ZoneId | string | no | The zone ID |
| MaxResults | integer | no | This parameter is not available. Use PageNumber and PageSize for pagination. The maximum number of results to be returned from a single… |
| NextToken | string | no | This parameter is not available. Use PageNumber and PageSize for pagination. The query token returned from the current call |
| Keyword | string | no | The query keyword. Supports fuzzy matching on Host ID, Host Name, and Host IP |

### Retrieves the details of a managed instance
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-prins-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| InstanceName | string | no | The name of the self-managed instance |
| RegionId | string | no | https://help.aliyun.com/document_detail/198326.html |
| Discover | string | no | Specifies whether to query associated primary and replica instances |

### Queries the most recent region list
`POST https://apizie.tech/v1/cloud:aliyun-cddc/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |

### Retrieves a list of events
`POST https://apizie.tech/v1/cloud:aliyun-cddc/get-prins-event-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| InstanceName | string | no | The name of the self-managed instance |
| StartTime | string | no | The timestamp for the start of the query time range |
| EndTime | string | no | The timestamp for the end of the query time range. The interval between StartTime and EndTime cannot exceed 12 hours |
| RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |

### Retrieves performance metric data for managed instances
`POST https://apizie.tech/v1/cloud:aliyun-cddc/get-prins-metrics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| InstanceId | string | no | The ID of the ECS instance |
| StartTime | string | no | The timestamp for the start of the query time range |
| EndTime | string | no | The timestamp for the end of the query time range. The interval between StartTime and EndTime cannot exceed 12 hours |
| Metrics | string | no | The metric information. Specific categories include: DAS mysql.tps,mysql.qps… |
| RegionId | string | no | The https://help.aliyun.com/document_detail/198326.html of the instance |

### Queries the list of managed instances
`POST https://apizie.tech/v1/cloud:aliyun-cddc/list-prins-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| InstanceName | string | no | The name of the self-managed instance |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number of the instance list. Start value: 1. Default value: 1 |
| EngineType | string | no | The database engine of the instance. Valid values: MySQL |
| Tag | string | no | The tag information, which filters the instances that contain the corresponding tag key value (JSON-encoded) |
| MaxResults | integer | no | This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries |
| NextToken | string | no | This parameter is not available. The PageNumber and PageSize parameters are used to perform paged queries |
| EngineVersion | string | no | The database version |

### Queries the parameter list of a managed database instance
`POST https://apizie.tech/v1/cloud:aliyun-cddc/list-prins-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| InstanceName | string | yes | The name of the self-managed instance |
| RegionId | string | no | The region ID. You can call the https://help.aliyun.com/document_detail/214103.html operation to query the most recent region list |
| ConfigName | string | no | No |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number. Pages start from page 1 |

### Retrieves log information for a managed instance
`POST https://apizie.tech/v1/cloud:aliyun-cddc/list-prins-sqlerror-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| InstanceName | string | yes | The name of the self-managed instance |
| RegionId | string | yes | The Region ID. For more information, see https://help.aliyun.com/document_detail/198326.html |
| Keyword | string | no | The keyword of log query |
| StartLinenum | integer | no | The starting line number for log retrieval. A value of 0 indicates retrieving the latest log content. Default: 0 |
| Size | integer | no | The number of log entries to query. Default: 30 |
| Reverse | string | no | Specifies the query direction. Default value: false. true: Queries in reverse order, retrieving Size log entries before StartLinenum. This… |
| LogPath | string | no | The path of the log file. If left empty, the system automatically retrieves the path of the MySQL error log |

### Queries the information about tags that are added to hosts
`POST https://apizie.tech/v1/cloud:aliyun-cddc/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The region ID of the host |
| ResourceType | string | yes | The resource type. Set the value to DEDICATEDHOST |
| ResourceId | string | no | The ID of host N. You can specify multiple host IDs (JSON-encoded) |
| Tag | string | no | The tags (JSON-encoded) |

### Changes the account name and password of a host
`POST https://apizie.tech/v1/cloud:aliyun-cddc/modify-dedicated-host-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to query the host ID |
| AccountName | string | yes | The account name of the host |
| AccountPassword | string | yes | The new account password of the host |
| RegionId | string | no | The region ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the region ID |

### Specifies whether instances can be deployed on a host in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/modify-dedicated-host-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The https://help.aliyun.com/document_detail/198326.html of the host |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| HostName | string | no | The name of the host |
| AllocationStatus | string | no | Indicates whether instances can be deployed on the host. Valid values: 1: yes. 0: no |

### Upgrades host specifications
`POST https://apizie.tech/v1/cloud:aliyun-cddc/modify-dedicated-host-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| TargetClassCode | string | yes | The instance type to which you want the host to be upgraded. For more information, see https://help.aliyun.com/document_detail/206343.html |
| SwitchTime | string | no | 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… |
| SwitchTimeMode | string | no | The execution mode that is used to upgrade host specifications. Valid values: 0 (default): immediately upgrades host specifications. 2:… |

### Modifies configurations such as the CPU overcommit ratio, memory usage, storage overcommit ratio, and…
`POST https://apizie.tech/v1/cloud:aliyun-cddc/modify-dedicated-host-group-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID of the dedicated cluster. For more information, see https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostGroupId | string | yes | The dedicated cluster ID. You can log on to the ApsaraDB for MyBase console and go to the Dedicated Clusters page to view the dedicated… |
| DedicatedHostGroupDesc | string | no | The name of the dedicated cluster |
| CpuAllocationRatio | integer | no | The CPU overcommit ratio of the dedicated cluster. Valid values: 100 to 300. If you change the CPU overcommit ratio to 300%, the total CPU… |
| MemAllocationRatio | integer | no | The maximum memory usage of each host in the dedicated cluster. Valid values: 0 to 100 |
| DiskAllocationRatio | integer | no | The storage overcommit ratio of the dedicated cluster. Valid values: 100 to 200 |
| AllocationPolicy | string | no | The policy that is used to allocate resources in the dedicated cluster. Valid values: Evenly: The system preferentially deploys database… |
| HostReplacePolicy | string | no | The policy that is used to handle host failures. Valid values: Auto: The system automatically replaces faulty hosts. Manual: You must… |
| OpenPermission | string | no | Specifies whether to grant the host OS permissions. Valid values: 0: no. 1: yes. You can grant the host OS permissions based on your… |

### Changes the root account password of a host
`POST https://apizie.tech/v1/cloud:aliyun-cddc/modify-dedicated-host-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the region ID |
| NewPassword | string | yes | The new password. The password must be 8 to 32 characters in length. The password must contain at least three of the following character… |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to query the host ID |

### Queries the basic information about the host on which an instance is deployed
`POST https://apizie.tech/v1/cloud:aliyun-cddc/query-host-base-info-by-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. For more information, see https://help.aliyun.com/document_detail/198326.html |
| DBInstanceId | string | yes | The instance ID |

### Queries the information about instances that are deployed on a host
`POST https://apizie.tech/v1/cloud:aliyun-cddc/query-host-instance-console-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID of the host. You can log on to the ApsaraDB for MyBase console to view the https://help.aliyun.com/document_detail/198326.html |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |

### Replaces a host in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/replace-dedicated-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | The region ID of the host. You can call the https://help.aliyun.com/document_detail/213010.html operation to query the region ID |
| DedicatedHostId | string | yes | The host ID. You can call the https://help.aliyun.com/document_detail/200944.html operation to query the host ID |
| FailoverMode | string | yes | The switchover method of the primary instance. Valid values: MaintainTime (default): The system performs a switchover within a maintenance… |

### Restarts a host in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-cddc/restart-dedicated-host` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | no | https://help.aliyun.com/document_detail/198326.html of the host |
| DedicatedHostId | string | yes | The host ID. You can log on to the ApsaraDB for MyBase console and go to the Hosts page to view the host ID |
| FailoverMode | string | yes | The switchover method of the primary instance. Valid values: MaintainTime (default): The system performs a switchover within a maintenance… |
| ForceStop | string | no | Specifies whether to forcefully restart the host. Valid values: true: The system forcefully restarts the host. If this value is used, the… |

### Adds tags to hosts
`POST https://apizie.tech/v1/cloud:aliyun-cddc/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The region ID of the host |
| ResourceId | string | yes | The ID of host N. You can specify multiple host IDs (JSON-encoded) |
| Tag | string | yes | The tags (JSON-encoded) |
| ResourceType | string | yes | The resource type. Set the value to DEDICATEDHOST |

### Removes tags from hosts
`POST https://apizie.tech/v1/cloud:aliyun-cddc/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |
| RegionId | string | yes | The region ID of the host |
| ResourceId | string | yes | The ID of host N. You can specify multiple host IDs (JSON-encoded) |
| TagKey | string | no | The key of tag N (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the host. Valid values: true false If you specify both this parameter and the TagKey.N… |
| ResourceType | string | yes | The resource type. Set the value to DEDICATEDHOST |

### version
`POST https://apizie.tech/v1/cloud:aliyun-cddc/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cddc.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-cddc/add-prins-instance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraDB for MyBase API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-cddc/add-prins-instance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraDB for MyBase API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraDB for MyBase itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraDB for MyBase API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cddc.

### What is the status of the Alibaba Cloud ApsaraDB for MyBase API?
Needs your own provider key (bring your own key)