@alicloud/polardb20170801 8.2.0 → 8.2.1

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 (143) hide show
  1. package/dist/client.d.ts +48 -52
  2. package/dist/client.js +75 -52
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AnswerKnowledgeBaseRequest.d.ts +31 -1
  5. package/dist/models/AnswerKnowledgeBaseRequest.js.map +1 -1
  6. package/dist/models/AnswerKnowledgeBaseResponseBody.d.ts +9 -0
  7. package/dist/models/AnswerKnowledgeBaseResponseBody.js.map +1 -1
  8. package/dist/models/CreateKbsyncLinkRequest.d.ts +3 -0
  9. package/dist/models/CreateKbsyncLinkRequest.js +6 -0
  10. package/dist/models/CreateKbsyncLinkRequest.js.map +1 -1
  11. package/dist/models/CreateStoragePlanRequest.d.ts +18 -9
  12. package/dist/models/CreateStoragePlanRequest.js.map +1 -1
  13. package/dist/models/DeleteDbclusterEndpointRequest.d.ts +4 -1
  14. package/dist/models/DeleteDbclusterEndpointRequest.js.map +1 -1
  15. package/dist/models/DeleteKnowledgeBaseFileRequest.d.ts +6 -0
  16. package/dist/models/DeleteKnowledgeBaseFileRequest.js.map +1 -1
  17. package/dist/models/DeleteKnowledgeBaseFileResponseBody.d.ts +3 -0
  18. package/dist/models/DeleteKnowledgeBaseFileResponseBody.js.map +1 -1
  19. package/dist/models/DescribeDbclusterAccessWhitelistRequest.d.ts +3 -0
  20. package/dist/models/DescribeDbclusterAccessWhitelistRequest.js.map +1 -1
  21. package/dist/models/DescribeDbclusterSslrequest.d.ts +4 -1
  22. package/dist/models/DescribeDbclusterSslrequest.js.map +1 -1
  23. package/dist/models/DescribeDbclusterSslresponseBody.d.ts +1 -1
  24. package/dist/models/DescribeDbclusterVersionRequest.d.ts +4 -6
  25. package/dist/models/DescribeDbclusterVersionRequest.js.map +1 -1
  26. package/dist/models/DescribeDbclusterVersionResponseBody.d.ts +56 -80
  27. package/dist/models/DescribeDbclusterVersionResponseBody.js.map +1 -1
  28. package/dist/models/DescribeKnowledgeBaseAnswerRequest.d.ts +6 -0
  29. package/dist/models/DescribeKnowledgeBaseAnswerRequest.js.map +1 -1
  30. package/dist/models/DescribeKnowledgeBaseAnswerResponseBody.d.ts +70 -3
  31. package/dist/models/DescribeKnowledgeBaseAnswerResponseBody.js.map +1 -1
  32. package/dist/models/DescribeKnowledgeBaseFileShardsRequest.d.ts +12 -0
  33. package/dist/models/DescribeKnowledgeBaseFileShardsRequest.js.map +1 -1
  34. package/dist/models/DescribeKnowledgeBaseFileShardsResponseBody.d.ts +33 -0
  35. package/dist/models/DescribeKnowledgeBaseFileShardsResponseBody.js.map +1 -1
  36. package/dist/models/DescribeKnowledgeBaseFilesRequest.d.ts +23 -1
  37. package/dist/models/DescribeKnowledgeBaseFilesRequest.js.map +1 -1
  38. package/dist/models/DescribeKnowledgeBaseFilesResponseBody.d.ts +117 -2
  39. package/dist/models/DescribeKnowledgeBaseFilesResponseBody.js.map +1 -1
  40. package/dist/models/DescribeKnowledgeSpaceAttributeRequest.d.ts +4 -0
  41. package/dist/models/DescribeKnowledgeSpaceAttributeRequest.js.map +1 -1
  42. package/dist/models/DescribeKnowledgeSpaceAttributeResponseBody.d.ts +113 -0
  43. package/dist/models/DescribeKnowledgeSpaceAttributeResponseBody.js.map +1 -1
  44. package/dist/models/DisableDbclusterServerlessRequest.d.ts +12 -0
  45. package/dist/models/DisableDbclusterServerlessRequest.js.map +1 -1
  46. package/dist/models/EnableDbclusterServerlessRequest.d.ts +12 -0
  47. package/dist/models/EnableDbclusterServerlessRequest.js.map +1 -1
  48. package/dist/models/ModifyDbclusterAccessWhitelistRequest.d.ts +11 -8
  49. package/dist/models/ModifyDbclusterAccessWhitelistRequest.js.map +1 -1
  50. package/dist/models/ModifyDbclusterArchRequest.d.ts +16 -9
  51. package/dist/models/ModifyDbclusterArchRequest.js.map +1 -1
  52. package/dist/models/ModifyDbclusterParametersRequest.d.ts +23 -27
  53. package/dist/models/ModifyDbclusterParametersRequest.js.map +1 -1
  54. package/dist/models/ModifyDbclusterSslrequest.d.ts +18 -9
  55. package/dist/models/ModifyDbclusterSslrequest.js.map +1 -1
  56. package/dist/models/ModifyDbclusterStoragePerformanceRequest.d.ts +22 -35
  57. package/dist/models/ModifyDbclusterStoragePerformanceRequest.js.map +1 -1
  58. package/dist/models/ModifyDbclusterStoragePerformanceResponseBody.d.ts +1 -1
  59. package/dist/models/RetrievalKnowledgeBaseRequest.d.ts +16 -1
  60. package/dist/models/RetrievalKnowledgeBaseRequest.js.map +1 -1
  61. package/dist/models/RetrievalKnowledgeBaseResponseBody.d.ts +42 -3
  62. package/dist/models/RetrievalKnowledgeBaseResponseBody.js.map +1 -1
  63. package/dist/models/RetryKnowledgeBaseFilesRequest.d.ts +6 -0
  64. package/dist/models/RetryKnowledgeBaseFilesRequest.js.map +1 -1
  65. package/dist/models/RetryKnowledgeBaseFilesResponseBody.d.ts +31 -0
  66. package/dist/models/RetryKnowledgeBaseFilesResponseBody.js.map +1 -1
  67. package/dist/models/TempModifyDbnodeRequest.d.ts +20 -13
  68. package/dist/models/TempModifyDbnodeRequest.js.map +1 -1
  69. package/dist/models/TransformDbclusterPayTypeRequest.d.ts +19 -10
  70. package/dist/models/TransformDbclusterPayTypeRequest.js.map +1 -1
  71. package/dist/models/TransformDbclusterPayTypeResponseBody.d.ts +2 -3
  72. package/dist/models/TransformDbclusterPayTypeResponseBody.js.map +1 -1
  73. package/dist/models/TriggerKnowledgeBaseSyncRequest.d.ts +7 -0
  74. package/dist/models/TriggerKnowledgeBaseSyncRequest.js.map +1 -1
  75. package/dist/models/TriggerKnowledgeBaseSyncResponseBody.d.ts +3 -0
  76. package/dist/models/TriggerKnowledgeBaseSyncResponseBody.js.map +1 -1
  77. package/dist/models/UpdateKbsyncLinkRequest.d.ts +6 -0
  78. package/dist/models/UpdateKbsyncLinkRequest.js +12 -0
  79. package/dist/models/UpdateKbsyncLinkRequest.js.map +1 -1
  80. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyRequest.d.ts +57 -0
  81. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyRequest.js.map +1 -1
  82. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyResponseBody.d.ts +3 -0
  83. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyResponseBody.js.map +1 -1
  84. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyShrinkRequest.d.ts +13 -0
  85. package/dist/models/UpdateKnowledgeBaseFileShardingStrategyShrinkRequest.js.map +1 -1
  86. package/dist/models/UpdateKnowledgeBaseRequest.d.ts +19 -0
  87. package/dist/models/UpdateKnowledgeBaseRequest.js.map +1 -1
  88. package/dist/models/UpdateKnowledgeBaseResponseBody.d.ts +6 -0
  89. package/dist/models/UpdateKnowledgeBaseResponseBody.js.map +1 -1
  90. package/dist/models/UpdateKnowledgeSpaceRequest.d.ts +65 -0
  91. package/dist/models/UpdateKnowledgeSpaceRequest.js.map +1 -1
  92. package/dist/models/UpdateKnowledgeSpaceResponseBody.d.ts +9 -0
  93. package/dist/models/UpdateKnowledgeSpaceResponseBody.js.map +1 -1
  94. package/dist/models/UpdateKnowledgeSpaceShrinkRequest.d.ts +20 -0
  95. package/dist/models/UpdateKnowledgeSpaceShrinkRequest.js.map +1 -1
  96. package/package.json +1 -1
  97. package/src/client.ts +84 -52
  98. package/src/models/AnswerKnowledgeBaseRequest.ts +31 -1
  99. package/src/models/AnswerKnowledgeBaseResponseBody.ts +9 -0
  100. package/src/models/CreateKbsyncLinkRequest.ts +9 -0
  101. package/src/models/CreateStoragePlanRequest.ts +18 -9
  102. package/src/models/DeleteDbclusterEndpointRequest.ts +4 -1
  103. package/src/models/DeleteKnowledgeBaseFileRequest.ts +6 -0
  104. package/src/models/DeleteKnowledgeBaseFileResponseBody.ts +3 -0
  105. package/src/models/DescribeDbclusterAccessWhitelistRequest.ts +3 -0
  106. package/src/models/DescribeDbclusterSslrequest.ts +4 -1
  107. package/src/models/DescribeDbclusterSslresponseBody.ts +1 -1
  108. package/src/models/DescribeDbclusterVersionRequest.ts +4 -6
  109. package/src/models/DescribeDbclusterVersionResponseBody.ts +56 -80
  110. package/src/models/DescribeKnowledgeBaseAnswerRequest.ts +6 -0
  111. package/src/models/DescribeKnowledgeBaseAnswerResponseBody.ts +70 -3
  112. package/src/models/DescribeKnowledgeBaseFileShardsRequest.ts +12 -0
  113. package/src/models/DescribeKnowledgeBaseFileShardsResponseBody.ts +33 -0
  114. package/src/models/DescribeKnowledgeBaseFilesRequest.ts +23 -1
  115. package/src/models/DescribeKnowledgeBaseFilesResponseBody.ts +117 -2
  116. package/src/models/DescribeKnowledgeSpaceAttributeRequest.ts +4 -0
  117. package/src/models/DescribeKnowledgeSpaceAttributeResponseBody.ts +113 -0
  118. package/src/models/DisableDbclusterServerlessRequest.ts +12 -0
  119. package/src/models/EnableDbclusterServerlessRequest.ts +12 -0
  120. package/src/models/ModifyDbclusterAccessWhitelistRequest.ts +11 -8
  121. package/src/models/ModifyDbclusterArchRequest.ts +16 -9
  122. package/src/models/ModifyDbclusterParametersRequest.ts +24 -28
  123. package/src/models/ModifyDbclusterSslrequest.ts +18 -9
  124. package/src/models/ModifyDbclusterStoragePerformanceRequest.ts +22 -35
  125. package/src/models/ModifyDbclusterStoragePerformanceResponseBody.ts +1 -1
  126. package/src/models/RetrievalKnowledgeBaseRequest.ts +16 -1
  127. package/src/models/RetrievalKnowledgeBaseResponseBody.ts +42 -3
  128. package/src/models/RetryKnowledgeBaseFilesRequest.ts +6 -0
  129. package/src/models/RetryKnowledgeBaseFilesResponseBody.ts +31 -0
  130. package/src/models/TempModifyDbnodeRequest.ts +20 -13
  131. package/src/models/TransformDbclusterPayTypeRequest.ts +19 -10
  132. package/src/models/TransformDbclusterPayTypeResponseBody.ts +2 -3
  133. package/src/models/TriggerKnowledgeBaseSyncRequest.ts +7 -0
  134. package/src/models/TriggerKnowledgeBaseSyncResponseBody.ts +3 -0
  135. package/src/models/UpdateKbsyncLinkRequest.ts +18 -0
  136. package/src/models/UpdateKnowledgeBaseFileShardingStrategyRequest.ts +57 -0
  137. package/src/models/UpdateKnowledgeBaseFileShardingStrategyResponseBody.ts +3 -0
  138. package/src/models/UpdateKnowledgeBaseFileShardingStrategyShrinkRequest.ts +13 -0
  139. package/src/models/UpdateKnowledgeBaseRequest.ts +19 -0
  140. package/src/models/UpdateKnowledgeBaseResponseBody.ts +6 -0
  141. package/src/models/UpdateKnowledgeSpaceRequest.ts +65 -0
  142. package/src/models/UpdateKnowledgeSpaceResponseBody.ts +9 -0
  143. package/src/models/UpdateKnowledgeSpaceShrinkRequest.ts +20 -0
