@alicloud/polardb20170801 8.2.4 → 8.3.0

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 (52) hide show
  1. package/dist/client.d.ts +29 -14
  2. package/dist/client.js +65 -14
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/DescribeBackupPolicyRequest.d.ts +1 -1
  5. package/dist/models/DescribeBackupPolicyResponseBody.d.ts +85 -125
  6. package/dist/models/DescribeBackupPolicyResponseBody.js +4 -0
  7. package/dist/models/DescribeBackupPolicyResponseBody.js.map +1 -1
  8. package/dist/models/DescribeDetachedBackupsRequest.d.ts +15 -18
  9. package/dist/models/DescribeDetachedBackupsRequest.js.map +1 -1
  10. package/dist/models/DescribeDetachedBackupsResponseBody.d.ts +3 -3
  11. package/dist/models/DescribeKbsyncLinksRequest.d.ts +16 -0
  12. package/dist/models/DescribeKbsyncLinksRequest.js +4 -0
  13. package/dist/models/DescribeKbsyncLinksRequest.js.map +1 -1
  14. package/dist/models/DescribeKbsyncLinksResponseBody.d.ts +25 -1
  15. package/dist/models/DescribeKbsyncLinksResponseBody.js +6 -0
  16. package/dist/models/DescribeKbsyncLinksResponseBody.js.map +1 -1
  17. package/dist/models/ModifyBackupPolicyRequest.d.ts +117 -185
  18. package/dist/models/ModifyBackupPolicyRequest.js.map +1 -1
  19. package/dist/models/ModifyBackupPolicyResponseBody.d.ts +1 -1
  20. package/dist/models/ModifyBackupPolicyShrinkRequest.d.ts +83 -134
  21. package/dist/models/ModifyBackupPolicyShrinkRequest.js.map +1 -1
  22. package/dist/models/RegisterKnowledgeBaseFileRequest.d.ts +43 -0
  23. package/dist/models/RegisterKnowledgeBaseFileRequest.js +62 -0
  24. package/dist/models/RegisterKnowledgeBaseFileRequest.js.map +1 -0
  25. package/dist/models/RegisterKnowledgeBaseFileResponse.d.ts +19 -0
  26. package/dist/models/RegisterKnowledgeBaseFileResponse.js +69 -0
  27. package/dist/models/RegisterKnowledgeBaseFileResponse.js.map +1 -0
  28. package/dist/models/RegisterKnowledgeBaseFileResponseBody.d.ts +63 -0
  29. package/dist/models/RegisterKnowledgeBaseFileResponseBody.js +68 -0
  30. package/dist/models/RegisterKnowledgeBaseFileResponseBody.js.map +1 -0
  31. package/dist/models/RetrievalKnowledgeBaseResponseBody.d.ts +72 -5
  32. package/dist/models/RetrievalKnowledgeBaseResponseBody.js +43 -1
  33. package/dist/models/RetrievalKnowledgeBaseResponseBody.js.map +1 -1
  34. package/dist/models/model.d.ts +4 -0
  35. package/dist/models/model.js +41 -33
  36. package/dist/models/model.js.map +1 -1
  37. package/package.json +1 -1
  38. package/src/client.ts +72 -14
  39. package/src/models/DescribeBackupPolicyRequest.ts +1 -1
  40. package/src/models/DescribeBackupPolicyResponseBody.ts +89 -125
  41. package/src/models/DescribeDetachedBackupsRequest.ts +17 -20
  42. package/src/models/DescribeDetachedBackupsResponseBody.ts +3 -3
  43. package/src/models/DescribeKbsyncLinksRequest.ts +20 -0
  44. package/src/models/DescribeKbsyncLinksResponseBody.ts +31 -1
  45. package/src/models/ModifyBackupPolicyRequest.ts +120 -188
  46. package/src/models/ModifyBackupPolicyResponseBody.ts +1 -1
  47. package/src/models/ModifyBackupPolicyShrinkRequest.ts +86 -137
  48. package/src/models/RegisterKnowledgeBaseFileRequest.ts +60 -0
  49. package/src/models/RegisterKnowledgeBaseFileResponse.ts +40 -0
  50. package/src/models/RegisterKnowledgeBaseFileResponseBody.ts +86 -0
  51. package/src/models/RetrievalKnowledgeBaseResponseBody.ts +105 -5
  52. package/src/models/model.ts +4 -0
