API标准及多语言预置SDK
本产品（RdsAi/2025-05-07）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
Skill
|
API |
标题 |
API概述 |
| CreateSkill | 创建Skill | 创建用户自定义 Skill。 |
| UpdateSkill | 更新 Skill | 更新指定 Skill 的信息。 |
| ListSkill | 获取Skill列表 | 获取当前用户的自定义 Skill 以及所有系统预置 Skill。 |
| GetSkill | 获取 Skill 详情 | 获取指定 Skill 的详细信息。可获取用户自己的 Skill 或系统预置 Skill。 |
| DeleteSkill | 删除 Skill | 删除指定的 Skill。 |
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 | 创建一个批量实例巡检任务 | 创建一个批量实例巡检任务。 |
RDS AI助手旗舰版
|
API |
标题 |
API概述 |
| UpdateMOQuotaAlertThreshold | 更新 ApiKey 的告警阈值百分比 | 更新 ApiKey 的告警阈值百分比。 |
| UpdateApiKeyQuota | 修改 API KEY 配额 | 修改 API KEY 配额 |
| ResetApiKey | 重置 API KEY | 重置 API KEY |
| RenameApiKey | 重命名自定义 API KEY | 重命名自定义 API KEY |
| ModifyWhitelistIps | 修改 RDS AI 助手旗舰版实例白名单 | 修改 RDS AI 助手旗舰版实例白名单 |
| ListApiKeys | 查看自定义 API KEY | 查看自定义 API KEY |
| GetModelOperatorOrder | 获取 RDS AI 助手旗舰版订单信息 | 获取 RDS AI 助手旗舰版订单信息。 |
| DescribeWhitelistIps | 查看 RDS AI 助手旗舰版实例白名单 | 查看 RDS AI 助手旗舰版实例白名单 |
| DescribeMonitorData | 查询 RDS AI 助手旗舰版实例监控数据 | 查询 RDS AI 助手旗舰版实例监控数据 |
| DescribeModelOperator | 查看 RDS AI 助手旗舰版基础信息和用量 | 查看 RDS AI 助手旗舰版基础信息和用量。 |
| DescribeMOTokenUsageDetail | 查询 RDS AI 助手旗舰版的 Token 使用记录 | 查询 RDS AI 助手旗舰版的 Token 使用记录 |
| DeleteApiKey | 删除自定义 API KEY | 删除自定义 API KEY |
| CreateApiKey | 创建自定义 API KEY | 创建自定义 API KEY。 |
其他
|
API |
标题 |
API概述 |
| DescribeSandboxTemplates | 查询可用于创建沙箱的模板列表 | 查询用于创建Supabase沙箱的沙箱模板列表。 |
| EnableAgentRuntime | 启用Supabase的沙箱和边缘函数能力 | 启用Supabase的沙箱和边缘函数能力，调用该接口前请仔细阅读接口说明。 |
| DisableAgentRuntime | 关闭Supabase的沙箱和边缘函数能力 | 关闭Supabase的沙箱和边缘函数能力。注意：此操作将删除实例所有的沙箱和边缘函数，请充分评估业务风险之后再进行操作。 |
该文章对您有帮助吗？