API概览

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配置。
DescribeInstanceSSL查看RDS AI应用实例SSL配置该接口用于查看RDS AI应用实例的SSL配置。