@@ -101,14 +101,10 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
101
101
  /**
102
102
  * @remarks
103
103
  * The advanced backup policy option. Valid values:
104
- *
105
- * - **enable**: Advanced backup is enabled.
106
- *
107
- * - **disable**: Advanced backup is disabled. You can enable it.
108
- *
109
- * - **notSupport**: Advanced backup is not supported.
110
- *
111
- * > * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
104
+ * * **enable**: Advanced backup is enabled.
105
+ * * **disable**: Advanced backup is not enabled but can be enabled.
106
+ * * **notSupport**: Advanced backup is not supported.
107
+ * > * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
112
108
  *
113
109
  * @example
114
110
  * disable
@@ -118,17 +114,13 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
118
114
  * @remarks
119
115
  * The backup frequency. Valid values:
120
116
  *
121
- * - **Normal** (Default): Standard backup. A backup is performed once a day.
122
- *
123
- * - **2/24H**: Enhanced backup. A backup is performed every 2 hours.
124
- *
125
- * - **3/24H**: Enhanced backup. A backup is performed every 3 hours.
117
+ * - **Normal** (default): regular backup. A backup is performed once a day at a scheduled time.
118
+ * - **2/24H**: enhanced backup. A backup is performed every 2 hours.
119
+ * - **3/24H**: enhanced backup. A backup is performed every 3 hours.
120
+ * - **4/24H**: enhanced backup. A backup is performed every 4 hours.
126
121
  *
127
- * - **4/24H**: Enhanced backup. A backup is performed every 4 hours.
128
- *
129
- * > * If you enable enhanced backup, all backups that are completed within 24 hours are retained. For backups that are completed more than 24 hours ago, the system retains only the first backup that is completed after 00:00 every day. Other backups are deleted.
130
- * >
131
- * > * If you enable enhanced backup, the **PreferredBackupPeriod** parameter is automatically set to all days of the week (Monday to Sunday).
122
+ * > * After enhanced backup is enabled, all backups completed within 24 hours are retained. For backups older than 24 hours, only the first backup completed after 00:00 each day is retained, and all others are deleted.
123
+ * >* After enhanced backup is enabled, the backup cycle parameter **PreferredBackupPeriod** is set to all days of the week by default (Monday through Sunday).
132
124
  *
133
125
  * @example
134
126
  * Normal
@@ -136,13 +128,10 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
136
128
  backupFrequency?: string;
137
129
  /**
138
130
  * @remarks
139
- * The level of the backup policy. Valid values:
140
- *
141
- * - **Normal**: standard backup
142
- *
143
- * - **Advanced**: advanced backup
144
- *
145
- * > * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
131
+ * The current backup policy level. Valid values:
132
+ * * **Normal**: regular backup
133
+ * * **Advanced**: advanced backup
134
+ * > * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
146
135
  *
147
136
  * @example
148
137
  * Normal
@@ -150,13 +139,11 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
150
139
  backupPolicyLevel?: string;
151
140
  /**
152
141
  * @remarks
153
- * The policy to retain backups when you delete a cluster:
154
- *
155
- * - **ALL**: Retains all backups permanently.
156
- *
157
- * - **LATEST**: Retains the last backup permanently.
142
+ * Specifies whether to retain backups when the cluster is deleted. Valid values:
158
143
  *
159
- * - **NONE** (Default): Does not retain backup sets.
144
+ * * **ALL**: All backups are retained with long-term retention (LTR).
145
+ * * **LATEST**: The last backup is retained with long-term retention (LTR).
146
+ * * **NONE** (default): No backups are retained.
160
147
  *
161
148
  * @example
162
149
  * NONE
@@ -166,19 +153,14 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
166
153
  * @remarks
167
154
  * The backup frequency. Valid values:
168
155
  *
169
- * - **Normal** (Default): Standard backup. A backup is performed once a day.
156
+ * - **Normal** (default): regular backup. A backup is performed once a day at a scheduled time.
157
+ * - **2/24H**: high-frequency backup. A backup is performed every 2 hours.
158
+ * - **3/24H**: high-frequency backup. A backup is performed every 3 hours.
159
+ * - **4/24H**: high-frequency backup. A backup is performed every 4 hours.
170
160
  *
171
- * - **2/24H**: High-frequency backup. A backup is performed every 2 hours.
172
- *
173
- * - **3/24H**: High-frequency backup. A backup is performed every 3 hours.
174
- *
175
- * - **4/24H**: High-frequency backup. A backup is performed every 4 hours.
176
- *
177
- * > * * This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
178
- * >
179
- * > * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
180
- * >
181
- * > * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
161
+ * > * * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
162
+ * >* * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
163
+ * >* * After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
182
164
  *
183
165
  * @example
184
166
  * Normal
@@ -186,29 +168,19 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
186
168
  dataLevel1BackupFrequency?: string;
187
169
  /**
188
170
  * @remarks
189
- * The cycle of a level-1 backup. Valid values:
190
- *
191
- * - **Monday**
192
- *
193
- * - **Tuesday**
194
- *
195
- * - **Wednesday**
196
- *
197
- * - **Thursday**
198
- *
199
- * - **Friday**
200
- *
201
- * - **Saturday**
202
- *
203
- * - **Sunday**
204
- *
205
- * > * * Select at least two days. Separate multiple values with commas (,).
206
- * >
207
- * > * - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
208
- * >
209
- * > * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
210
- * >
211
- * > * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
171
+ * The level-1 backup cycle. Valid values:
172
+ * * **Monday**
173
+ * * **Tuesday**
174
+ * * **Wednesday**
175
+ * * **Thursday**
176
+ * * **Friday**
177
+ * * **Saturday**
178
+ * * **Sunday**
179
+ *
180
+ * > * * At least two days must be selected. Separate multiple values with commas (,).
181
+ * >* * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
182
+ * >* * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
183
+ * >* * After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
212
184
  *
213
185
  * @example
214
186
  * Monday,Tuesday
@@ -217,8 +189,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
217
189
  /**
218
190
  * @remarks
219
191
  * The retention period of level-1 backups. Valid values: 3 to 14. Unit: days.
220
- *
221
- * > This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
192
+ * > After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
222
193
  *
223
194
  * @example
224
195
  * 7
@@ -226,11 +197,10 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
226
197
  dataLevel1BackupRetentionPeriod?: string;
227
198
  /**
228
199
  * @remarks
229
- * The time range when an automatic backup is performed. The time is in the `hh:mmZ-hh:mmZ` format and is displayed in UTC. The specified time range must be a 1-hour interval on the hour, such as `14:00Z-15:00Z`.
200
+ * The time period during which automatic backups are performed. The value is in the `hh:mmZ-hh:mmZ` format (UTC). The start and end times must be on the hour and exactly 1 hour apart. Example: `14:00Z-15:00Z`.
230
201
  *
231
- * > - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
232
- * >
233
- * > - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
202
+ * > * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
203
+ * >* If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
234
204
  *
235
205
  * @example
236
206
  * 15:00Z-16:00Z
@@ -238,9 +208,9 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
238
208
  dataLevel1BackupTime?: string;
239
209
  /**
240
210
  * @remarks
241
- * The destination region of the cross-region level-2 backup. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
211
+ * The cross-region backup region for level-2 backups. For the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
242
212
  *
243
- * > This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
213
+ * > After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
244
214
  *
245
215
  * @example
246
216
  * cn-hangzhou
@@ -248,17 +218,17 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
248
218
  dataLevel2BackupAnotherRegionRegion?: string;
249
219
  /**
250
220
  * @remarks
251
- * The retention period of cross-region level-2 backups. Valid values:
221
+ * The retention epoch of cross-region backups for level-2 backups. Valid values:
252
222
  *
253
- * - **0**: The level-2 backup feature is disabled.
223
+ * - **0**: The level-2 backup feature is shutdown.
254
224
  *
255
- * - **30 to 7300**: The retention period of level-2 backups in days.
225
+ * - **30 to 7300**: The retention epoch of level-2 backups. Unit: days.
256
226
  *
257
- * - **-1**: The level-2 backups are permanently retained.
227
+ * - **-1**: Level-2 backups are retained with long-term retention (LTR).
258
228
  *
259
- * > * * When you create a cluster, the default value is **0**. This means the cross-region backup feature for level-2 backups is disabled.
260
- * >
261
- * > * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
229
+ * >
230
+ * >- - When a cluster is created, the default value is **0**, which means the cross-region backup feature for level-2 backups is shutdown.
231
+ * >- - After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
262
232
  *
263
233
  * @example
264
234
  * 30
@@ -266,29 +236,19 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
266
236
  dataLevel2BackupAnotherRegionRetentionPeriod?: string;
267
237
  /**
268
238
  * @remarks
269
- * The cycle of a level-2 backup. Valid values:
270
- *
271
- * - **Monday**
272
- *
273
- * - **Tuesday**
274
- *
275
- * - **Wednesday**
276
- *
277
- * - **Thursday**
278
- *
279
- * - **Friday**
280
- *
281
- * - **Saturday**
282
- *
283
- * - **Sunday**
284
- *
285
- * > * * Select at least two days. Separate multiple values with commas (,).
286
- * >
287
- * > * - This parameter is not supported by PolarDB for PostgreSQL (compatible with Oracle) and PolarDB for PostgreSQL.
288
- * >
289
- * > * - This parameter is not supported if the cross-region backup feature is unavailable in the region where your PolarDB for MySQL cluster resides. For more information about the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
290
- * >
291
- * > * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
239
+ * The level-2 backup cycle. Valid values:
240
+ * * **Monday**
241
+ * * **Tuesday**
242
+ * * **Wednesday**
243
+ * * **Thursday**
244
+ * * **Friday**
245
+ * * **Saturday**
246
+ * * **Sunday**
247
+ *
248
+ * > * * At least two days must be selected. Separate multiple values with commas (,).
249
+ * >* * This parameter is not supported for PolarDB for PostgreSQL (Compatible with Oracle) or PolarDB for PostgreSQL.
250
+ * >* * If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For the regions that support cross-region backup, see [Overview](https://help.aliyun.com/document_detail/72672.html).
251
+ * >* * After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
292
252
  *
293
253
  * @example
294
254
  * Monday,Tuesday
@@ -296,17 +256,14 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
296
256
  dataLevel2BackupPeriod?: string;
297
257
  /**
298
258
  * @remarks
299
- * The retention period of level-2 backups. Valid values:
300
- *
301
- * - 0: The level-2 backup feature is disabled.
259
+ * The retention epoch of level-2 backups. Valid values:
260
+ * * 0: The level-2 backup feature is shutdown.
261
+ * * 30 to 7300: The retention epoch of level-2 backups. Unit: days.
262
+ * * -1: Level-2 backups are retained with long-term retention (LTR).
302
263
  *
303
- * - 30 to 7300: The retention period of level-2 backups in days.
304
- *
305
- * - -1: The level-2 backups are permanently retained.
306
- *
307
- * > * * When you create a cluster, the default value is **0**. This means the level-2 backup feature is disabled.
308
- * >
309
- * > * - This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
264
+ * >
265
+ * >- * When a cluster is created, the default value is **0**, which means the level-2 backup feature is shutdown.
266
+ * >- * After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
310
267
  *
311
268
  * @example
312
269
  * 0
@@ -314,23 +271,26 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
314
271
  dataLevel2BackupRetentionPeriod?: string;
315
272
  /**
316
273
  * @remarks
317
- * The backup cycle. Valid values:
274
+ * Indicates whether immutable cross-region backup is enabled.
275
+ */
276
+ enableCrossRegionImmutableBackup?: boolean;
277
+ /**
278
+ * @remarks
279
+ * Indicates whether immutable backup is enabled.
280
+ */
281
+ enableImmutableBackup?: boolean;
282
+ /**
283
+ * @remarks
284
+ * The data backup cycle. Valid values:
318
285
  *
319
286
  * - Monday
320
- *
321
287
  * - Tuesday
322
- *
323
288
  * - Wednesday
324
- *
325
289
  * - Thursday
326
- *
327
290
  * - Friday
328
- *
329
291
  * - Saturday
330
- *
331
292
  * - Sunday
332
- *
333
- * > This parameter is not recommended if the advanced backup feature is enabled. Use the AdvancedDataPolicies parameter instead.
293
+ * > After advanced backup is enabled, use the AdvancedDataPolicies parameter instead of this parameter.
334
294
  *
335
295
  * @example
336
296
  * Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
@@ -338,7 +298,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
338
298
  preferredBackupPeriod?: string;
339
299
  /**
340
300
  * @remarks
341
- * The time range when an automatic backup is performed. The time is in the `HH:mmZ-HH:mmZ` format. The time is displayed in UTC.
301
+ * The time period during which automatic backups are performed. The value is in the `HH:mmZ-HH:mmZ` format (UTC).
342
302
  *
343
303
  * @example
344
304
  * 07:00Z-08:00Z
@@ -346,7 +306,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
346
306
  preferredBackupTime?: string;
347
307
  /**
348
308
  * @remarks
349
- * The time of the next backup. The time is in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.
309
+ * The time of the next backup. The value is in the `YYYY-MM-DDThh:mmZ` format (UTC).
350
310
  *
351
311
  * @example
352
312
  * 2020-11-16T07:30Z
@@ -375,6 +335,8 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
375
335
  dataLevel2BackupAnotherRegionRetentionPeriod: 'DataLevel2BackupAnotherRegionRetentionPeriod',
376
336
  dataLevel2BackupPeriod: 'DataLevel2BackupPeriod',
377
337
  dataLevel2BackupRetentionPeriod: 'DataLevel2BackupRetentionPeriod',
338
+ enableCrossRegionImmutableBackup: 'EnableCrossRegionImmutableBackup',
339
+ enableImmutableBackup: 'EnableImmutableBackup',
378
340
  preferredBackupPeriod: 'PreferredBackupPeriod',
379
341
  preferredBackupTime: 'PreferredBackupTime',
380
342
  preferredNextBackupTime: 'PreferredNextBackupTime',
@@ -397,6 +359,8 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
397
359
  dataLevel2BackupAnotherRegionRetentionPeriod: 'string',
398
360
  dataLevel2BackupPeriod: 'string',
399
361
  dataLevel2BackupRetentionPeriod: 'string',
362
+ enableCrossRegionImmutableBackup: 'boolean',
363
+ enableImmutableBackup: 'boolean',
400
364
  preferredBackupPeriod: 'string',
401
365
  preferredBackupTime: 'string',
402
366
  preferredNextBackupTime: 'string',
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeDetachedBackupsRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The ID of the backup set.
8
+ * The backup ID.
9
9
  *
10
10
  * @example
11
11
  * 111111111
@@ -13,10 +13,9 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
13
13
  backupId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The backup mode. Valid values:
17
- *
18
- * * **Automated**
19
- * * **Manual**
16
+ * The backup mode. Valid values:
17
+ * * **Automated**: automatic backup.
18
+ * * **Manual**: manual backup.
20
19
  *
21
20
  * @example
22
21
  * Manual
@@ -24,9 +23,9 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
24
23
  backupMode?: string;
25
24
  /**
26
25
  * @remarks
27
- * The region where the cross-region data backup file of the instance is stored.
26
+ * The destination region for cross-region backups.
28
27
  *
29
- * > This parameter is valid only for PolarDB for MySQL clusters.
28
+ * > Only PolarDB for MySQL supports this parameter.
30
29
  *
31
30
  * @example
32
31
  * cn-hangzhou
@@ -34,10 +33,9 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
34
33
  backupRegion?: string;
35
34
  /**
36
35
  * @remarks
37
- * The status of the backup set. Valid values:
38
- *
39
- * * **Success**
40
- * * **Failed**
36
+ * The backup status. Valid values:
37
+ * * **Success**: The backup is complete.
38
+ * * **Failed**: The backup failed.
41
39
  *
42
40
  * @example
43
41
  * Success
@@ -45,7 +43,7 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
45
43
  backupStatus?: string;
46
44
  /**
47
45
  * @remarks
48
- * The ID of the cluster.
46
+ * The cluster ID.
49
47
  *
50
48
  * This parameter is required.
51
49
  *
@@ -55,7 +53,7 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
55
53
  DBClusterId?: string;
56
54
  /**
57
55
  * @remarks
58
- * The end of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format. The time must be in UTC. The end time must be later than the start time.
56
+ * The end of the time range to query. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).
59
57
  *
60
58
  * This parameter is required.
61
59
  *
@@ -67,7 +65,7 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
67
65
  ownerId?: number;
68
66
  /**
69
67
  * @remarks
70
- * The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.
68
+ * The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.
71
69
  *
72
70
  * @example
73
71
  * 1
@@ -75,11 +73,10 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
75
73
  pageNumber?: number;
76
74
  /**
77
75
  * @remarks
78
- * The number of entries per page. Valid values:
79
- *
80
- * * **30**
81
- * * **50**
82
- * * **100**
76
+ * The number of entries per page. Valid values:
77
+ * * **30**
78
+ * * **50**
79
+ * * **100**
83
80
  *
84
81
  * Default value: **30**.
85
82
  *
@@ -91,7 +88,7 @@ export class DescribeDetachedBackupsRequest extends $dara.Model {
91
88
  resourceOwnerId?: number;
92
89
  /**
93
90
  * @remarks
94
- * The beginning of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC.
91
+ * The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).
95
92
  *
96
93
  * This parameter is required.
97
94
  *
@@ -99,7 +99,7 @@ export class DescribeDetachedBackupsResponseBody extends $dara.Model {
99
99
  pageNumber?: string;
100
100
  /**
101
101
  * @remarks
102
- * The number of entries per page.
102
+ * The number of entries on the current page.
103
103
  *
104
104
  * @example
105
105
  * 15
@@ -107,7 +107,7 @@ export class DescribeDetachedBackupsResponseBody extends $dara.Model {
107
107
  pageRecordCount?: string;
108
108
  /**
109
109
  * @remarks
110
- * The ID of the request.
110
+ * The request ID.
111
111
  *
112
112
  * @example
113
113
  * 717B2382-BB14-4DCB-BBC2-32DBE0******
@@ -115,7 +115,7 @@ export class DescribeDetachedBackupsResponseBody extends $dara.Model {
115
115
  requestId?: string;
116
116
  /**
117
117
  * @remarks
118
- * The total number of returned entries.
118
+ * The total number of entries.
119
119
  *
120
120
  * @example
121
121
  * 50
@@ -21,6 +21,22 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
21
21
  * pkb-xxxxx
22
22
  */
