API概览

本产品(云数据库 RDS AI 服务/2025-05-07)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

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应用实例的存储配置。

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配置。