DescribeDBInstances
Retrieve detailed lists of RDS instances on Alibaba Cloud, filtering by database type, instance status, region, and more for efficient resource management.
Instructions
该接口用于查询RDS的实例列表。
Input Schema
Name | Required | Description | Default |
---|---|---|---|
Category | No | 实例的系列。取值: - **Basic**:基础系列 - **HighAvailability**:高可用系列 - **cluster**:集群系列 - **serverless_basic**:Serverless 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:cluster | |
ClientToken | No | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:ETnLKlblzczshOTUbOCz**** | |
ConnectionMode | No | 实例的访问模式,取值: * **Standard**:标准访问模式 * **Safe**:数据库代理模式 默认返回所有访问模式下的实例。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:Standard | |
ConnectionString | No | 实例的连接地址。通过该连接地址查询对应的实例。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rm-uf6wjk5****.mysql.rds.aliyuncs.com | |
DBInstanceClass | No | 实例规格,详见[实例规格表](~~26312~~)。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rds.mys2.small | |
DBInstanceId | No | 实例ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rm-uf6wjk5**** | |
DBInstanceStatus | No | 实例状态,详情请参见[实例状态表](~~26315~~)。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:Running | |
DBInstanceType | No | 实例类型,取值: * **Primary**:主实例 * **Readonly**:只读实例 * **Guard**:灾备实例 * **Temp**:临时实例 默认返回所有实例类型。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:Primary | |
DedicatedHostGroupId | No | 专属集群ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:dhg-7a9**** | |
DedicatedHostId | No | 专属集群内的主机ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:i-bp**** | |
Engine | No | 数据库类型,取值: * **MySQL** * **SQLServer** * **PostgreSQL** * **MariaDB** 默认返回所有数据库类型。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:MySQL | |
EngineVersion | No | 数据库版本。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:8.0 | |
Expired | No | 实例的过期状态,取值: * **True**:已过期 * **False**:未过期 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:True | |
Filter | No | 实例过滤条件参数及其值的JSON串 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:{"babelfishEnabled":"true"} | |
InstanceLevel | No | 是否返回实例系列(Category)信息,取值: * **0**:不返回 * **1**:返回 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:0 | |
InstanceNetworkType | No | 实例的网络类型,取值: * **VPC**:专有网络下的实例 * **Classic**:经典网络下的实例 默认返回所有网络类型下的实例。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:Classic | |
MaxResults | No | 每页记录数。取值:**1~100**。 默认值:**30**。 >传入该参数,则**PageSize**和**PageNumber**参数不可用。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:30 | |
NextToken | No | 翻页凭证。取值为上一次调用**DescribeDBInstances**接口时返回的**NextToken**参数值。如果调用结果分多页展示,再次调用接口时传入该值便可以展示下一页的内容。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:o7PORW5o2TJg**** | |
PageNumber | No | 页码,取值:大于0且不超过Integer的最大值。 默认值:**1**。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:1 | |
PageSize | No | 每页记录数,取值:**1**~**100**。 默认值:**30**。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: integer,参数示例:30 | |
PayType | No | 付费类型,取值: * **Postpaid**:按量付费 * **Prepaid**:包年包月 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:Postpaid | |
RegionId | Yes | 地域ID。可调用DescribeRegions获取。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:cn-hangzhou | |
ResourceGroupId | No | 资源组ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rg-acfmy**** | |
SearchKey | No | 可基于实例ID或者实例备注模糊搜索。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:rm-uf6w | |
Tags | No | 查询绑定有该标签的实例,包括TagKey和TagValue。单次最多支持传入5组值,格式:{"key1":"value1","key2":"value2"...}。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:{"key1":"value1"} | |
VSwitchId | No | 交换机ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vsw-uf6adz52c2p**** | |
VpcId | No | VPC ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:vpc-uf6f7l4fg90**** | |
ZoneId | No | 可用区ID。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:cn-hangzhou-a | |
proxyId | No | 废弃参数,无需配置。 请注意,提供参数要严格按照参数的类型和参数示例的提示,如果提到参数为String,且为一个 JSON 数组字符串,应在数组内使用单引号包裹对应的参数以避免转义问题,并在最外侧用双引号包裹以确保其是字符串,否则可能会导致参数解析错误。参数类型: string,参数示例:API |
Input Schema (JSON Schema)
You must be authenticated.
Other Tools from AlibabaCloud MCP Server
- DeleteBucket
- DeleteInstances
- DescribeAccountAttributes
- DescribeAvailableResource
- DescribeDBInstances
- DescribeImages
- DescribeInstances
- DescribeRegions
- DescribeSecurityGroups
- DescribeVpcs
- DescribeVSwitches
- DescribeZones
- GetCpuloadavg15mData
- GetCpuloadavg5mData
- GetCpuLoadavgData
- GetCpuUsageData
- GetDiskTotalData
- GetDiskUsageData
- GetDiskUsedData
- GetMemUsageData
- GetMemUsedData
- ListBuckets
- ListObjects
- PutBucket
- RebootInstances
- RebootRDSInstances
- ReplaceSystemDisk
- ResetPassword
- RunCommand
- RunInstances
- StartInstances
- StartRDSInstances
- StopInstances
- StopRDSInstances
Related Tools
- @aliyun/alibabacloud-core-mcp-server
- @aliyun/alibabacloud-core-mcp-server
- @aliyun/alibabacloud-core-mcp-server
- @aliyun/alibabacloud-ecs-mcp-server
- @aliyun/alibabacloud-dataworks-mcp-server