API standards and multilingual preset SDKs
The OpenAPI of this product (RdsAi/2025-05-07) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Skill
|
API |
Title |
Description |
| CreateSkill | CreateSkill | Create a user-defined skill. |
| UpdateSkill | UpdateSkill | Updates the information about a specified skill. |
| ListSkill | ListSkill | Obtains the user-defined skills and all system preset skills of the current user. |
| GetSkill | GetSkill | Obtains the details of a specified skill. You can obtain the details of user-defined skills or the system preset skills. |
| DeleteSkill | DeleteSkill | Deletes the specified skill. |
RDS AI assistant
|
API |
Title |
Description |
| ChatMessages | ChatMessages | Sends chat messages. |
| ModifyMessagesFeedbacks | ModifyMessagesFeedbacks | Modifies the returned messages. |
| ChatMessagesTaskStop | ChatMessagesTaskStop | Stops a conversation. |
| GetConversations | GetConversations | Queries the history conversations of a user. |
| GetMessages | GetMessages | Retrieves a list of messages in a specific conversation. |
| DescribeEventsList | DescribeEventsList | This API retrieves the list of events. |
| ListCustomAgentTools | ListCustomAgentTools | Queries the custom agent tools of the user. |
| UpdateCustomAgent | UpdateCustomAgent | Updates a custom agent. |
| GetCustomAgent | GetCustomAgent | Retrieves details for a specified custom agent. |
| ListCustomAgent | ListCustomAgent | Lists your custom agents. |
| DeleteCustomAgent | DeleteCustomAgent | Deletes the dedicated agent created by a user. |
| CreateCustomAgent | Create a user-specific agent | Creates a user-specific agent. |
Instances (RDS supabase)
|
API |
Title |
Description |
| CreateAppInstance | CreateAppInstance | Creates an RDS Supabase instance. |
| DeleteAppInstance | DeleteAppInstance | Deletes an RDS Supabase instance. |
| RestartInstance | RestartInstance | Restarts an RDS Supabase instance that is in the Running state. |
| StopInstance | StopInstance | Stops a running RDS Supabase instance. |
| StartInstance | StartInstance | Starts a stopped RDS Supabase instance. |
| ResetInstancePassword | ResetInstancePassword | Resets the logon password of the RDS Supabase instance and the access password of the database. |
| DescribeAppInstanceAttribute | DescribeAppInstanceAttribute | Retrieves details for a specified RDS AI application instance. |
| DescribeAppInstances | DescribeAppInstances | This API retrieves a list of RDS AI application instances. |
| DescribeInstanceEndpoints | DescribeInstanceEndpoints | Queries the endpoint of an RDS Supabase instance. |
| DescribeInstanceAuthInfo | DescribeInstanceAuthInfo | Queries the authentication information about an RDS Supabase instance. |
| ModifyInstanceAuthConfig | ModifyInstanceAuthConfig | Modifies the authentication configurations of an RDS Supabase instance. |
| DescribeInstanceStorageConfig | DescribeInstanceStorageConfig | Queries the storage configurations of an RDS Supabase instance. |
| ModifyInstanceStorageConfig | ModifyInstanceStorageConfig | Modifies the storage configurations of an RDS Supabase instance. |
| ModifyInstanceConfig | ModifyInstanceConfig | Modifies the general configurations of an instance, such as the EIP and NAT settings. |
RAG Agent
|
API |
Title |
Description |
| ModifyInstanceRAGConfig | ModifyInstanceRAGConfig | Modifies the RAG agent configurations of an RDS Supabase instance. |
| DescribeInstanceRAGConfig | DescribeInstanceRAGConfig | Queries the RAG agent configurations of an RDS Supabase instance. |
Security
|
API |
Title |
Description |
| ModifyInstanceIpWhitelist | ModifyInstanceIpWhitelist | Modifies the IP address whitelist of an RDS Supabase instance. |
| DescribeInstanceIpWhitelist | DescribeInstanceIpWhitelist | Queries the IP address whitelists of an RDS Supabase instance. |
| ModifyInstanceSSL | ModifyInstanceSSL | Modifies the SSL settings of an RDS Supabase instance. |
| ModifyInstancesSSL | ModifyInstancesSSL | Modifies the SSL settings of RDS Supabase instances in batches. |
| DescribeInstanceSSL | DescribeInstanceSSL | Queries the SSL settings of an RDS Supabase instance. |
RDS AI inspection
|
API |
Title |
Description |
| GetScheduledInstances | GetScheduledInstances | Queries the IDs of all instances that are included by a specified scheduled inspection configuration. |
| GetScheduledReports | GetScheduledReports | Retrieves all inspection reports for a specified scheduled task. You can filter the results by time range and use pagination. |
| ListScheduledTasks | ListScheduledTasks | Lists basic information about all inspection configurations for the specified user ID. |
| DeleteScheduledTask | DeleteScheduledTask | Deletes a specified inspection configuration. |
| ModifyScheduledTask | ModifyScheduledTask | Modifies an existing inspection configuration. |
| CreateScheduledTask | CreateScheduledTask | Creates a scheduled inspection task for one or more instances. |
| GetStandAloneReports | GetStandAloneReports | Retrieves paginated standalone inspection reports on a specified user's non-scheduled tasks. |
| GetInspectionReport | GetInspectionReport | Queries the content of a specified inspection report. |
| CreateInspectionTask | CreateInspectionTask | Creates an inspection task for one or more instances. |
RDS AI assistant ultimate edition
|
API |
Title |
Description |
| UpdateMOQuotaAlertThreshold | UpdateMOQuotaAlertThreshold | Updates the alert threshold percentage for API keys. |
| UpdateApiKeyQuota | Modify API Key Quota | Modify the API KEY Quota |
| ResetApiKey | Reset API key | Resets an API key. |
| RenameApiKey | Rename a Custom API Key | Renames an API key. |
| ModifyWhitelistIps | Modify the IP address whitelist of an RDS AI Assistant Ultimate instance | Modifies the IP whitelist for an RDS AI Assistant Enterprise Edition instance. |
| ListApiKeys | View Custom API Key | View Custom API Key |
| GetModelOperatorOrder | Obtain RDS AI Assistant Ultimate order information | Obtain RDS AI Assistant Ultimate order information |
| DescribeWhitelistIps | View the whitelist of an RDS AI Assistant Ultimate instance | Describes the whitelist of an RDS AI Assistant Enterprise Edition instance. |
| DescribeMonitorData | Query instance monitoring data of RDS AI Assistant Ultimate | Retrieves monitoring data for an RDS AI Assistant Ultimate Edition instance. |
| DescribeModelOperator | View Basic Information and Usage of RDS AI Assistant Ultimate | View basic information and usage for the RDS AI Assistant Ultimate Edition. |
| DescribeMOTokenUsageDetail | Query Token usage records for RDS AI Assistant Ultimate | Retrieves the token usage records for RDS AI Assistant Enterprise Edition. |
| DeleteApiKey | Delete a custom API key | Deletes a custom API key. |
| CreateApiKey | Create Custom API KEY | Create a custom API key. |
Others
|
API |
Title |
Description |
| DescribeSandboxTemplates | Query the List of Templates Available for Creating a Sandbox | Lists the sandbox templates you can use to create Supabase sandboxes. |
| EnableAgentRuntime | Enable the sandbox and edge function capabilities of Supabase | This operation enables the sandbox and edge functions for Supabase. Before calling this operation, carefully read the API description. |
| DisableAgentRuntime | DisableAgentRuntime | Disables the sandbox and edge function capabilities for a Supabase instance. Note: This operation deletes all sandboxes and edge functions of the instance. Fully assess the business risks before you proceed. |