API overview
Updated at:
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 | Create a skill | Creates a user-defined skill. |
| UpdateSkill | Update a skill | Updates the information of a specified Skill. |
| ListSkill | Get skill list | Retrieves the custom skills of the current user and all system-preset skills. |
| GetSkill | Get skill details | Retrieves the details of a specified skill. You can retrieve your own skills or system preset skills. |
| DeleteSkill | Delete a skill | Deletes a specified Skill. |
RDS AI assistant
|
API |
Title |
Description |
| ChatMessages | Send a conversation message | Sends a conversation message. |
| ModifyMessagesFeedbacks | Modify message feedback | Modifies message feedback. |
| ChatMessagesTaskStop | Stop a conversation | Stops a conversation. |
| GetConversations | View historical conversations | Queries the historical conversations of a user. |
| GetMessages | View conversation messages | Queries the details of specific conversation messages. |
| DescribeEventsList | Query event list | Queries a list of events. |
| ListCustomAgentTools | Query user agent tool list | Queries the list of Agent tools for a user. |
| UpdateCustomAgent | Update a user agent | Updates a Custom Agent. |
| GetCustomAgent | Query a dedicated agent | Queries a dedicated agent created by the user. |
| ListCustomAgent | Query dedicated agent list | Queries the list of dedicated agents created by the user. |
| DeleteCustomAgent | Delete a user agent | Deletes a dedicated agent created by the user. |
| CreateCustomAgent | Create a user-specific agent | Creates a user-specific agent. |
Instances (RDS supabase)
|
API |
Title |
Description |
| CreateAppInstance | Create an RDS AI application instance | Creates an RDS AI application instance. |
| DeleteAppInstance | Delete an RDS AI application instance | Deletes an RDS AI application instance. |
| RestartInstance | Restart an RDS AI application instance | Restarts an ApsaraDB RDS AI application instance that is in the Running state. |
| StopInstance | Pause an RDS AI application instance | Pauses an RDS AI application instance that is in the Running state. |
| StartInstance | Start an RDS AI application instance | Starts an RDS AI application instance that is in the Stopped state. |
| ResetInstancePassword | Reset RDS AI application instance passwords | Resets the logon password and database access password of an RDS AI application instance. |
| DescribeAppInstanceAttribute | Query RDS AI application instance details | Queries the details of an RDS AI application instance. |
| DescribeAppInstances | Query RDS AI application instances | Queries a list of RDS AI application instances. |
| DescribeInstanceEndpoints | Query endpoint information of an RDS AI application instance | Queries the endpoint information of an RDS AI application instance. |
| DescribeInstanceAuthInfo | Query authentication information of an RDS AI application instance | Queries the authentication information of an RDS AI application instance. |
| ModifyInstanceAuthConfig | Modify authentication configuration of an RDS AI application instance | Modifies the authentication configuration of an RDS AI application instance. |
| DescribeInstanceStorageConfig | Query storage configuration of an RDS AI application instance | Queries the storage configuration of an RDS AI application instance. |
| ModifyInstanceStorageConfig | Modify storage configuration of an RDS AI application instance | Modifies the storage configuration of an RDS AI application instance. |
| ModifyInstanceConfig | Modify general configurations of an RDS AI application instance | Modifies the general configurations of an instance, such as network EIP and NAT configurations. |
RAG Agent
|
API |
Title |
Description |
| ModifyInstanceRAGConfig | Modify RAG agent configuration of an RDS AI application instance | Modifies the RAG Agent configuration of an RDS AI application instance. |
| DescribeInstanceRAGConfig | Query RAG agent configuration of an RDS AI application instance | Queries the RAG Agent configuration of an RDS AI application instance. |
Security
|
API |
Title |
Description |
| ModifyInstanceIpWhitelist | Modify IP whitelist of an RDS AI application instance | Modifies the IP whitelist of an RDS AI application instance. |
| DescribeInstanceIpWhitelist | Query IP whitelist of an RDS AI application instance | Queries the IP whitelist of an RDS AI application instance. |
| ModifyInstanceSSL | Modify SSL configuration of an RDS AI application instance | Modifies the SSL configuration of an RDS AI application instance. |
| ModifyInstancesSSL | Batch modify SSL configurations of RDS AI application instances | Batch modifies the SSL configurations of RDS AI application instances. |
| DescribeInstanceSSL | Query SSL configuration of an RDS AI application instance | Queries the SSL configuration of an RDS AI application instance. |
RDS AI inspection
|
API |
Title |
Description |
| GetScheduledInstances | Query all instance iDs in a specified scheduled inspection configuration | Queries the list of all instance IDs included in a specified scheduled inspection configuration. |
| GetScheduledReports | Query all inspection reports under a specified scheduled task | Queries all inspection reports under a specified scheduled task, with support for filtering by time range and pagination. |
| ListScheduledTasks | Query all inspection configurations of a user | Queries the list of basic information about all inspection configurations under a specified user UID. |
| DeleteScheduledTask | Delete a scheduled inspection configuration | Deletes a specified inspection configuration. |
| ModifyScheduledTask | Modify scheduled inspection configuration | Modifies an existing inspection configuration. |
| CreateScheduledTask | Create a scheduled inspection configuration | Creates a scheduled inspection configuration for batch instances. |
| GetStandAloneReports | Query individual inspection reports for non-scheduled tasks of a specified user | Queries the list of individual inspection reports for all non-scheduled tasks under a specified user, with pagination support. |
| GetInspectionReport | Retrieve inspection report details | Retrieves the details of an inspection report by report ID. |
| CreateInspectionTask | Create a batch instance inspection task | Creates a batch instance inspection task. |
RDS AI assistant ultimate edition
|
API |
Title |
Description |
| UpdateMOQuotaAlertThreshold | Update alert threshold percentage for an API key | Updates the alert threshold percentage for an API key. |
| UpdateApiKeyQuota | Modify API key quota | Modifies the quota of an API key. |
| ResetApiKey | Reset API key | Resets the API key. |
| RenameApiKey | Rename a custom API key | Renames a custom API key. |
| ModifyWhitelistIps | Modify RDS AI assistant ultimate edition instance whitelist | Modifies the IP whitelist of an RDS AI Assistant Ultimate Edition instance. |
| ListApiKeys | Query custom API keys | Queries custom API keys. |
| GetModelOperatorOrder | Retrieve RDS AI assistant ultimate edition order information | Retrieves order information for RDS AI Assistant Ultimate Edition. |
| DescribeWhitelistIps | View RDS AI assistant ultimate edition instance whitelist | Queries the whitelist of an RDS AI Assistant Ultimate Edition instance. |
| DescribeMonitorData | Query instance monitoring data of an RDS AI Assistant Ultimate Edition instance | Queries instance monitoring data of an RDS AI Assistant Ultimate Edition instance. |
| DescribeModelOperator | View basic information and usage of RDS AI assistant ultimate edition | Queries the basic information and usage of an RDS AI Assistant Ultimate Edition instance. |
| DescribeMOTokenUsageDetail | Query token usage records of RDS AI assistant ultimate edition | Queries the token usage records of RDS AI Assistant Ultimate Edition. |
| DeleteApiKey | Delete a custom API key | Deletes a custom API key. |
| CreateApiKey | Create a custom API key | Creates a custom API key. |
Others
|
API |
Title |
Description |
| CreateSandboxTemplate | Create a sandbox template | Creates a sandbox template. |
| DeleteSandboxTemplate | Delete a sandbox template | Deletes a sandbox template. |
| DescribeCommonSandboxTemplates | Query supported sandbox templates | Queries the list of supported sandbox templates. |
| ModifySandboxTemplate | Modify a sandbox template | Modifies a sandbox template. |
| ModifyAppInstance | Modify an RDS AI application instance | Modifies the modules of an RDS AI application instance. |
| ResetInstanceKeys | Reset keys of an RDS AI instance | Resets the keys of an RDS AI instance, including AnonKey, ServiceKey, and JwtSecret. After the reset, the old keys and secret become invalid immediately. Ensure that your applications are updated accordingly. |
| DescribeSandboxTemplates | Query sandbox templates available for sandbox creation | Queries the list of sandbox templates used to create Supabase sandboxes. |
| EnableAgentRuntime | Enable sandbox and edge routine capabilities for supabase | Enables the sandbox and Edge Routine capabilities for a Supabase instance. Read the operation description before you call this operation. |
| DisableAgentRuntime | Disable supabase sandbox and edge routine capabilities | Disables the sandbox and Edge Routine capabilities of a Supabase instance. Note: This operation deletes all sandboxes and Edge Routines of the instance. Fully assess the business risks before performing this operation. |
Is this page helpful?