@alicloud/rdsai20250507 3.4.2 → 3.5.0

package/src/models/DescribeMotokenUsageDetailResponseBody.ts

@@ -4,41 +4,73 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeMOTokenUsageDetailResponseBodyRecords extends $dara.Model {
   /**
+   * @remarks
+   * The consumer associated with the API key.
+   * 
    * @example
    * 16******4_rds_copilot****_public_cn-4****02
    */
   consumerName?: string;
   /**
+   * @remarks
+   * The additional information passed by the user in the extra_info field during the request. The value is a JSON string.
+   * 
+   * @example
+   * {"label": "test"}
+   */
+  extraInfo?: string;
+  /**
+   * @remarks
+   * The number of input tokens consumed.
+   * 
    * @example
    * 10000
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The model that was called.
+   * 
    * @example
    * qwen-flash
    */
   model?: string;
   /**
+   * @remarks
+   * The number of output tokens consumed.
+   * 
    * @example
    * 10000
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * The region in which the instance resides.
+   * 
    * @example
    * cn-beijing
    */
   region?: string;
   /**
+   * @remarks
+   * The request time in ISO 8601 format (UTC).
+   * 
    * @example
    * 2026-04-01T01:00:00Z
    */
   requestTime?: string;
   /**
+   * @remarks
+   * The total number of tokens.
+   * 
    * @example
    * 100000
    */
@@ -46,6 +78,7 @@ export class DescribeMOTokenUsageDetailResponseBodyRecords extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       consumerName: 'ConsumerName',
+      extraInfo: 'ExtraInfo',
       inputTokens: 'InputTokens',
       instanceId: 'InstanceId',
       model: 'Model',
@@ -59,6 +92,7 @@ export class DescribeMOTokenUsageDetailResponseBodyRecords extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       consumerName: 'string',
+      extraInfo: 'string',
       inputTokens: 'number',
       instanceId: 'string',
       model: 'string',
@@ -80,20 +114,33 @@ export class DescribeMOTokenUsageDetailResponseBodyRecords extends $dara.Model {
 
 export class DescribeMOTokenUsageDetailResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The cursor for the next page. An empty value indicates the last page.
+   * 
    * @example
    * eyJpZCI6MTIzNDUsInRzIjoiMjAyNi0wNC0wOFQwMDowMDowMFoifQ==
    */
   nextCursor?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   page?: number;
   /**
+   * @remarks
+   * The number of records per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The list of records returned.
+   */
   records?: DescribeMOTokenUsageDetailResponseBodyRecords[];
   /**
    * @remarks
@@ -104,10 +151,21 @@ export class DescribeMOTokenUsageDetailResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of records that match the query conditions.
+   * 
    * @example
    * 20
    */
   totalCount?: number;
+  /**
+   * @remarks
+   * The usage type.
+   * 
+   * @example
+   * text
+   */
+  usageType?: string;
   static names(): { [key: string]: string } {
     return {
       nextCursor: 'NextCursor',
@@ -116,6 +174,7 @@ export class DescribeMOTokenUsageDetailResponseBody extends $dara.Model {
       records: 'Records',
       requestId: 'RequestId',
       totalCount: 'TotalCount',
+      usageType: 'UsageType',
     };
   }
 
@@ -127,6 +186,7 @@ export class DescribeMOTokenUsageDetailResponseBody extends $dara.Model {
       records: { 'type': 'array', 'itemType': DescribeMOTokenUsageDetailResponseBodyRecords },
       requestId: 'string',
       totalCount: 'number',
+      usageType: 'string',
     };
   }
 

package/src/models/DescribeSandboxTemplatesRequest.ts

@@ -5,31 +5,50 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSandboxTemplatesRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * This parameter is reserved.
+   * 
    * @example
    * None
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token used to retrieve the next page of results. You do not need to specify this parameter for the first request.
+   * 
    * @example
    * gAAAAABo-D-ze1Zog63nWMa8eDDMkqUoBB5-FDsHDUMiNIDSDZeP9g0LwJEozulOPG_LbsGwLRgmDFvTHZeSU90YsukT0pHtnA==
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +56,9 @@ export class DescribeSandboxTemplatesRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the sandbox template.
+   * 
    * @example
    * code-interpreter
    */

package/src/models/DescribeSandboxTemplatesResponseBody.ts

@@ -3,39 +3,59 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeSandboxTemplatesResponseBodySandboxTemplates extends $dara.Model {
+  createdBy?: string;
   /**
+   * @remarks
+   * The default number of CPUs for a sandbox created from this template.
+   * 
    * @example
    * 2
    */
   defaultCpu?: string;
   /**
+   * @remarks
+   * The default memory size for a sandbox created from this template.
+   * 
    * @example
    * 4Gi
    */
   defaultMemory?: string;
   /**
+   * @remarks
+   * The description of the sandbox template.
+   * 
    * @example
    * code-interpreter-vpc
    */
   description?: string;
   /**
+   * @remarks
+   * Specifies whether sandboxes created from this template can access resources in the VPC of the parent RDS Supabase instance.
+   * 
    * @example
    * true
    */
   enableVpcAccess?: string;
   /**
+   * @remarks
+   * The name of the sandbox template.
+   * 
    * @example
    * code-interpreter
    */
   name?: string;
   replicas?: number;
   /**
+   * @remarks
+   * The ID of the sandbox template. Use this ID when you create a sandbox.
+   * 
    * @example
    * code-interpreter-asdxxxx
    */
   templateId?: string;
   static names(): { [key: string]: string } {
     return {
+      createdBy: 'CreatedBy',
       defaultCpu: 'DefaultCpu',
       defaultMemory: 'DefaultMemory',
       description: 'Description',
@@ -48,6 +68,7 @@ export class DescribeSandboxTemplatesResponseBodySandboxTemplates extends $dara.
 
   static types(): { [key: string]: any } {
     return {
+      createdBy: 'string',
       defaultCpu: 'string',
       defaultMemory: 'string',
       description: 'string',
@@ -69,35 +90,54 @@ export class DescribeSandboxTemplatesResponseBodySandboxTemplates extends $dara.
 
 export class DescribeSandboxTemplatesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * This parameter is reserved.
+   * 
    * @example
    * None
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token to retrieve the next page of results. If this parameter is empty, all results have been returned.
+   * 
    * @example
    * AAAAAc3HCuYhJi/wvpk4xOr0VLYz/NvD85HpgBeRBCusEIeVQ0dHZH9jr+NP3X9Jx0iSoql55b9nd4PIDm252/a0f+U=
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned on the current page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * A list of sandbox templates.
+   */
   sandboxTemplates?: DescribeSandboxTemplatesResponseBodySandboxTemplates[];
   /**
+   * @remarks
+   * The total number of entries that match the query.
+   * 
    * @example
    * 20
    */

package/src/models/DescribeWhitelistIpsRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeWhitelistIpsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot****_public_cn-4****02
    */

package/src/models/DescribeWhitelistIpsResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeWhitelistIpsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The domain name.
+   * 
    * @example
    * www.test123.com
    */
   domain?: string;
   /**
+   * @remarks
+   * The list of IP addresses and CIDR blocks on the whitelist.
+   * 
    * @example
    * 127.0.0.1,192.168.1.0/24
    */
@@ -37,21 +43,31 @@ export class DescribeWhitelistIpsResponseBodyData extends $dara.Model {
 }
 
 export class DescribeWhitelistIpsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response data.
+   */
   data?: DescribeWhitelistIpsResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DisableAgentRuntimeRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DisableAgentRuntimeRequest extends $dara.Model {
   /**
+   * @remarks
+   * An idempotent parameter.
+   * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88**********
    */
   clientToken?: string;
   /**
    * @remarks
+   * The ID of the AI application instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,6 +22,9 @@ export class DisableAgentRuntimeRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The ID of the region where the instance is located.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/DisableAgentRuntimeResponseBody.ts

@@ -4,13 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class DisableAgentRuntimeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the AI application instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * D984FD38-6C2D-55DF-B0D7-8BCAC2E1F8C2

package/src/models/EnableAgentRuntimeRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableAgentRuntimeRequest extends $dara.Model {
   /**
+   * @remarks
+   * The idempotence parameter.
+   * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe637760
    */
   clientToken?: string;
   /**
    * @remarks
+   * The instance ID of the AI application.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,16 +22,31 @@ export class EnableAgentRuntimeRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The region ID of the instance.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
+   * @remarks
+   * The security group ID used to create an endpoint.
+   * 
+   * **If not specified**: The system automatically creates a security group named **sg-aliyun-rds-created-supabase-sandbox** in the VPC where the instance resides. No manual operation is required.
+   * 
+   * **If specified**: Ensure that the specified security group allows the CIDR block of the VPC where the Supabase instance resides (both inbound and outbound directions must be allowed). Otherwise, network connectivity issues may occur.
+   * >Notice: The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine capabilities, the system automatically creates the endpoint. When subsequent Supabase instances in the same VPC enable this capability, the existing endpoint is reused and no new endpoint is created.
+   * 
    * @example
    * sg-bp179qkbvlj8ym*****
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The vSwitch ID used to create an endpoint. If this parameter is not specified, the vSwitch of the Supabase instance is used by default.
+   * >Notice: The endpoint is created only once. When the first Supabase instance in a VPC enables the sandbox and Edge Routine capabilities, the system automatically creates the endpoint. When subsequent Supabase instances in the same VPC enable this capability, the existing endpoint is reused and no new endpoint is created.
+   * 
    * @example
    * vsw-9dp2hkpm22gxscfgy****
    */

package/src/models/EnableAgentRuntimeResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class EnableAgentRuntimeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID of the AI application.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */

package/src/models/GetConversationsResponseBody.ts

@@ -22,11 +22,17 @@ export class GetConversationsResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The introduction to the conversation.
+   * 
+   * @example
+   * 测试搜索RDS资源
    */
   introduction?: string;
   /**
    * @remarks
    * The name of the history conversation.
+   * 
+   * @example
+   * 搜索RDS资源。
    */
   name?: string;
   static names(): { [key: string]: string } {

package/src/models/GetCustomAgentRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetCustomAgentRequest extends $dara.Model {
   /**
    * @remarks
-   * The operation that you want to perform. Set the value to **GetCustomAgent**.
+   * The ID of the custom agent.
    * 
    * @example
-   * ebe44453-3b41-4c74-94d1-01d088d7xxxx
+   * ebe44453-3b41-4c74-94d1-01d088d7****
    */
   customAgentId?: string;
   static names(): { [key: string]: string } {

package/src/models/GetCustomAgentResponseBody.ts

@@ -37,7 +37,7 @@ export class GetCustomAgentResponseBodySkills extends $dara.Model {
 export class GetCustomAgentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The creation time of the agent.
+   * The time when the custom agent was created.
    * 
    * @example
    * 2025-06-04T02:25:43Z
@@ -53,7 +53,7 @@ export class GetCustomAgentResponseBody extends $dara.Model {
   enableTools?: boolean;
   /**
    * @remarks
-   * The ID of the backup set.
+   * The ID of the custom agent.
    * 
    * @example
    * 17053
@@ -61,7 +61,10 @@ export class GetCustomAgentResponseBody extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the dedicated agent.
+   * The name of the custom agent.
+   * 
+   * @example
+   * 查询实例列表Agent
    */
   name?: string;
   /**
@@ -69,23 +72,26 @@ export class GetCustomAgentResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * FE9C65D7-930F-57A5-A207-8C396329241C
+   * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
   skills?: GetCustomAgentResponseBodySkills[];
   /**
    * @remarks
-   * The system prompts.
+   * The system prompt for the agent.
+   * 
+   * @example
+   * 我是您用来查询实例列表的专属Agent
    */
   systemPrompt?: string;
   /**
    * @remarks
-   * The details of the tools.
+   * A list of tools enabled for the agent.
    */
   tools?: string[];
   /**
    * @remarks
-   * The modification time of the agent.
+   * The time when the custom agent was last updated.
    * 
    * @example
    * 2020-11-27 16:02:28

package/src/models/GetInspectionReportResponseBody.ts

@@ -59,6 +59,9 @@ export class GetInspectionReportResponseBodyDataDataItems extends $dara.Model {
   /**
    * @remarks
    * The response message.
+   * 
+   * @example
+   * 实例运行状态正常
    */
   message?: string;
   /**
@@ -224,6 +227,9 @@ export class GetInspectionReportResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The description of the instance.
+   * 
+   * @example
+   * 测试实例
    */
   instanceDesc?: string;
   /**
@@ -245,6 +251,9 @@ export class GetInspectionReportResponseBodyData extends $dara.Model {
    * 
    * *   If the InstanceId parameter is not specified, all content of the inspection report is returned. However, the MarkdownText field is empty.
    * *   If the InstanceId parameter is specified, the content related to the instance is returned in the MarkdownText field.
+   * 
+   * @example
+   * # RDS实例巡检报告\\n\\n**实例ID**: `rm-2zep6e5u6l2yu****`\\n\\n**引擎类型**: MySQL\\n\\n**地域**: cn-beijing\\n\\n**时间范围(UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> 本次巡检共包含 **60** 项检查，其中 1项警告、57项正常、2项数据获取失败。……
    */
   markdownText?: string;
   /**
@@ -315,6 +324,9 @@ export class GetInspectionReportResponseBody extends $dara.Model {
   /**
    * @remarks
    * The report text in the markdown format.
+   * 
+   * @example
+   * # RDS批量巡检汇总报告\\n\\n> 本次批量巡检共检查 **1** 个实例；发现 **1** 个实例存在警告（共 1 项警告）……
    */
   markdownText?: string;
   /**

package/src/models/GetMessagesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetMessagesRequest extends $dara.Model {
   /**
    * @remarks
-   * The operation that you want to perform. Set the value to **GetMessages**.
+   * The ID of the conversation.
    * 
    * @example
    * 941c6f59-acf5-4e11-9adc-31e52e1f****
@@ -14,7 +14,7 @@ export class GetMessagesRequest extends $dara.Model {
   eventMode?: string;
   /**
    * @remarks
-   * The ID of the conversation.
+   * The ID of the message from which to start fetching the list. Use this for pagination.
    * 
    * @example
    * 038866af-a050-4bc5-bfad-b7bfc838****
@@ -22,7 +22,7 @@ export class GetMessagesRequest extends $dara.Model {
   firstId?: string;
   /**
    * @remarks
-   * The ID of the first message.
+   * The maximum number of messages to return per page. Valid values: 1–100. Default: 100.
    * 
    * @example
    * 10