@alicloud/rdsai20250507 3.4.2 → 3.5.0

package/src/models/CreateInspectionTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateInspectionTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * The end time of the inspection task. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. By default, the time range of the task is the latest 24 hours.
+   * The end of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.
    * 
    * @example
    * 2026-01-30T02:10:48Z
@@ -13,22 +13,33 @@ export class CreateInspectionTaskRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The inspection items. Separates multiple items with commas (,). If this parameter is empty or not specified, all inspection items are executed.
-   * 
-   * ### [](#)Valid values:
-   * 
-   * *   instance_info
-   * *   resource_usage
-   * *   connection_session_management
-   * *   performance_metrics
-   * *   slow_query_analysis
-   * *   error_log_analysis
-   * *   lock_wait_deadlock_analysis
-   * *   backup_recovery_analysis
-   * *   high_availability_disaster_recovery_analysis
-   * *   security_configuration_analysis
-   * *   storage_engine_analysis
-   * *   schema_object_analysis
+   * The inspection items to run, separated by commas. If this parameter is omitted, all inspection items are run.
+   * 
+   * ### Inspection items
+   * 
+   * - `instance_info` (instance information)
+   * 
+   * - `resource_usage` (resource usage)
+   * 
+   * - `connection_session_management` (connection and session management)
+   * 
+   * - `performance_metrics` (performance metrics)
+   * 
+   * - `slow_query_analysis` (slow query analysis)
+   * 
+   * - `error_log_analysis` (error log analysis)
+   * 
+   * - `lock_wait_deadlock_analysis` (lock wait and deadlock analysis)
+   * 
+   * - `backup_recovery_analysis` (backup and recovery analysis)
+   * 
+   * - `high_availability_disaster_recovery_analysis` (high availability and disaster recovery inspection)
+   * 
+   * - `security_configuration_analysis` (security configuration inspection)
+   * 
+   * - `storage_engine_analysis` (storage engine inspection)
+   * 
+   * - `schema_object_analysis` (schema and object inspection)
    * 
    * @example
    * instance_info, resource_usage
@@ -36,19 +47,31 @@ export class CreateInspectionTaskRequest extends $dara.Model {
   inspectionItems?: string;
   /**
    * @remarks
-   * The instances covered by the task. Separates multiple instance IDs with commas (,).
+   * The IDs of the instances to inspect. Separate multiple instance IDs with a comma.
    * 
    * @example
    * rm-2ze6mk259v322****,rm-2zef3b65430j0****
    */
   instanceIds?: string;
+  /**
+   * @remarks
+   * The region ID.
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * The language of the inspection report. Valid values are zh-CN (Simplified Chinese) and en-US (English). The default value is en-US.
+   */
   reportLanguage?: string;
   reportRegionId?: string;
+  /**
+   * @remarks
+   * The format of the inspection report. Valid values are pdf and json. The default value is pdf.
+   */
   reportType?: string;
   /**
    * @remarks
-   * The start time of the inspection task. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. By default, the time range of the task is the latest 24 hours.
+   * The beginning of the inspection time range. The time must be in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ. If StartTime and EndTime are not specified, the inspection covers the last 24 hours.
    * 
    * @example
    * 2025-12-28T16:00:00Z

package/src/models/CreateInspectionTaskResponseBody.ts

@@ -35,12 +35,15 @@ export class CreateInspectionTaskResponseBodyData extends $dara.Model {
 export class CreateInspectionTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the result is returned.
+   * The response data.
    */
   data?: CreateInspectionTaskResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
+   * 
+   * @example
+   * 任务创建成功
    */
   message?: string;
   /**

package/src/models/CreateSandboxTemplateRequest.ts

@@ -0,0 +1,79 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSandboxTemplateRequest extends $dara.Model {
+  /**
+   * @example
+   * 1
+   */
+  defaultCpu?: string;
+  /**
+   * @example
+   * 1Gi
+   */
+  defaultMemory?: string;
+  /**
+   * @example
+   * code-interpreter
+   */
+  description?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * ra-supabase-8moov5lxba****
+   */
+  instanceName?: string;
+  /**
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @example
+   * 1
+   */
+  replicas?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * code-interpreter
+   */
+  templateName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      defaultCpu: 'DefaultCpu',
+      defaultMemory: 'DefaultMemory',
+      description: 'Description',
+      instanceName: 'InstanceName',
+      regionId: 'RegionId',
+      replicas: 'Replicas',
+      templateName: 'TemplateName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      defaultCpu: 'string',
+      defaultMemory: 'string',
+      description: 'string',
+      instanceName: 'string',
+      regionId: 'string',
+      replicas: 'number',
+      templateName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSandboxTemplateResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateSandboxTemplateResponseBody } from "./CreateSandboxTemplateResponseBody";
+
+
+export class CreateSandboxTemplateResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateSandboxTemplateResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateSandboxTemplateResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSandboxTemplateResponseBody.ts

@@ -0,0 +1,38 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSandboxTemplateResponseBody extends $dara.Model {
+  /**
+   * @example
+   * ra-supabase-8moov5lxba****
+   */
+  instanceName?: string;
+  /**
+   * @example
+   * FE9C65D7-930F-57A5-A207-8C396329****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceName: 'InstanceName',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceName: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateScheduledTaskRequest.ts

@@ -6,21 +6,32 @@ export class CreateScheduledTaskRequest extends $dara.Model {
   /**
    * @remarks
    * The description of the scheduled inspection task.
+   * 
+   * @example
+   * 定时RDS实例巡检任务
    */
   description?: string;
   /**
    * @remarks
-   * The new inspection frequency. Separate multiple values with commas (,). Default value: DAILY. Valid values:
+   * The inspection frequency. Use commas (,) to separate multiple values. The default is DAILY. Valid values:
+   * 
+   * - DAILY: Every day
+   * 
+   * - Monday: Monday
+   * 
+   * - Tuesday: Tuesday
+   * 
+   * - Wednesday: Wednesday
+   * 
+   * - Thursday: Thursday
    * 
-   * *   DAILY
-   * *   Monday
-   * *   Tuesday
-   * *   Wednesday
-   * *   Thursday
-   * *   Friday
-   * *   Saturday \\*Sunday
+   * - Friday: Friday
    * 
-   * ### [](#daily--dailymonday--daily-)Note: DAILY takes precedence over other values. For example, if you enter DAILY,Monday, the backend uses DAILY as the inspection frequency.
+   * - Saturday: Saturday
+   * 
+   * - Sunday: Sunday
+   * 
+   * ### Note: DAILY overrides weekly values. For example, if you enter DAILY,Monday, the system uses DAILY as the inspection frequency.
    * 
    * @example
    * Monday
@@ -29,7 +40,7 @@ export class CreateScheduledTaskRequest extends $dara.Model {
   inspectionItems?: string;
   /**
    * @remarks
-   * The IDs of the related instances. Separate multiple IDs with commas (,).
+   * The IDs of the instances for the task. Use commas (,) to separate multiple IDs.
    * 
    * @example
    * rm-2ze6mk259v322****,rm-2zef3b65430j0****
@@ -37,18 +48,40 @@ export class CreateScheduledTaskRequest extends $dara.Model {
   instanceIds?: string;
   /**
    * @remarks
-   * The name of the scheduled inspection task. The name cannot exceed 64 characters in length.
+   * The name of the scheduled inspection task. The maximum length is 64 characters.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * RDS巡检
    */
   name?: string;
+  /**
+   * @remarks
+   * The ID of the region.
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * The report language. The default value is zh-CN. Supported values: zh-CN, zh-TW, ja-JP, and en-US.
+   * 
+   * @example
+   * zh-CN
+   */
   reportLanguage?: string;
+  /**
+   * @remarks
+   * The ID of the region where the report is stored.
+   */
   reportRegionId?: string;
+  /**
+   * @remarks
+   * The type of the report.
+   */
   reportType?: string;
   /**
    * @remarks
-   * The time when the inspection task is executed. Specify the time in the ISO 8601 standard in the HH:mm:ssZ format. The time must be in UTC. Default value: 02:00 AM.
+   * The execution time for the scheduled inspection task. Specify the time in the HH:mm:ssZ format (UTC time). The default is 02:00:00Z.
    * 
    * @example
    * 02:00:00Z
@@ -56,7 +89,7 @@ export class CreateScheduledTaskRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The inspection time range. The default value is the latest 24 hours. Valid values: 1 to 168. The maximum value is 7 days.
+   * The time range of data to inspect, in hours. Valid values are from 1 to 168 (7 days). The default is 24.
    * 
    * @example
    * 24

package/src/models/CreateScheduledTaskResponseBody.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateScheduledTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned message.
+   * Provides details about the request outcome, such as a success message or an error description.
+   * 
+   * @example
+   * 创建定时巡检任务成功
    */
   message?: string;
   /**
@@ -18,7 +21,7 @@ export class CreateScheduledTaskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the scheduled inspection configuration.
+   * The ID of the scheduled inspection task.
    * 
    * @example
    * 847268a4-196f-416b-aa12-bfe0c115****
@@ -26,7 +29,7 @@ export class CreateScheduledTaskResponseBody extends $dara.Model {
   scheduledId?: string;
   /**
    * @remarks
-   * The returned results.
+   * Indicates whether the request succeeded. A value of true indicates success.
    * 
    * @example
    * true

package/src/models/CreateSkillRequest.ts

@@ -6,6 +6,9 @@ export class CreateSkillRequest extends $dara.Model {
   /**
    * @remarks
    * The content of the skill.
+   * 
+   * @example
+   * {"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}
    */
   content?: { [key: string]: any };
   /**
@@ -20,6 +23,9 @@ export class CreateSkillRequest extends $dara.Model {
    * The description of the skill. It can be up to 1000 characters in length.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * SQL 查询优化技能。
    */
   description?: string;
   /**

package/src/models/CreateSkillResponseBody.ts

@@ -6,6 +6,9 @@ export class CreateSkillResponseBody extends $dara.Model {
   /**
    * @remarks
    * The database engine-specific content.
+   * 
+   * @example
+   * {"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}
    */
   content?: { [key: string]: any };
   /**
@@ -24,6 +27,9 @@ export class CreateSkillResponseBody extends $dara.Model {
   /**
    * @remarks
    * The description of the skill.
+   * 
+   * @example
+   * SQL查询优化技能。
    */
   description?: string;
   /**

package/src/models/CreateSkillShrinkRequest.ts

@@ -6,6 +6,9 @@ export class CreateSkillShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The content of the skill.
+   * 
+   * @example
+   * {"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}
    */
   contentShrink?: string;
   /**
@@ -20,6 +23,9 @@ export class CreateSkillShrinkRequest extends $dara.Model {
    * The description of the skill. It can be up to 1000 characters in length.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * SQL 查询优化技能。
    */
   description?: string;
   /**

package/src/models/DeleteApiKeyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteApiKeyRequest extends $dara.Model {
   /**
    * @remarks
-   * Api Key
+   * The API key to delete.
    * 
    * This parameter is required.
    * 
@@ -14,6 +14,9 @@ export class DeleteApiKeyRequest extends $dara.Model {
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */

package/src/models/DeleteApiKeyResponseBody.ts

@@ -4,19 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteApiKeyResponseBody extends $dara.Model {
   /**
+   * @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/DeleteSandboxTemplateRequest.ts

@@ -0,0 +1,51 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteSandboxTemplateRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * ra-supabase-8moov5lxba****
+   */
+  instanceName?: string;
+  /**
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * desktop-xxxx
+   */
+  templateId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceName: 'InstanceName',
+      regionId: 'RegionId',
+      templateId: 'TemplateId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceName: 'string',
+      regionId: 'string',
+      templateId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteSandboxTemplateResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DeleteSandboxTemplateResponseBody } from "./DeleteSandboxTemplateResponseBody";
+
+
+export class DeleteSandboxTemplateResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DeleteSandboxTemplateResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DeleteSandboxTemplateResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteSandboxTemplateResponseBody.ts

@@ -0,0 +1,38 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteSandboxTemplateResponseBody extends $dara.Model {
+  /**
+   * @example
+   * ra-supabase-8moov5lxba****
+   */
+  instanceName?: string;
+  /**
+   * @example
+   * FE9C65D7-930F-57A5-A207-8C396329****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      instanceName: 'InstanceName',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      instanceName: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteScheduledTaskResponseBody.ts

@@ -8,7 +8,7 @@ export class DeleteScheduledTaskResponseBody extends $dara.Model {
    * The response message.
    * 
    * @example
-   * The scheduled task is deleted.
+   * 定时任务删除成功
    */
   message?: string;
   /**

package/src/models/DescribeAppInstanceAttributeRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAppInstanceAttributeRequest extends $dara.Model {
   /**
    * @remarks
-   * The region ID.
+   * The instance ID of the AI application.
    * 
    * @example
    * ra-supabase-8moov5lxba****
@@ -13,7 +13,7 @@ export class DescribeAppInstanceAttributeRequest extends $dara.Model {
   instanceName?: string;
   /**
    * @remarks
-   * The operation that you want to perform. Set the value to **DescribeAppInstanceAttribute**.
+   * The region.
    * 
    * @example
    * cn-beijing