@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategyParameters extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The maximum number of tokens in a single chunk.
9
+ *
7
10
  * @example
8
11
  * 512
9
12
  */
10
13
  maxTokens?: number;
11
14
  /**
15
+ * @remarks
16
+ * Specifies whether to merge adjacent small chunks under the same heading.
17
+ *
12
18
  * @example
13
19
  * true
14
20
  */
@@ -37,8 +43,15 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDe
37
43
  }
38
44
 
39
45
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategy extends $dara.Model {
46
+ /**
47
+ * @remarks
48
+ * The parameter details.
49
+ */
40
50
  parameters?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategyParameters;
41
51
  /**
52
+ * @remarks
53
+ * The type of the default chunking strategy. Valid values: hybrid or hierarchical.
54
+ *
42
55
  * @example
43
56
  * hybrid
44
57
  */
@@ -71,6 +84,9 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDe
71
84
 
72
85
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesMatch extends $dara.Model {
73
86
  /**
87
+ * @remarks
88
+ * The content type. Currently, table is supported.
89
+ *
74
90
  * @example
75
91
  * table
76
92
  */
@@ -98,11 +114,17 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRu
98
114
 
99
115
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategyParameters extends $dara.Model {
100
116
  /**
117
+ * @remarks
118
+ * The Markdown table processing mode. Valid values: auto, on, or off.
119
+ *
101
120
  * @example
102
121
  * auto
103
122
  */
104
123
  markdownTables?: string;
105
124
  /**
125
+ * @remarks
126
+ * The maximum number of tokens in a single chunk for matched content.
127
+ *
106
128
  * @example
107
129
  * 512
108
130
  */
@@ -131,8 +153,15 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRu
131
153
  }
132
154
 
133
155
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategy extends $dara.Model {
156
+ /**
157
+ * @remarks
158
+ * The parameter details.
159
+ */
134
160
  parameters?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategyParameters;
135
161
  /**
162
+ * @remarks
163
+ * The chunking strategy type used when a rule is matched.
164
+ *
136
165
  * @example
137
166
  * hierarchical
138
167
  */
@@ -164,7 +193,15 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRu
164
193
  }
165
194
 
166
195
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRules extends $dara.Model {
196
+ /**
197
+ * @remarks
198
+ * The content type. Currently, table is supported.
199
+ */
167
200
  match?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesMatch;
201
+ /**
202
+ * @remarks
203
+ * The chunking strategy.
204
+ */
168
205
  strategy?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategy;
169
206
  static names(): { [key: string]: string } {
170
207
  return {
@@ -196,7 +233,15 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRu
196
233
  }
197
234
 
198
235
  export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig extends $dara.Model {
236
+ /**
237
+ * @remarks
238
+ * The default chunking strategy. This strategy is used when no rule is matched.
239
+ */
199
240
  defaultStrategy?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategy;
241
+ /**
242
+ * @remarks
243
+ * The list of override rules that are matched in order.
244
+ */
200
245
  rules?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRules[];
201
246
  static names(): { [key: string]: string } {
202
247
  return {
@@ -229,102 +274,170 @@ export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig e
229
274
 
230
275
  export class DescribeKnowledgeSpaceAttributeResponseBody extends $dara.Model {
231
276
  /**
277
+ * @remarks
278
+ * The access control list (ACL) mode of the knowledge space. Valid values:
279
+ * - DISABLED
280
+ * - ENFORCED
281
+ *
232
282
  * @example
233
283
  * ENFORCED
234
284
  */
235
285
  ACLMode?: string;
236
286
  /**
287
+ * @remarks
288
+ * The time when the knowledge space was created.
289
+ *
237
290
  * @example
238
291
  * 2026-06-25T09:53:44Z
239
292
  */
240
293
  creationTime?: string;
241
294
  /**
295
+ * @remarks
296
+ * The ID of the PolarDB instance.
297
+ *
242
298
  * @example
243
299
  * pc-*************
244
300
  */
245
301
  DBClusterId?: string;
246
302
  /**
303
+ * @remarks
304
+ * The name of the database.
305
+ *
247
306
  * @example
248
307
  * polar_rag_meta
249
308
  */
250
309
  DBName?: string;
251
310
  /**
311
+ * @remarks
312
+ * The type of the database engine. Valid values:
313
+ * * MySQL
314
+ * * PostgreSQL
315
+ *
252
316
  * @example
253
317
  * MySQL
254
318
  */
255
319
  DBType?: string;
256
320
  /**
321
+ * @remarks
322
+ * The description of the knowledge space.
323
+ *
257
324
  * @example
258
325
  * testDesc
259
326
  */
260
327
  description?: string;
261
328
  /**
329
+ * @remarks
330
+ * The vector dimensions.
331
+ *
262
332
  * @example
263
333
  * 1536
264
334
  */
265
335
  embeddingDimension?: number;
266
336
  /**
337
+ * @remarks
338
+ * The embedding model.
339
+ *
267
340
  * @example
268
341
  * text-embedding-v4
269
342
  */
270
343
  embeddingModel?: string;
271
344
  /**
345
+ * @remarks
346
+ * The total number of knowledge bases.
347
+ *
272
348
  * @example
273
349
  * 1
274
350
  */
275
351
  knowledgeBaseCount?: number;
276
352
  /**
353
+ * @remarks
354
+ * The unique identifier of the knowledge space.
355
+ *
277
356
  * @example
278
357
  * pks-xxxxxx
279
358
  */
280
359
  knowledgeSpaceId?: string;
281
360
  /**
361
+ * @remarks
362
+ * The large language model.
363
+ *
282
364
  * @example
283
365
  * qwen3.6-plus
284
366
  */
285
367
  LLMModel?: string;
286
368
  /**
369
+ * @remarks
370
+ * The name of the knowledge space.
371
+ *
287
372
  * @example
288
373
  * testName
289
374
  */
290
375
  name?: string;
291
376
  /**
377
+ * @remarks
378
+ * OSS Bucket
379
+ *
292
380
  * @example
293
381
  * test-bucket
294
382
  */
295
383
  OSSBucket?: string;
296
384
  /**
385
+ * @remarks
386
+ * Id of the request
387
+ *
297
388
  * @example
298
389
  * 6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
299
390
  */
300
391
  requestId?: string;
301
392
  /**
393
+ * @remarks
394
+ * The reranking model.
395
+ *
302
396
  * @example
303
397
  * qwen3-rerank
304
398
  */
305
399
  rerankModel?: string;
306
400
  /**
401
+ * @remarks
402
+ * The chunk size in tokens.
403
+ *
307
404
  * @example
308
405
  * 512
309
406
  */
310
407
  shardSize?: number;
408
+ /**
409
+ * @remarks
410
+ * The default chunking strategy configuration of the knowledge space. This parameter may be empty if existing instances do not have the complete configuration saved.
411
+ */
311
412
  shardingStrategyConfig?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig;
312
413
  /**
414
+ * @remarks
415
+ * The instance status.
416
+ *
313
417
  * @example
314
418
  * Activation
315
419
  */
316
420
  status?: string;
317
421
  /**
422
+ * @remarks
423
+ * The chunking strategy.
424
+ *
318
425
  * @example
319
426
  * hybrid
320
427
  */
321
428
  strategy?: string;
322
429
  /**
430
+ * @remarks
431
+ * The total number of documents.
432
+ *
323
433
  * @example
324
434
  * 1
325
435
  */
326
436
  totalDocs?: number;
327
437
  /**
438
+ * @remarks
439
+ * The total size in bytes.
440
+ *
328
441
  * @example
329
442
  * 318881
330
443
  */
@@ -14,6 +14,12 @@ export class DisableDBClusterServerlessRequest extends $dara.Model {
14
14
  */
15
15
  DBClusterId?: string;
16
16
  /**
17
+ * @remarks
18
+ * Specifies whether to immediately run the task or run it during a scheduled time window. Valid values:
19
+ *
20
+ * - false (default): The task is run during a scheduled time window.
21
+ * - true: The task is immediately run.
22
+ *
17
23
  * @example
18
24
  * false
19
25
  */
@@ -21,11 +27,17 @@ export class DisableDBClusterServerlessRequest extends $dara.Model {
21
27
  ownerAccount?: string;
22
28
  ownerId?: number;
23
29
  /**
30
+ * @remarks
31
+ * The latest time to start running the scheduled task. Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
32
+ *
24
33
  * @example
25
34
  * 2022-04-28T14:30:00Z
26
35
  */
27
36
  plannedEndTime?: string;
28
37
  /**
38
+ * @remarks
39
+ * The earliest time to start running the scheduled task (that is, the task is run within the specified time range). Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
40
+ *
29
41
  * @example
30
42
  * 2022-04-28T14:00:00Z
31
43
  */
@@ -14,6 +14,12 @@ export class EnableDBClusterServerlessRequest extends $dara.Model {
14
14
  */
15
15
  DBClusterId?: string;
16
16
  /**
17
+ * @remarks
18
+ * Specifies whether to immediately execute or schedule the parameter modification and restart. Valid values:
19
+ *
20
+ * - false (default): Schedule the execution.
21
+ * - true: Immediately execute.
22
+ *
17
23
  * @example
18
24
  * false
19
25
  */
@@ -21,11 +27,17 @@ export class EnableDBClusterServerlessRequest extends $dara.Model {
21
27
  ownerAccount?: string;
22
28
  ownerId?: number;
23
29
  /**
30
+ * @remarks
31
+ * The latest time to start executing the target scheduled task. Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
32
+ *
24
33
  * @example
25
34
  * 2022-04-28T14:30:00Z
26
35
  */
27
36
  plannedEndTime?: string;
28
37
  /**
38
+ * @remarks
39
+ * The earliest time to start executing the scheduled task (that is, the task is executed within the target time period). Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
40
+ *
29
41
  * @example
30
42
  * 2022-04-28T14:00:00Z
31
43
  */
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The attribute of the IP whitelist group. If this parameter is set to **hidden**, the group is not displayed in the console.
8
+ * The attribute of the IP whitelist group. If you set this parameter to **hidden**, the group is not displayed in the console.
9
9
  *
10
10
  * > - IP whitelist groups that are already displayed in the console cannot be hidden.
11
11
  * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
@@ -22,7 +22,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
22
22
  * - If the specified whitelist group name already exists, the whitelist group is modified.
23
23
  * - If this parameter is not specified, the default group is modified.
24
24
  *
25
- * > - A maximum of 50 IP whitelist groups are supported for a cluster.
25
+ * > - A cluster supports up to 50 IP whitelist groups.
26
26
  * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
27
27
  *
28
28
  * @example
@@ -42,9 +42,9 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
42
42
  /**
43
43
  * @remarks
44
44
  * The method used to modify the IP whitelist. Valid values:
45
- * - **Cover**: overwrites the original IP whitelist (default value).
46
- * - **Append**: appends IP addresses to the whitelist.
47
- * - **Delete**: removes IP addresses from the whitelist.
45
+ * - **Cover**: overwrites the original IP whitelist. This is the default value.
46
+ * - **Append**: appends IP addresses to the IP whitelist.
47
+ * - **Delete**: removes IP addresses from the IP whitelist.
48
48
  *
49
49
  * > This parameter takes effect only when **WhiteListType** is set to **IP**.
50
50
  *
@@ -55,6 +55,9 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
55
55
  ownerAccount?: string;
56
56
  ownerId?: number;
57
57
  /**
58
+ * @remarks
59
+ * The file system instance ID.
60
+ *
58
61
  * @example
59
62
  * pfs-xxx
60
63
  */
@@ -65,7 +68,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
65
68
  * @remarks
66
69
  * The security group IDs. Separate multiple security group IDs with commas (,).
67
70
  *
68
- * > - A maximum of 3 security groups are supported for a cluster.
71
+ * > - A cluster supports up to 3 security groups.
69
72
  * > - This parameter takes effect only when **WhiteListType** is set to **SecurityGroup**.
70
73
  *
71
74
  * @example
@@ -74,10 +77,10 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
74
77
  securityGroupIds?: string;
75
78
  /**
76
79
  * @remarks
77
- * The IP addresses or CIDR blocks in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:
80
+ * The IP addresses or CIDR blocks in the IP whitelist group. You can add up to 1,000 IP addresses or CIDR blocks across all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported:
78
81
  *
79
82
  * - IP address format, such as 10.23.12.24.
80
- * - CIDR format, such as 10.23.12.24/24, where 24 indicates the prefix length of the CIDR block. The prefix length ranges from 1 to 32.
83
+ * - CIDR format, such as 10.23.12.24/24, where 24 indicates the length of the prefix in the IP address. The prefix length ranges from 1 to 32.
81
84
  *
82
85
  * > This parameter takes effect only when **WhiteListType** is set to **IP**.
83
86
  *
@@ -3,6 +3,12 @@ import * as $dara from '@darabonba/typescript';
3
3
 
4
4
 
5
5
  export class ModifyDBClusterArchRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * Specifies whether to automatically use coupons. Valid values:
9
+ * * true (default): Uses coupons.
10
+ * * false: Does not use coupons.
11
+ */
6
12
  autoUseCoupon?: boolean;
7
13
  /**
8
14
  * @remarks
@@ -14,17 +20,19 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
14
20
  DBClusterId?: string;
15
21
  /**
16
22
  * @remarks
17
- * Specifies whether to enable a hot standby cluster. Valid values:
18
- *
19
- * - **on**: Enables a hot standby cluster.
23
+ * Specifies whether to enable the hot standby cluster. Valid values:
20
24
  *
21
- * - **equal**: Enables a peer cluster.
25
+ * - **on**: Enables the hot standby cluster.
26
+ * - **equal**: Enables the peer cluster.
22
27
  *
23
28
  * @example
24
29
  * on
25
30
  */
26
31
  hotStandbyCluster?: string;
27
32
  /**
33
+ * @remarks
34
+ * The coupon code. If this parameter is not specified, the default coupon is used.
35
+ *
28
36
  * @example
29
37
  * 727xxxxxx934
30
38
  */
@@ -33,7 +41,7 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
33
41
  * @remarks
34
42
  * The region ID.
35
43
  *
36
- * > For more information, see [DescribeRegions](https://help.aliyun.com/document_detail/98041.html).
44
+ * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query region information.
37
45
  *
38
46
  * @example
39
47
  * cn-beijing
@@ -41,11 +49,10 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
41
49
  regionId?: string;
42
50
  /**
43
51
  * @remarks
44
- * The zone for the hot standby storage cluster. Valid values:
45
- *
46
- * - **auto** (default): The system automatically selects a zone.
52
+ * The zone of the hot standby storage cluster. Valid values:
47
53
  *
48
- * > The default value is valid only when \\`HotStandbyCluster\\` is set to \\`on\\`. A specific zone is required when \\`HotStandbyCluster\\` is set to \\`equal\\`. For more information about zones, see [DescribeZones](https://help.aliyun.com/document_detail/98041.html).
54
+ * - **auto** (default): Automatically selected.
55
+ * > When the HotStandbyCluster parameter is set to on, you can use the default value. When the HotStandbyCluster parameter is set to equal, you must specify a specific zone. You can call the [DescribeZones](https://help.aliyun.com/document_detail/98041.html) operation to query zone details.
49
56
  *
50
57
  * @example
51
58
  * cn-beijing-i
@@ -3,12 +3,15 @@ import * as $dara from '@darabonba/typescript';
3
3
 
4
4
 
5
5
  export class ModifyDBClusterParametersRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * Specifies whether to clear binlogs. This parameter takes effect only when binlog is disabled.
9
+ */
6
10
  clearBinlog?: boolean;
7
11
  /**
8
12
  * @remarks
9
13
  * The cluster ID.
10
- *
11
- * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to view information about all clusters in the destination region, including cluster IDs.
14
+ * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query information about all clusters in the specified region, including cluster IDs.
12
15
  *
13
16
  * This parameter is required.
14
17
  *
@@ -18,11 +21,11 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
18
21
  DBClusterId?: string;
19
22
  /**
20
23
  * @remarks
21
- * Specifies whether to immediately modify the parameters and restart the cluster. Valid values:
24
+ * Specifies whether to immediately or schedule the parameter modification and cluster restart. Valid values:
22
25
  *
23
- * - false (default): The modification is scheduled.
24
- *
25
- * - true: The modification is performed immediately.
26
+ * - false (default): Scheduled execution.
27
+ *
28
+ * - true: Immediate execution.
26
29
  *
27
30
  * @example
28
31
  * false
@@ -32,13 +35,12 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
32
35
  ownerId?: number;
33
36
  /**
34
37
  * @remarks
35
- * The ID of the parameter template.
38
+ * The parameter template ID.
39
+ *
36
40
  *
37
- * > - Call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to view the ID of the parameter template.
38
- * >
39
- * > - You must specify this parameter or the `Parameters` parameter.
40
- * >
41
- * > - This parameter is supported only by PolarDB for MySQL.
41
+ * > * You can call the [DescribeParameterGroups](https://help.aliyun.com/document_detail/207178.html) operation to query the parameter template ID.
42
+ * > * You must specify either this parameter or the `Parameters` parameter.
43
+ * > * Only PolarDB for MySQL supports this parameter.
42
44
  *
43
45
  * @example
44
46
  * pcpg-**************
@@ -46,13 +48,11 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
46
48
  parameterGroupId?: string;
47
49
  /**
48
50
  * @remarks
49
- * A JSON string that consists of parameters and their values. The parameter values must be strings. For example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.
51
+ * A JSON string that consists of parameters and their values. Parameter values are of the STRING type. Example: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`.
50
52
  *
51
- * > - Call the [DescribeDBClusterParameters](https://help.aliyun.com/document_detail/98122.html) operation to view the parameters of a PolarDB cluster.
52
- * >
53
- * > - This parameter is required if the destination cluster is a PolarDB for PostgreSQL or PolarDB for PostgreSQL (Oracle compatible) cluster.
54
- * >
55
- * > - If the destination cluster is a PolarDB for MySQL cluster, you must specify this parameter or the `ParameterGroupId` parameter.
53
+ * > * You can call the [DescribeDBClusterParameters](https://help.aliyun.com/document_detail/98122.html) operation to query the parameters of a PolarDB cluster.
54
+ * > * If the cluster runs PolarDB for PostgreSQL or PolarDB for PostgreSQL (Compatible with Oracle), this parameter is required.
55
+ * > * If the cluster runs PolarDB for MySQL, you must specify either this parameter or the `ParameterGroupId` parameter.
56
56
  *
57
57
  * @example
58
58
  * {"wait_timeout":"86","innodb_old_blocks_time":"10"}
@@ -60,11 +60,9 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
60
60
  parameters?: string;
61
61
  /**
62
62
  * @remarks
63
- * The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
64
- *
65
- * > - The latest start time must be at least 30 minutes later than the earliest start time.
66
- * >
67
- * > - If you specify `PlannedStartTime` but not this parameter, the latest time to start the task is `PlannedStartTime + 30 minutes` by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.
63
+ * The latest time to start running the scheduled task. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
64
+ * > * The latest time must be at least 30 minutes later than the start time.
65
+ * > * If you specify `PlannedStartTime` but do not specify this parameter, the latest time defaults to `start time + 30 minutes`. For example, if `PlannedStartTime` is set to `2021-01-14T09:00:00Z` and this parameter is left empty, the task starts no later than `2021-01-14T09:30:00Z`.
68
66
  *
69
67
  * @example
70
68
  * 2022-04-28T14:30:00Z
@@ -72,11 +70,9 @@ export class ModifyDBClusterParametersRequest extends $dara.Model {
72
70
  plannedEndTime?: string;
73
71
  /**
74
72
  * @remarks
75
- * The earliest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.
76
- *
77
- * > - The start time can be any point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value in the range of `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
78
- * >
79
- * > - If you leave this parameter empty, the task is executed immediately.
73
+ * The earliest time to start running the scheduled task within the specified time range. The time is in the `YYYY-MM-DDThh:mm:ssZ` format (UTC).
74
+ * > * The start time must be within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, the start time can range from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`.
75
+ * > * If this parameter is left empty, the task is immediately executed.
80
76
  *
81
77
  * @example
82
78
  * 2022-04-28T14:00:00Z
@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class ModifyDBClusterSSLRequest extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The validity period of the SSL certificate. Unit: days. Valid values: 365 and 1095.
9
+ *
7
10
  * @example
8
11
  * 1095
9
12
  */
10
13
  certValidDays?: string;
11
14
  /**
15
+ * @remarks
16
+ * The connection string.
17
+ *
12
18
  * @example
13
19
  * xxx
14
20
  */
@@ -28,7 +34,7 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
28
34
  * The endpoint ID.
29
35
  *
30
36
  * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
31
- * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
37
+ * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
32
38
  * >* You can call the [DescribeDBClusterSSL](https://help.aliyun.com/document_detail/2319159.html) operation to query endpoint details.
33
39
  *
34
40
  * @example
@@ -37,13 +43,13 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
37
43
  DBEndpointId?: string;
38
44
  /**
39
45
  * @remarks
40
- * The network type of the endpoint. The value must be consistent with the network type of the endpoint specified by the **DBEndpointId** parameter. Valid values:
46
+ * The network type of the endpoint. The value must be the same as the network type of the endpoint specified by **DBEndpointId**. Valid values:
41
47
  * * **Public**: public network
42
48
  * * **Private**: private network
43
49
  * * **Inner**: private network (classic network)
44
50
  *
45
51
  * >* If the cluster is a PolarDB for MySQL cluster, this parameter is required.
46
- * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. Secure Sockets Layer (SSL) encryption is enabled for all endpoints by default.
52
+ * >* If the cluster is a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster, you do not need to specify this parameter. SSL encryption is enabled for all endpoints by default.
47
53
  *
48
54
  * @example
49
55
  * Public
@@ -52,6 +58,9 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
52
58
  ownerAccount?: string;
53
59
  ownerId?: number;
54
60
  /**
61
+ * @remarks
62
+ * The PFS instance ID.
63
+ *
55
64
  * @example
56
65
  * pfs-xxx
57
66
  */
@@ -62,9 +71,9 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
62
71
  * @remarks
63
72
  * Specifies whether to enable automatic SSL certificate rotation. Valid values:
64
73
  *
65
- * - **Enable**: Enables automatic rotation.
74
+ * - **Enable**: Enabled.
66
75
  *
67
- * - **Disable**: Disables automatic rotation.
76
+ * - **Disable**: Disabled.
68
77
  *
69
78
  * @example
70
79
  * Enable
@@ -72,12 +81,12 @@ export class ModifyDBClusterSSLRequest extends $dara.Model {
72
81
  SSLAutoRotate?: string;
73
82
  /**
74
83
  * @remarks
75
- * The SSL status. Valid values:
76
- * * **Disable**: Shutdown of Secure Sockets Layer (SSL) encryption.
77
- * * **Enable**: Enables Secure Sockets Layer (SSL) encryption.
84
+ * The SSL status to set. Valid values:
85
+ * * **Disable**: Shutdown SSL encryption.
86
+ * * **Enable**: Enables SSL encryption.
78
87
  * * **Update**: Updates the CA certificate.
79
88
  *
80
- * > After you enable Secure Sockets Layer (SSL) encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
89
+ * > After you enable SSL encryption or update the CA certificate, you must download and configure the certificate. For details, see [Settings for SSL encryption](https://help.aliyun.com/document_detail/153182.html).
81
90
  *
82
91
  * @example
83
92
  * Enable