API标准及多语言预置SDK
本产品（云数据库 RDS AI 服务/2025-05-07）的 OpenAPI 采用 RPC 签名机制，具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK，您可通过 下载 SDK 快速调用 API，无需关注签名等底层实现细节，显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
RDS AI助手
| API | 标题 | API概述 |
|---|---|---|
| ChatMessages | 发送对话消息 | 发送对话消息。 |
| ModifyMessagesFeedbacks | 修改消息反馈 | 该功能用于修改消息反馈。 |
| ChatMessagesTaskStop | 停止对话 | 停止对话。 |
| GetConversations | 查看历史对话 | 该接口用于查询用户历史对话。 |
| GetMessages | 查看对话消息 | 该接口用于来查看具体对话消息。 |
| DescribeEventsList | 查询事件列表 | 该接口用于查询事件列表。 |
| ListCustomAgentTools | 查询用户Agent工具列表 | 该接口用于查询用户Agent工具列表。 |
| UpdateCustomAgent | 更新用户Agent | 更新Custom Agent。 |
| GetCustomAgent | 查询专属Agent | 用于查询用户创建的专属Agent。 |
| ListCustomAgent | 查询专属Agent列表 | 该接口用于查询用户创建的专属Agent列表。 |
| DeleteCustomAgent | 删除用户Agent | 该接口用于删除用户创建的专属Agent。 |
| CreateCustomAgent | 创建用户专属Agent | 该接口用于创建用户专属Agent。 |
实例（RDS Supabase）
| API | 标题 | API概述 |
|---|---|---|
| CreateAppInstance | 创建RDS AI应用实例 | 该接口用于创建RDS AI应用实例。 |
| DeleteAppInstance | 删除RDS AI应用实例 | 该接口用于删除RDS AI应用实例。 |
| RestartInstance | 重启RDS AI应用实例 | 该接口用于重启运行状态为运行中（Running）的RDS AI应用实例。 |
| StopInstance | 暂停RDS AI应用实例 | 该接口用于暂停运行状态为运行中（Running）的RDS AI应用实例。 |
| StartInstance | 启动RDS AI应用实例 | 该接口用于启动运行状态为已暂停（Stopped）的RDS AI应用实例。 |
| ResetInstancePassword | 重置RDS AI应用实例密码 | 该接口用于重置RDS AI应用实例的登录密码和数据库访问密码。 |
| DescribeAppInstanceAttribute | 查询RDS AI应用实例详情 | 该接口用于查询RDS AI应用实例详情。 |
| DescribeAppInstances | 查询RDS AI应用实例列表 | 该接口用于查询RDS AI应用实例列表。 |
| DescribeInstanceEndpoints | 查询RDS AI应用实例连接地址信息 | 该接口用于查询RDS AI应用实例连接地址信息。 |
| DescribeInstanceAuthInfo | 查询RDS AI应用实例认证信息 | 该接口用于查询RDS AI应用实例的认证信息。 |
| ModifyInstanceAuthConfig | 修改RDS AI应用实例认证信息配置 | 该接口用于修改RDS AI应用实例认证信息配置。 |
| DescribeInstanceStorageConfig | 查看RDS AI应用实例存储配置 | 该接口用于查看RDS AI应用实例的存储配置。 |
| ModifyInstanceStorageConfig | 修改RDS AI应用实例存储配置 | 该接口用于修改RDS AI应用实例的存储配置。 |
| ModifyInstanceConfig | 修改RDS AI应用实例通用配置 | 修改实例通用配置，如网络eip、nat等配置。 |
RAG Agent
| API | 标题 | API概述 |
|---|---|---|
| ModifyInstanceRAGConfig | 修改RDS AI应用实例RAG Agent配置 | 该接口用于修改RDS AI应用实例的RAG Agent配置。 |
| DescribeInstanceRAGConfig | 查看RDS AI应用实例RAG Agent配置 | 该接口用于查看RDS AI应用实例的RAG Agent配置。 |
安全
| API | 标题 | API概述 |
|---|---|---|
| ModifyInstanceIpWhitelist | 修改RDS AI应用实例IP白名单 | 该接口用于修改RDS AI应用实例的IP白名单。 |
| DescribeInstanceIpWhitelist | 查看RDS AI应用实例IP白名单 | 该接口用于查看RDS AI应用实例的IP白名单。 |
| ModifyInstanceSSL | 修改RDS AI应用实例SSL配置 | 该接口用于修改RDS AI应用实例的SSL配置。 |
| ModifyInstancesSSL | 批量修改RDS AI应用实例SSL配置 | 该接口用于批量修改RDS AI应用实例的SSL配置。 |
| DescribeInstanceSSL | 查看RDS AI应用实例SSL配置 | 该接口用于查看RDS AI应用实例的SSL配置。 |
RDS AI巡检
| API | 标题 | API概述 |
|---|---|---|
| GetScheduledInstances | 查询指定定时巡检配置中包含的所有实例ID列表。 | 查询指定定时巡检配置中包含的所有实例ID列表。 |
| GetScheduledReports | 查询指定定时任务下的所有巡检报告列表 | 查询指定定时任务下的所有巡检报告列表，支持按时间范围过滤和分页。 |
| ListScheduledTasks | 查询用户所有巡检配置 | 查询指定用户UID下所有巡检配置的基本信息列表。 |
| DeleteScheduledTask | 删除定时巡检配置 | 删除指定的巡检配置。 |
| ModifyScheduledTask | 修改定时巡检配置 | 修改已存在的巡检配置。 |
| CreateScheduledTask | 创建定时巡检配置 | 创建一个新的批量实例定时巡检配置。 |
| GetStandAloneReports | 查询指定用户下所有非定时任务的单独巡检报告列表 | 查询指定用户下所有非定时任务的单独巡检报告列表，支持分页。 |
| GetInspectionReport | 获取该巡检报告的具体内容 | 通过巡检报告ID获取该巡检报告的具体内容。 |
| CreateInspectionTask | 创建一个批量实例巡检任务 | 创建一个批量实例巡检任务。 |