Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| ALIBABA_CLOUD_ACCESS_KEY_ID | Yes | Alibaba Cloud access key ID for RDS services | |
| ALIBABA_CLOUD_ACCESS_KEY_SECRET | Yes | Alibaba Cloud access key secret for RDS services |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| describe_db_instances | Queries instances.
Args:
region_id: queries instances in region id(e.g. cn-hangzhou)
:return: |
| describe_db_instance_attribute | Queries the details of an instance.
Args:
region_id: db instance region(e.g. cn-hangzhou)
db_instance_id: db instance id(e.g. rm-xxx)
:return: |
| describe_db_instance_performance | Queries the performance data of an instance.
Args:
region_id: db instance region(e.g. cn-hangzhou)
db_instance_id: db instance id(e.g. rm-xxx)
db_type: the db instance database type(e.g. mysql,pgsql,sqlserver)
perf_keys: Performance Key (e.g. ["MemCpuUsage", "QPSTPS", "Sessions", "COMDML", "RowDML", "ThreadStatus", "MBPS", "DetailedSpaceUsage"])
start_time: start time(e.g. 2023-01-01 00:00)
end_time: end time(e.g. 2023-01-01 00:00) |
| modify_parameter | Modify RDS instance parameters. Args:
region_id: The region ID of the RDS instance.
dbinstance_id: The ID of the RDS instance.
parameters (Dict[str, str], optional): Parameters and their values in JSON format.
Example: {"delayed_insert_timeout": "600", "max_length_for_sort_data": "2048"}
parameter_group_id: Parameter template ID.
forcerestart: Whether to force restart the database. Default: False.
switch_time_mode: Execution time mode. Values: Immediate, MaintainTime, ScheduleTime. Default: Immediate.
switch_time: Scheduled execution time in format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
client_token: Client token for idempotency, max 64 ASCII characters.
Returns:
Dict[str, Any]: The response containing the request ID. |
| modify_db_instance_spec | Modify RDS instance specifications. Args:
region_id: The region ID of the RDS instance.
dbinstance_id: The ID of the RDS instance.
dbinstance_class: Target instance specification.
dbinstance_storage: Target storage space in GB.
pay_type: Instance payment type. Values: Postpaid, Prepaid, Serverless.
effective_time: When the new configuration takes effect. Values: Immediate, MaintainTime, ScheduleTime.
switch_time: Scheduled switch time in format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
switch_time_mode: Switch time mode. Values: Immediate, MaintainTime, ScheduleTime.
source_biz: Source business type.
dedicated_host_group_id: Dedicated host group ID.
zone_id: Zone ID.
vswitch_id: VSwitch ID.
category: Instance category.
instance_network_type: Instance network type.
direction: Specification change direction. Values: UP, DOWN.
auto_pause: Whether to enable auto pause for Serverless instances.
max_capacity: Maximum capacity for Serverless instances.
min_capacity: Minimum capacity for Serverless instances.
switch_force: Whether to force switch for Serverless instances.
client_token: Client token for idempotency, max 64 ASCII characters.
Returns:
Dict[str, Any]: The response containing the request ID. |
| describe_available_classes | Query the RDS instance class_code and storage space that can be purchased in the inventory. Args:
region_id: The region ID of the RDS instance.
zone_id: The zone ID of the RDS instance. Query available zones by `describe_available_zones`.
instance_charge_type: Instance payment type. Values: Prepaid, Postpaid, Serverless.
engine: Database engine type. Values: MySQL, SQLServer, PostgreSQL, MariaDB.
engine_version: Database version.
dbinstance_storage_type: Storage type. Values: local_ssd,general_essd,cloud_essd,cloud_essd2,cloud_essd3
category: Instance category. Values: Basic, HighAvailability, cluster, AlwaysOn, Finance, serverless_basic, serverless_standard, serverless_ha.
dbinstance_id: The ID of the RDS instance.
order_type: Order type. Currently only supports "BUY".
commodity_code: Commodity code for read-only instances.
Returns:
Dict[str, Any]: The response containing available instance classes and storage ranges. |
| create_db_instance | Create an RDS instance. Args:
region_id: Region ID.
engine: Database type (MySQL, SQLServer, PostgreSQL, MariaDB).
engine_version: Database version.
dbinstance_class: Instance specification. Query available class_codes by `describe_available_classes`.
dbinstance_storage: Storage space in GB.
security_ip_list: IP whitelist, separated by commas. Default: "127.0.0.1".
instance_network_type: Network type (Classic, VPC). Default: VPC.
zone_id: Zone ID. Query available zones by `describe_available_zones`.
zone_id_slave1: Slave Node1 Zone ID. Query available zones by `describe_available_zones`.
zone_id_slave2: Slave Node2 Zone ID. Query available zones by `describe_available_zones`.
pay_type: Payment type (Postpaid, Prepaid). Default: Postpaid.
instance_charge_type: Instance charge type.
system_db_charset: Character set.
dbinstance_net_type: Network connection type (Internet, Intranet). Default: Internet.
category: Instance category. Default: Basic.
dbinstance_storage_type: Storage type. (e.g. local_ssd,general_essd,cloud_essd,cloud_essd2,cloud_essd3)
vpc_id: VPC ID.
vswitch_id: VSwitch ID.
private_ip_address: Private IP address.
client_token: Idempotence token.
resource_group_id: Resource group ID.
tde_status: TDE status (Enable, Disable).
encryption_key: Custom encryption key.
serverless_config: Serverless instance configuration.
table_names_case_sensitive: Are table names case-sensitive.
db_time_zone: the db instance time zone.
connection_string: the connection string for db instance.
db_param_group_id: the db param group id for db instance.
Returns:
Dict[str, Any]: Response containing the created instance details. |
| describe_available_zones | Query available zones for RDS instances. Args:
region_id: Region ID.
engine: Database type (MySQL, SQLServer, PostgreSQL, MariaDB).
engine_version: Database version.
MySQL: 5.5, 5.6, 5.7, 8.0
SQL Server: 2008r2, 2012, 2014, 2016, 2017, 2019
PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0
MariaDB: 10.3
commodity_code: Commodity code.
bards: Pay-as-you-go primary instance (China site)
rds: Subscription primary instance (China site)
rords: Pay-as-you-go read-only instance (China site)
rds_rordspre_public_cn: Subscription read-only instance (China site)
bards_intl: Pay-as-you-go primary instance (International site)
rds_intl: Subscription primary instance (International site)
rords_intl: Pay-as-you-go read-only instance (International site)
rds_rordspre_public_intl: Subscription read-only instance (International site)
rds_serverless_public_cn: Serverless instance (China site)
rds_serverless_public_intl: Serverless instance (International site)
zone_id: Zone ID.
dispense_mode: Whether to return zones that support single-zone deployment.
1: Return (default)
0: Do not return
dbinstance_name: Primary instance ID. Required when querying read-only instance resources.
category: Instance category.
Basic: Basic Edition
HighAvailability: High-availability Edition
cluster: MySQL Cluster Edition
AlwaysOn: SQL Server Cluster Edition
Finance: Enterprise Edition
serverless_basic: Serverless Basic Edition
serverless_standard: MySQL Serverless High-availability Edition
serverless_ha: SQL Server Serverless High-availability Edition
Returns:
Dict[str, Any]: Response containing available zones information. |
| describe_vpcs | Query VPC list. Args:
region_id: The region ID of the VPC.
vpc_id: The ID of the VPC. Up to 20 VPC IDs can be specified, separated by commas.
vpc_name: The name of the VPC.
resource_group_id: The resource group ID of the VPC to query.
page_number: The page number of the list. Default: 1.
page_size: The number of entries per page. Maximum value: 50. Default: 10.
vpc_owner_id: The Alibaba Cloud account ID of the VPC owner.
tags: The tags of the resource.
Returns:
Dict[str, Any]: The response containing the list of VPCs. |
| describe_vswitches | Query VSwitch list. Args:
region_id: The region ID of the VSwitch. At least one of region_id or vpc_id must be specified.
vpc_id: The ID of the VPC to which the VSwitch belongs. At least one of region_id or vpc_id must be specified.
vswitch_id: The ID of the VSwitch to query.
zone_id: The zone ID of the VSwitch.
vswitch_name: The name of the VSwitch.
resource_group_id: The resource group ID of the VSwitch.
page_number: The page number of the list. Default: 1.
page_size: The number of entries per page. Maximum value: 50. Default: 10.
Returns:
Dict[str, Any]: The response containing the list of VSwitches. |
| describe_slow_log_records | Query slow log records for an RDS instance. Args:
region_id: The region ID of the RDS instance.
dbinstance_id: The ID of the RDS instance.
start_time: Start time in format: yyyy-MM-dd HH:mm.
Cannot be earlier than 30 days before the current time.
end_time: End time in format: yyyy-MM-dd HH:mm.
Must be later than the start time.
sqlhash: The unique identifier of the SQL statement in slow log statistics.
Used to get slow log details for a specific SQL statement.
db_name: The name of the database.
page_size: Number of records per page. Range: 30-100. Default: 30.
page_number: Page number. Must be greater than 0 and not exceed Integer max value. Default: 1.
node_id: Node ID. Only applicable to cluster instances.
If not specified, logs from the primary node are returned by default.
Returns:
Dict[str, Any]: The response containing slow log records. |
| describe_error_logs | Query error logs of an RDS instance.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
start_time: The start time of the query. Format: yyyy-MM-dd HH:mm.
end_time: The end time of the query. Format: yyyy-MM-dd HH:mm.
page_size: The number of records per page. Range: 30~100. Default: 30.
page_number: The page number. Default: 1.
Returns:
Dict[str, Any]: A dictionary containing error log information |
| describe_db_instance_net_info | Batch retrieves network configuration details for multiple RDS instances.
Args:
region_id: The region ID of the RDS instance.
db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
Returns:
list[dict]: A list of dictionaries containing network configuration details for each instance. |
| describe_db_instance_ip_allowlist | Batch retrieves IP allowlist configurations for multiple RDS instances.
Args:
region_id: The region ID of the RDS instance.
db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
Returns:
list[dict]: A list of dictionaries containing network configuration details for each instance. |
| describe_db_instance_databases | Batch retrieves database information for multiple RDS instances.
Args:
region_id: The region ID of the RDS instance.
db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
Returns:
list[dict]: A list of dictionaries containing database information for each instance. |
| describe_db_instance_accounts | Batch retrieves account information for multiple RDS instances.
Args:
region_id: The region ID of the RDS instance.
db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
Returns:
list[dict]: A list of dictionaries containing account information for each instance. |
| create_db_instance_account | Create a new account for an RDS instance.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
account_name: The name of the new account.
account_password: The password for the new account.
account_description: The description for the new account.
account_type: The type of the new account. (e.g. Normal,Super)
Returns:
dict[str, Any]: The response. |
| describe_db_instance_parameters | Batch retrieves parameter information for multiple RDS instances.
Args:
region_id: The region ID of the RDS instance.
db_instance_ids: List of DB instance identifiers (e.g., ["rm-uf6wjk5****", "db-instance-01"])
paramters: List of parameter names (e.g., ["max_connections", "innodb_buffer_pool_size"])
Returns:
list[dict]: A list of dictionaries containing parameter information(ParamGroupInfo,ConfigParameters,RunningParameters) foreach instance. |
| describe_bills | Query the consumption summary of all product instances or billing items for a user within a specific billing period.
Args:
billing_cycles: bill cycle YYYY－MM, e.g. 2020-03
db_instance_id: DB instance id (e.g., "rm-xxx")
is_billing_item: Whether to pull data according to the billing item dimension.
Returns:
str: billing information. |
| modify_db_instance_description | modify db instance description.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
description: The RDS instance description.
Returns:
dict[str, Any]: The response. |
| allocate_instance_public_connection | allocate db instance public connection.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
connection_string_prefix: The prefix of connection string.
Returns:
dict[str, Any]: The response. |
| describe_all_whitelist_template | describe all whitelist template.
Args:
region_id: The region ID of the RDS instance.
template_name: The ID of the RDS instance.
Returns:
List[Dict[str, Any]]: The response contains all whitelist template information. |
| describe_instance_linked_whitelist_template | describe instance linked whitelist template.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
Returns:
dict[str, Any]: The response. |
| attach_whitelist_template_to_instance | allocate db instance public connection.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
template_id: Whitelist Template ID. Can be obtained via DescribeAllWhitelistTemplate.
Returns:
dict[str, Any]: The response. |
| add_tags_to_db_instance | add tags to db instance.
Args:
region_id: The region ID of the RDS instance.
db_instance_id: The ID of the RDS instance.
tags: The tags to be added to the RDS instance.
Returns:
dict[str, Any]: The response. |
| get_current_time | Get the current time. Returns:
Dict[str, Any]: The response containing the current time. |
| modify_security_ips | modify security ips。 Args:
region_id (str): RDS instance region id.
dbinstance_id (str): RDS instance id.
security_ips (str): security ips list, separated by commas.
whitelist_network_type (str, optional): whitelist network type.
- MIX: mixed network type
- Classic: classic network
- VPC: vpc
default value: MIX
security_ip_type (str, optional): security ip type.
- normal: normal security ip
- hidden: hidden security ip
dbinstance_ip_array_name (str, optional): security ip array name.
dbinstance_ip_array_attribute (str, optional): security ip array attribute.
- hidden: hidden security ip
- normal: normal security ip
client_token (str, optional): idempotency token, max 64 ascii characters.
Returns:
Dict[str, Any]: response contains request id. |
| restart_db_instance | Restart an RDS instance. Args:
region_id (str): The region ID of the RDS instance.
dbinstance_id (str): The ID of the RDS instance.
effective_time (str, optional): When to restart the instance. Options:
- Immediate: Restart immediately
- MaintainTime: Restart during maintenance window
- ScheduleTime: Restart at specified time
Default: Immediate
switch_time (str, optional): The scheduled restart time in format: yyyy-MM-ddTHH:mm:ssZ (UTC time).
Required when effective_time is ScheduleTime.
client_token (str, optional): Idempotency token, max 64 ASCII characters.
Returns:
Dict[str, Any]: Response containing the request ID. |
| describe_sql_insight_statistic | Query SQL Log statistics, including SQL cost time, execution times, and account.
Args:
dbinstance_id (str): The ID of the RDS instance.
start_time(str): the start time of sql insight statistic. e.g. 2025-06-06 20:00:00
end_time(str): the end time of sql insight statistic. e.g. 2025-06-06 20:10:00
Returns:
the sql insight statistic information in csv format. |
| show_engine_innodb_status | show engine innodb status in db.
Args:
dbinstance_id (str): The ID of the RDS instance.
region_id(str): the region id of instance.
Returns:
the sql result. |
| show_create_table | show create table db_name.table_name
Args:
dbinstance_id (str): The ID of the RDS instance.
region_id(str): the region id of instance.
db_name(str): the db name for table.
table_name(str): the table name.
Returns:
the sql result. |
| query_sql | execute read-only sql likes show xxx, select xxx
Args:
dbinstance_id (str): The ID of the RDS instance.
region_id(str): the region id of instance.
db_name(str): the db name for execute sql.
sql(str): the sql to be executed.
Returns:
the sql result. |