23
23
  knowledgeBaseId?: string;
24
+ /**
25
+ * @remarks
26
+ * The page number of the query results. Default value: 1.
27
+ *
28
+ * @example
29
+ * 1
30
+ */
31
+ pageNumber?: number;
32
+ /**
33
+ * @remarks
34
+ * The number of synchronization links returned per page. Valid values: 10, 20, 30, 50, 100, 200, and 500. Default value: 30.
35
+ *
36
+ * @example
37
+ * 30
38
+ */
39
+ pageSize?: number;
24
40
  /**
25
41
  * @remarks
26
42
  * The region ID.
@@ -35,6 +51,8 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
35
51
  return {
36
52
  imPlatform: 'ImPlatform',
37
53
  knowledgeBaseId: 'KnowledgeBaseId',
54
+ pageNumber: 'PageNumber',
55
+ pageSize: 'PageSize',
38
56
  regionId: 'RegionId',
39
57
  };
40
58
  }
@@ -43,6 +61,8 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
43
61
  return {
44
62
  imPlatform: 'string',
45
63
  knowledgeBaseId: 'string',
64
+ pageNumber: 'number',
65
+ pageSize: 'number',
46
66
  regionId: 'string',
47
67
  };
48
68
  }
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DescribeKBSyncLinksResponseBodyItems extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The client identifier.
8
+ * The client ID.
9
9
  *
10
10
  * @example
11
11
  * cli_xxxxxxbe8
@@ -122,6 +122,22 @@ export class DescribeKBSyncLinksResponseBody extends $dara.Model {
122
122
  * The list of synchronization links.
123
123
  */
