@alicloud/rdsai20250507 3.8.0 → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/dist/client.d.ts +18 -26
  2. package/dist/client.js +38 -34
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ChatMessagesRequest.d.ts +26 -2
  5. package/dist/models/ChatMessagesRequest.js.map +1 -1
  6. package/dist/models/ChatMessagesResponseBody.d.ts +2 -2
  7. package/dist/models/ChatMessagesShrinkRequest.d.ts +4 -1
  8. package/dist/models/ChatMessagesShrinkRequest.js.map +1 -1
  9. package/dist/models/CreateApiKeyRequest.d.ts +9 -3
  10. package/dist/models/CreateApiKeyRequest.js +4 -0
  11. package/dist/models/CreateApiKeyRequest.js.map +1 -1
  12. package/dist/models/CreateApiKeyResponseBody.d.ts +13 -8
  13. package/dist/models/CreateApiKeyResponseBody.js +2 -0
  14. package/dist/models/CreateApiKeyResponseBody.js.map +1 -1
  15. package/dist/models/CreateInspectionTaskRequest.d.ts +2 -2
  16. package/dist/models/CreateScheduledTaskRequest.d.ts +12 -12
  17. package/dist/models/DeleteApiKeyRequest.d.ts +1 -1
  18. package/dist/models/DeleteApiKeyResponseBody.d.ts +2 -2
  19. package/dist/models/DeleteScheduledTaskResponseBody.d.ts +2 -2
  20. package/dist/models/GetInspectionReportRequest.d.ts +1 -1
  21. package/dist/models/GetInspectionReportResponseBody.d.ts +2 -2
  22. package/dist/models/GetScheduledInstancesRequest.d.ts +2 -2
  23. package/dist/models/GetScheduledInstancesResponseBody.d.ts +9 -9
  24. package/dist/models/GetStandAloneReportsRequest.d.ts +2 -2
  25. package/dist/models/GetStandAloneReportsResponseBody.d.ts +2 -2
  26. package/dist/models/ListApiKeysResponseBody.d.ts +17 -9
  27. package/dist/models/ListApiKeysResponseBody.js +2 -0
  28. package/dist/models/ListApiKeysResponseBody.js.map +1 -1
  29. package/dist/models/ListScheduledTasksResponseBody.d.ts +1 -1
  30. package/dist/models/ModifyScheduledTaskRequest.d.ts +3 -1
  31. package/dist/models/ModifyScheduledTaskRequest.js.map +1 -1
  32. package/dist/models/RenameApiKeyRequest.d.ts +5 -3
  33. package/dist/models/RenameApiKeyRequest.js +4 -0
  34. package/dist/models/RenameApiKeyRequest.js.map +1 -1
  35. package/dist/models/RenameApiKeyResponseBody.d.ts +2 -2
  36. package/package.json +1 -1
  37. package/src/client.ts +42 -34
  38. package/src/models/ChatMessagesRequest.ts +26 -2
  39. package/src/models/ChatMessagesResponseBody.ts +2 -2
  40. package/src/models/ChatMessagesShrinkRequest.ts +4 -1
  41. package/src/models/CreateApiKeyRequest.ts +13 -3
  42. package/src/models/CreateApiKeyResponseBody.ts +15 -8
  43. package/src/models/CreateInspectionTaskRequest.ts +2 -2
  44. package/src/models/CreateScheduledTaskRequest.ts +12 -12
  45. package/src/models/DeleteApiKeyRequest.ts +1 -1
  46. package/src/models/DeleteApiKeyResponseBody.ts +2 -2
  47. package/src/models/DeleteScheduledTaskResponseBody.ts +2 -2
  48. package/src/models/GetInspectionReportRequest.ts +1 -1
  49. package/src/models/GetInspectionReportResponseBody.ts +2 -2
  50. package/src/models/GetScheduledInstancesRequest.ts +2 -2
  51. package/src/models/GetScheduledInstancesResponseBody.ts +9 -9
  52. package/src/models/GetStandAloneReportsRequest.ts +2 -2
  53. package/src/models/GetStandAloneReportsResponseBody.ts +2 -2
  54. package/src/models/ListApiKeysResponseBody.ts +19 -9
  55. package/src/models/ListScheduledTasksResponseBody.ts +1 -1
  56. package/src/models/ModifyScheduledTaskRequest.ts +3 -1
  57. package/src/models/RenameApiKeyRequest.ts +9 -3
  58. package/src/models/RenameApiKeyResponseBody.ts +2 -2
@@ -8,7 +8,7 @@ export class DeleteScheduledTaskResponseBody extends $dara.Model {
8
8
  * The response message.
9
9
  *
10
10
  * @example
11
- * 定时任务删除成功
11
+ * Scheduled task deleted successfully
12
12
  */
13
13
  message?: string;
14
14
  /**
@@ -21,7 +21,7 @@ export class DeleteScheduledTaskResponseBody extends $dara.Model {
21
21
  requestId?: string;
22
22
  /**
23
23
  * @remarks
24
- * Indicates whether the request was successful.
24
+ * The request result.
25
25
  *
26
26
  * @example
27
27
  * true
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetInspectionReportRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The instance ID for the inspection. If this parameter is not specified, the entire report is returned. If this parameter is specified, only the content for the specified instance is returned.
8
+ * The instance ID. If this parameter is not specified, the entire report is returned. If this parameter is specified, only the content for the specified instance is returned.
9
9
  *
10
10
  * @example
11
11
  * rm-2zep6e5u6l2yu****
@@ -248,11 +248,11 @@ export class GetInspectionReportResponseBodyData extends $dara.Model {
248
248
  /**
249
249
  * @remarks
250
250
  * The Markdown text.
251
- * * If the InstanceId parameter is not specified: the reports for all instances in the inspection report are returned, but the MarkdownText field is empty ("").
251
+ * * If the InstanceId parameter is not specified: the reports for all instances under this inspection report are returned, but the MarkdownText field is empty ("").
252
252
  * * If the InstanceId parameter is specified: the report for the specified instance is returned, and the MarkdownText field contains the specific content.
253
253
  *
254
254
  * @example
255
- * # RDS Instance Inspection Report\\n\\n**Instance ID**: `rm-2zep6e5u6l2yu****`\\n\\n**Engine Type**: MySQL\\n\\n**Region**: cn-beijing\\n\\n**Time Range (UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> This inspection includes **60** checks, of which 1 warning, 57 normal, and 2 failed to retrieve data.……
255
+ * # RDS Instance Inspection Report\\n\\n**Instance ID**: `rm-2zep6e5u6l2yu****`\\n\\n**Engine Type**: MySQL\\n\\n**Region**: cn-beijing\\n\\n**Time Range (UTC)**: 2026-02-04T03:31:00Z ~ 2026-02-05T03:31:00Z\\n\\n> This inspection includes **60** check items, of which 1 warning, 57 normal, and 2 failed to retrieve data.……
256
256
  */
257
257
  markdownText?: string;
258
258
  /**
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetScheduledInstancesRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The page number. Pages start from 1. Default value: 1.
8
+ * The page number. Default value: 1.
9
9
  *
10
10
  * @example
11
11
  * 1
@@ -13,7 +13,7 @@ export class GetScheduledInstancesRequest extends $dara.Model {
13
13
  pageNumber?: number;
14
14
  /**
15
15
  * @remarks
16
- * The number of records on each page. Default value: 20. Maximum value: 100.
16
+ * The number of entries per page. Default value: 20. Maximum value: 100.
17
17
  *
18
18
  * @example
19
19
  * 20
@@ -16,7 +16,7 @@ export class GetScheduledInstancesResponseBodyInstances extends $dara.Model {
16
16
  * The instance description.
17
17
  *
18
18
  * @example
19
- * 巡检测试实例。
19
+ * Inspection test instance
20
20
  */
21
21
  instanceDesc?: string;
22
22
  /**
@@ -29,7 +29,7 @@ export class GetScheduledInstancesResponseBodyInstances extends $dara.Model {
29
29
  instanceId?: string;
30
30
  /**
31
31
  * @remarks
32
- * The region in which the instance resides.
32
+ * The region where the instance resides.
33
33
  *
34
34
  * @example
35
35
  * cn-hangzhou
@@ -37,7 +37,7 @@ export class GetScheduledInstancesResponseBodyInstances extends $dara.Model {
37
37
  region?: string;
38
38
  /**
39
39
  * @remarks
40
- * The status of the instance.
40
+ * The instance status.
41
41
  *
42
42
  * @example
43
43
  * Running
@@ -75,7 +75,7 @@ export class GetScheduledInstancesResponseBodyInstances extends $dara.Model {
75
75
  export class GetScheduledInstancesResponseBody extends $dara.Model {
76
76
  /**
77
77
  * @remarks
78
- * The list of instances included in the inspection configuration.
78
+ * The list of instances.
79
79
  */
80
80
  instances?: GetScheduledInstancesResponseBodyInstances[];
81
81
  /**
@@ -83,12 +83,12 @@ export class GetScheduledInstancesResponseBody extends $dara.Model {
83
83
  * The response message.
84
84
  *
85
85
  * @example
86
- * 获取巡检实例ID列表成功
86
+ * Successfully retrieved the list of inspection instance IDs
87
87
  */
88
88
  message?: string;
89
89
  /**
90
90
  * @remarks
91
- * The page number. Pages start from 1. Default value: 1.
91
+ * The page number. Default value: 1.
92
92
  *
93
93
  * @example
94
94
  * 1
@@ -96,7 +96,7 @@ export class GetScheduledInstancesResponseBody extends $dara.Model {
96
96
  pageNumber?: number;
97
97
  /**
98
98
  * @remarks
99
- * The number of records on each page. Default value: 20. Maximum value: 100.
99
+ * The number of entries per page. Default value: 20. Maximum value: 100.
100
100
  *
101
101
  * @example
102
102
  * 10
@@ -112,7 +112,7 @@ export class GetScheduledInstancesResponseBody extends $dara.Model {
112
112
  requestId?: string;
113
113
  /**
114
114
  * @remarks
115
- * Indicates whether the request was successful.
115
+ * The request result.
116
116
  *
117
117
  * @example
118
118
  * true
@@ -120,7 +120,7 @@ export class GetScheduledInstancesResponseBody extends $dara.Model {
120
120
  success?: boolean;
121
121
  /**
122
122
  * @remarks
123
- * The total number of records that are returned.
123
+ * The total number of records.
124
124
  *
125
125
  * @example
126
126
  * 20
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetStandAloneReportsRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The end time for filtering (format: YYYY-MM-DDTHH:mm:ssZ). If not specified, no filtering is applied.
8
+ * The end time filter in the format of YYYY-MM-DDTHH:mm:ssZ. If this parameter is not specified, no end time filter is applied.
9
9
  *
10
10
  * @example
11
11
  * 2026-01-19T02:20:20Z
@@ -30,7 +30,7 @@ export class GetStandAloneReportsRequest extends $dara.Model {
30
30
  reportType?: string;
31
31
  /**
32
32
  * @remarks
33
- * The start time for filtering (format: YYYY-MM-DDTHH:mm:ssZ). If not specified, no filtering is applied.
33
+ * The start time filter in the format of YYYY-MM-DDTHH:mm:ssZ. If this parameter is not specified, no start time filter is applied.
34
34
  *
35
35
  * @example
36
36
  * 2025-03-11T02:09:00Z
@@ -13,7 +13,7 @@ export class GetStandAloneReportsResponseBodyReports extends $dara.Model {
13
13
  createdTime?: string;
14
14
  /**
15
15
  * @remarks
16
- * The inspection end time (format: YYYY-MM-DDTHH:mm:ssZ).
16
+ * The inspection end time in the format of YYYY-MM-DDTHH:mm:ssZ.
17
17
  *
18
18
  * @example
19
19
  * 2026-01-23T08:20:31Z
@@ -25,7 +25,7 @@ export class GetStandAloneReportsResponseBodyReports extends $dara.Model {
25
25
  reportType?: string;
26
26
  /**
27
27
  * @remarks
28
- * The inspection start time (format: YYYY-MM-DDTHH:mm:ssZ).
28
+ * The inspection start time in the format of YYYY-MM-DDTHH:mm:ssZ.
29
29
  *
30
30
  * @example
31
31
  * 2026-01-23T08:00:31Z
@@ -12,6 +12,9 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
12
12
  */
13
13
  apiKey?: string;
14
14
  /**
15
+ * @remarks
16
+ * The daily throttling quota.
17
+ *
15
18
  * @example
16
19
  * 100000000
17
20
  */
@@ -26,7 +29,7 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
26
29
  isRateLimited?: boolean;
27
30
  /**
28
31
  * @remarks
29
- * The name of the API key.
32
+ * The API key name.
30
33
  *
31
34
  * @example
32
35
  * api-*****
@@ -34,7 +37,7 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
34
37
  keyName?: string;
35
38
  /**
36
39
  * @remarks
37
- * The quota ratio.
40
+ * The quota limit ratio.
38
41
  *
39
42
  * @example
40
43
  * 0.2
@@ -42,18 +45,20 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
42
45
  limitRate?: number;
43
46
  /**
44
47
  * @remarks
45
- * The quota type. Valid values:
46
- * - **fixed**: fixed value.
47
- * - **ratio**: percentage.
48
- * - **auto**: automatic allocation.
48
+ * The quota limit method. Valid values:
49
+ *
50
+ * - **fixed**: Fixed value.
51
+ * - **ratio**: Percentage.
52
+ * - **auto**: Automatic allocation.
49
53
  *
50
54
  * @example
51
55
  * fixed
52
56
  */
53
57
  limitType?: string;
58
+ roleArn?: string;
54
59
  /**
55
60
  * @remarks
56
- * The alert threshold percentage. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert is reset when the usage drops below this percentage.
61
+ * The alert threshold percentage. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert resets when the usage drops below this percentage.
57
62
  *
58
63
  * @example
59
64
  * 80
@@ -61,7 +66,7 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
61
66
  thresholdPercent?: number;
62
67
  /**
63
68
  * @remarks
64
- * The quota of the current key.
69
+ * The quota limit of the current key.
65
70
  *
66
71
  * @example
67
72
  * 10000
@@ -75,6 +80,7 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
75
80
  keyName: 'KeyName',
76
81
  limitRate: 'LimitRate',
77
82
  limitType: 'LimitType',
83
+ roleArn: 'RoleArn',
78
84
  thresholdPercent: 'ThresholdPercent',
79
85
  tokenQuota: 'TokenQuota',
80
86
  };
@@ -88,6 +94,7 @@ export class ListApiKeysResponseBodyDataCustomKeyList extends $dara.Model {
88
94
  keyName: 'string',
89
95
  limitRate: 'number',
90
96
  limitType: 'string',
97
+ roleArn: 'string',
91
98
  thresholdPercent: 'number',
92
99
  tokenQuota: 'number',
93
100
  };
@@ -117,6 +124,9 @@ export class ListApiKeysResponseBodyData extends $dara.Model {
117
124
  */
118
125
  customKeyList?: ListApiKeysResponseBodyDataCustomKeyList[];
119
126
  /**
127
+ * @remarks
128
+ * The daily throttling quota for the system API key.
129
+ *
120
130
  * @example
121
131
  * 100000000
122
132
  */
@@ -155,7 +165,7 @@ export class ListApiKeysResponseBodyData extends $dara.Model {
155
165
  systemApiKey?: string;
156
166
  /**
157
167
  * @remarks
158
- * The alert threshold percentage for SystemApiKey. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert is reset when the usage drops below this percentage.
168
+ * The alert threshold percentage for SystemApiKey. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert resets when the usage drops below this percentage.
159
169
  *
160
170
  * @example
161
171
  * 80
@@ -16,7 +16,7 @@ export class ListScheduledTasksResponseBodySchedules extends $dara.Model {
16
16
  * The inspection description.
17
17
  *
18
18
  * @example
19
- * Automatically inspect production ApsaraDB RDS instances at 2:00 AM every day
19
+ * Automatically inspect production RDS instances at 2 AM every day
20
20
  */
21
21
  description?: string;
22
22
  /**
@@ -14,6 +14,7 @@ export class ModifyScheduledTaskRequest extends $dara.Model {
14
14
  /**
15
15
  * @remarks
16
16
  * The new inspection frequency. Separate multiple values with commas (,). Default value: DAILY. Valid values:
17
+ *
17
18
  * * DAILY: every day
18
19
  * * Monday: Monday
19
20
  * * Tuesday: Tuesday
@@ -22,6 +23,7 @@ export class ModifyScheduledTaskRequest extends $dara.Model {
22
23
  * * Friday: Friday
23
24
  * * Saturday: Saturday
24
25
  * * Sunday: Sunday
26
+ *
25
27
  * ### Note: DAILY overrides weekly values. For example, if you specify DAILY,Monday, the backend uses DAILY as the inspection frequency.
26
28
  *
27
29
  * @example
@@ -31,7 +33,7 @@ export class ModifyScheduledTaskRequest extends $dara.Model {
31
33
  inspectionItems?: string;
32
34
  /**
33
35
  * @remarks
34
- * The new list of associated instance IDs. Separate multiple values with commas (,).
36
+ * The new list of associated instances. Separate multiple values with commas (,).
35
37
  *
36
38
  * @example
37
39
  * rm-2ze6mk259v322****,rm-2zef3b65430j0****
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class RenameApiKeyRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The API key to rename.
8
+ * API KEY
9
9
  *
10
10
  * This parameter is required.
11
11
  *
@@ -15,7 +15,7 @@ export class RenameApiKeyRequest extends $dara.Model {
15
15
  apiKey?: string;
16
16
  /**
17
17
  * @remarks
18
- * The ID of the instance.
18
+ * The instance ID.
19
19
  *
20
20
  * @example
21
21
  * rds_copilot***_public_cn-*********6
@@ -23,7 +23,7 @@ export class RenameApiKeyRequest extends $dara.Model {
23
23
  instanceId?: string;
24
24
  /**
25
25
  * @remarks
26
- * The new name for the API key.
26
+ * The API key name.
27
27
  *
28
28
  * This parameter is required.
29
29
  *
@@ -31,11 +31,15 @@ export class RenameApiKeyRequest extends $dara.Model {
31
31
  * api-*****
32
32
  */
33
33
  keyName?: string;
34
+ roleArn?: string;
35
+ roleName?: string;
34
36
  static names(): { [key: string]: string } {
35
37
  return {
36
38
  apiKey: 'ApiKey',
37
39
  instanceId: 'InstanceId',
38
40
  keyName: 'KeyName',
41
+ roleArn: 'RoleArn',
42
+ roleName: 'RoleName',
39
43
  };
40
44
  }
41
45
 
@@ -44,6 +48,8 @@ export class RenameApiKeyRequest extends $dara.Model {
44
48
  apiKey: 'string',
45
49
  instanceId: 'string',
46
50
  keyName: 'string',
51
+ roleArn: 'string',
52
+ roleName: 'string',
47
53
  };
48
54
  }
49
55
 
@@ -13,7 +13,7 @@ export class RenameApiKeyResponseBody extends $dara.Model {
13
13
  message?: string;
14
14
  /**
15
15
  * @remarks
16
- * The request ID.
16
+ * Id of the request
17
17
  *
18
18
  * @example
19
19
  * FE9C65D7-930F-57A5-A207-8C396329241C
@@ -21,7 +21,7 @@ export class RenameApiKeyResponseBody extends $dara.Model {
21
21
  requestId?: string;
22
22
  /**
23
23
  * @remarks
24
- * Indicates if the request succeeded.
24
+ * The request result.
25
25
  *
26
26
  * @example
27
27
  * true