124
124
  items?: DescribeKBSyncLinksResponseBodyItems[];
125
+ /**
126
+ * @remarks
127
+ * The page number of the current results.
128
+ *
129
+ * @example
130
+ * 1
131
+ */
132
+ pageNumber?: number;
133
+ /**
134
+ * @remarks
135
+ * The number of records per page in the current results.
136
+ *
137
+ * @example
138
+ * 30
139
+ */
140
+ pageSize?: number;
125
141
  /**
126
142
  * @remarks
127
143
  * Id of the request
@@ -130,17 +146,31 @@ export class DescribeKBSyncLinksResponseBody extends $dara.Model {
130
146
  * EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
131
147
  */
132
148
  requestId?: string;
149
+ /**
150
+ * @remarks
151
+ * The total number of synchronization links that match the query conditions.
152
+ *
153
+ * @example
154
+ * 1
155
+ */
156
+ totalRecordCount?: number;
133
157
  static names(): { [key: string]: string } {
134
158
  return {
135
159
  items: 'Items',
160
+ pageNumber: 'PageNumber',
161
+ pageSize: 'PageSize',
136
162
  requestId: 'RequestId',
163
+ totalRecordCount: 'TotalRecordCount',
137
164
  };
138
165
  }
139
166
 
140
167
  static types(): { [key: string]: any } {
141
168
  return {
142
169
  items: { 'type': 'array', 'itemType': DescribeKBSyncLinksResponseBodyItems },
170
+ pageNumber: 'number',
171
+ pageSize: 'number',
143
172
  requestId: 'string',
173
+ totalRecordCount: 'number',
144
174
  };
145
175
  }
146
176