@alicloud/polardb20170801 8.2.1 → 8.2.3

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 (49) hide show
  1. package/dist/client.d.ts +10 -10
  2. package/dist/client.js +22 -32
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateApplicationRequest.d.ts +119 -84
  5. package/dist/models/CreateApplicationRequest.js +31 -1
  6. package/dist/models/CreateApplicationRequest.js.map +1 -1
  7. package/dist/models/CreateApplicationResponseBody.d.ts +7 -7
  8. package/dist/models/CreateApplicationShrinkRequest.d.ts +65 -55
  9. package/dist/models/CreateApplicationShrinkRequest.js +6 -0
  10. package/dist/models/CreateApplicationShrinkRequest.js.map +1 -1
  11. package/dist/models/CreateKbsyncLinkRequest.d.ts +44 -0
  12. package/dist/models/CreateKbsyncLinkRequest.js.map +1 -1
  13. package/dist/models/CreateKbsyncLinkResponseBody.d.ts +36 -0
  14. package/dist/models/CreateKbsyncLinkResponseBody.js.map +1 -1
  15. package/dist/models/DeleteKbsyncLinkRequest.d.ts +6 -0
  16. package/dist/models/DeleteKbsyncLinkRequest.js.map +1 -1
  17. package/dist/models/DeleteKbsyncLinkResponseBody.d.ts +3 -0
  18. package/dist/models/DeleteKbsyncLinkResponseBody.js.map +1 -1
  19. package/dist/models/DescribeApplicationAttributeResponseBody.d.ts +95 -14
  20. package/dist/models/DescribeApplicationAttributeResponseBody.js +39 -1
  21. package/dist/models/DescribeApplicationAttributeResponseBody.js.map +1 -1
  22. package/dist/models/DescribeKbsyncLinksRequest.d.ts +7 -0
  23. package/dist/models/DescribeKbsyncLinksRequest.js.map +1 -1
  24. package/dist/models/DescribeKbsyncLinksResponseBody.d.ts +38 -0
  25. package/dist/models/DescribeKbsyncLinksResponseBody.js.map +1 -1
  26. package/dist/models/ModifyPolarFsMappingAuthRequest.d.ts +2 -2
  27. package/dist/models/UpdateKbsyncLinkRequest.d.ts +51 -0
  28. package/dist/models/UpdateKbsyncLinkRequest.js.map +1 -1
  29. package/dist/models/UpdateKbsyncLinkResponseBody.d.ts +10 -0
  30. package/dist/models/UpdateKbsyncLinkResponseBody.js.map +1 -1
  31. package/dist/models/model.d.ts +2 -0
  32. package/dist/models/model.js +58 -54
  33. package/dist/models/model.js.map +1 -1
  34. package/package.json +1 -1
  35. package/src/client.ts +26 -32
  36. package/src/models/CreateApplicationRequest.ts +140 -84
  37. package/src/models/CreateApplicationResponseBody.ts +7 -7
  38. package/src/models/CreateApplicationShrinkRequest.ts +71 -55
  39. package/src/models/CreateKbsyncLinkRequest.ts +44 -0
  40. package/src/models/CreateKbsyncLinkResponseBody.ts +36 -0
  41. package/src/models/DeleteKbsyncLinkRequest.ts +6 -0
  42. package/src/models/DeleteKbsyncLinkResponseBody.ts +3 -0
  43. package/src/models/DescribeApplicationAttributeResponseBody.ts +124 -14
  44. package/src/models/DescribeKbsyncLinksRequest.ts +7 -0
  45. package/src/models/DescribeKbsyncLinksResponseBody.ts +38 -0
  46. package/src/models/ModifyPolarFsMappingAuthRequest.ts +2 -2
  47. package/src/models/UpdateKbsyncLinkRequest.ts +51 -0
  48. package/src/models/UpdateKbsyncLinkResponseBody.ts +10 -0
  49. package/src/models/model.ts +2 -0
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateApplicationShrinkRequestTag extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The key of the tag.
8
+ * The tag key.
9
9
  *
10
10
  * @example
11
11
  * testKey
@@ -13,7 +13,7 @@ export class CreateApplicationShrinkRequestTag extends $dara.Model {
13
13
  key?: string;
14
14
  /**
15
15
  * @remarks
16
- * The value of the tag.
16
+ * The tag value.
17
17
  *
18
18
  * @example
19
19
  * testValue
@@ -45,7 +45,7 @@ export class CreateApplicationShrinkRequestTag extends $dara.Model {
45
45
  export class CreateApplicationShrinkRequest extends $dara.Model {
46
46
  /**
47
47
  * @remarks
48
- * The ID of an existing model operator instance to associate. This parameter is effective only when ApplicationType is set to polarclaw.
48
+ * The ID of an existing template operator instance to associate. This parameter takes effect only when ApplicationType is set to polarclaw.
49
49
  *
50
50
  * @example
51
51
  * pm-xxxxxx
@@ -53,13 +53,11 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
53
53
  AIDBClusterId?: string;
54
54
  /**
55
55
  * @remarks
56
- * The type of the application. Valid values:
56
+ * The application type. Valid values:
57
57
  *
58
- * - supabase: Creates a managed Supabase application.
59
- *
60
- * - raycluster: Creates a managed Ray Cluster application.
61
- *
62
- * - polarclaw: Creates a managed PolarClaw application.
58
+ * - supabase: Set this value to create a managed Supabase application.
59
+ * - raycluster: Set this value to create a managed Ray Cluster application.
60
+ * - polarclaw: Set this value to create a managed PolarClaw application.
63
61
  *
64
62
  * This parameter is required.
65
63
  *
@@ -69,7 +67,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
69
67
  applicationType?: string;
70
68
  /**
71
69
  * @remarks
72
- * The CPU architecture. Valid value:
70
+ * The CPU architecture. Valid values:
73
71
  *
74
72
  * - x86
75
73
  *
@@ -97,7 +95,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
97
95
  authProviderConfig?: string;
98
96
  /**
99
97
  * @remarks
100
- * Specifies whether to automatically create and bind an Elastic IP Address (EIP).
98
+ * Specifies whether to automatically create and associate with an elastic IP address (EIP).
101
99
  *
102
100
  * @example
103
101
  * qwen3-max
@@ -105,11 +103,9 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
105
103
  autoAllocatePublicEip?: boolean;
106
104
  /**
107
105
  * @remarks
108
- * Specifies whether to automatically create a PolarFS cold storage instance. Valid values:
109
- *
110
- * - false (default): Does not automatically create the instance.
111
- *
112
- * - true: Automatically creates the instance.
106
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
107
+ * * false (default): Automatic creation is disabled.
108
+ * * true: Automatic creation is enabled.
113
109
  *
114
110
  * @example
115
111
  * false
@@ -125,11 +121,9 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
125
121
  autoRenew?: boolean;
126
122
  /**
127
123
  * @remarks
128
- * Specifies whether to automatically use a coupon. Valid values:
129
- *
130
- * - true (default): Uses a coupon.
131
- *
132
- * - false: Does not use a coupon.
124
+ * Specifies whether to automatically use coupons. Valid values:
125
+ * * true (default): Use coupons.
126
+ * * false: Do not use coupons.
133
127
  *
134
128
  * @example
135
129
  * true
@@ -137,12 +131,12 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
137
131
  autoUseCoupon?: boolean;
138
132
  /**
139
133
  * @remarks
140
- * A list of custom child components for the application.
134
+ * The list of user-defined application subcomponents.
141
135
  */
142
136
  componentsShrink?: string;
143
137
  /**
144
138
  * @remarks
145
- * The ID of the PolarDB instance that the application depends on.
139
+ * The instance ID of the PolarDB instance on which the application depends.
146
140
  *
147
141
  * @example
148
142
  * pc-**************
@@ -158,7 +152,20 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
158
152
  description?: string;
159
153
  /**
160
154
  * @remarks
161
- * The default value is `false`. If you set this parameter to `true`, the system only checks the parameters and resources without creating the actual resources.
155
+ * The list of expected DNAT entries for NAT mapping. Specify this parameter together with VpcNatGatewayId. This parameter can be left empty, which indicates that no DNAT entries are created.
156
+ */
157
+ dnatEntriesShrink?: string;
158
+ /**
159
+ * @remarks
160
+ * The dedicated DNAT NAT IP address that is allocated by the customer (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in the available state. The vSwitch of the gateway must belong to the primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry is bound to the vSwitch where the application resides.
161
+ *
162
+ * @example
163
+ * 10.64.0.10
164
+ */
165
+ dnatIpAddress?: string;
166
+ /**
167
+ * @remarks
168
+ * Default value: `false`. If you set this parameter to `true`, only parameter and resource validation is performed without actually creating resources.
162
169
  *
163
170
  * @example
164
171
  * false
@@ -166,22 +173,22 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
166
173
  dryRun?: boolean;
167
174
  /**
168
175
  * @remarks
169
- * A list of custom server-side endpoints. By default, a VPC Endpoint is created.
176
+ * The list of user-defined service endpoints. By default, a VPC endpoint is created.
170
177
  */
171
178
  endpointsShrink?: string;
172
179
  /**
173
180
  * @remarks
174
- * This parameter is required for knowledge applications.
181
+ * Required for knowledge applications.
175
182
  */
176
183
  knowledgeApplicationSpecShrink?: string;
177
184
  /**
178
185
  * @remarks
179
- * This parameter is required for mem0 applications.
186
+ * Required for mem0 applications.
180
187
  */
181
188
  memApplicationSpecShrink?: string;
182
189
  /**
183
190
  * @remarks
184
- * The model API. This parameter is effective only when ApplicationType is set to polarclaw.
191
+ * The API of the model. This parameter takes effect only when ApplicationType is set to polarclaw.
185
192
  *
186
193
  * @example
187
194
  * openai-completions
@@ -189,7 +196,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
189
196
  modelApi?: string;
190
197
  /**
191
198
  * @remarks
192
- * The API key for the model. This parameter is effective only when ApplicationType is set to polarclaw.
199
+ * The API key of the model. This parameter takes effect only when ApplicationType is set to polarclaw.
193
200
  *
194
201
  * @example
195
202
  * sk-xxxxxx
@@ -197,7 +204,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
197
204
  modelApiKey?: string;
198
205
  /**
199
206
  * @remarks
200
- * The URL of the model. This parameter is effective only when ApplicationType is set to polarclaw.
207
+ * The URL of the model. This parameter takes effect only when ApplicationType is set to polarclaw.
201
208
  *
202
209
  * @example
203
210
  * https://dashscope.aliyuncs.com/compatible-mode/v1
@@ -205,13 +212,10 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
205
212
  modelBaseUrl?: string;
206
213
  /**
207
214
  * @remarks
208
- * The source of the model. Valid values:
209
- *
210
- * - bailian: Alibaba Cloud Model Studio model.
211
- *
212
- * - custom: A custom model.
213
- *
214
- * - maas: PolarDB model operator.
215
+ * The model source. Valid values:
216
+ * * bailian: Bailian model.
217
+ * * custom: Custom model.
218
+ * * maas: PolarDB model operator.
215
219
  *
216
220
  * @example
217
221
  * bailian
@@ -219,7 +223,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
219
223
  modelFrom?: string;
220
224
  /**
221
225
  * @remarks
222
- * The name of the model. This parameter is effective only when ApplicationType is set to polarclaw.
226
+ * The name of the model. This parameter takes effect only when ApplicationType is set to polarclaw.
223
227
  *
224
228
  * @example
225
229
  * qwen3-max
@@ -227,12 +231,12 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
227
231
  modelName?: string;
228
232
  /**
229
233
  * @remarks
230
- * A list of parameters.
234
+ * The list of parameters.
231
235
  */
232
236
  parametersShrink?: string;
233
237
  /**
234
238
  * @remarks
235
- * The billing method.
239
+ * The billing type.
236
240
  *
237
241
  * @example
238
242
  * Postpaid
@@ -240,7 +244,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
240
244
  payType?: string;
241
245
  /**
242
246
  * @remarks
243
- * The subscription period type.
247
+ * The subscription type, such as yearly or monthly.
244
248
  *
245
249
  * @example
246
250
  * Year
@@ -248,12 +252,10 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
248
252
  period?: string;
249
253
  /**
250
254
  * @remarks
251
- * The ID of the PolarFileSystem (PolarFS) cold storage or high-performance instance. This parameter is empty by default. If you specify this parameter, the corresponding storage is mounted to the application.
252
- *
253
- * This feature is currently supported only by the following applications:
255
+ * The instance ID of the Polarlakebase cold storage or high-performance instance. Default value: empty. If specified, the corresponding storage is mounted to the application.
254
256
  *
257
+ * Currently, only the following applications support this parameter:
255
258
  * - supabase
256
- *
257
259
  * - raycluster
258
260
  *
259
261
  * @example
@@ -270,7 +272,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
270
272
  promotionCode?: string;
271
273
  /**
272
274
  * @remarks
273
- * The region. The default value is the region of the instance.
275
+ * The region. Default value: the region of the instance.
274
276
  *
275
277
  * @example
276
278
  * cn-beijing
@@ -278,7 +280,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
278
280
  regionId?: string;
279
281
  /**
280
282
  * @remarks
281
- * The ID of the resource group.
283
+ * The resource group ID.
282
284
  *
283
285
  * @example
284
286
  * rg-********************
@@ -286,7 +288,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
286
288
  resourceGroupId?: string;
287
289
  /**
288
290
  * @remarks
289
- * The ID of the security group.
291
+ * The security group ID.
290
292
  *
291
293
  * @example
292
294
  * sg-********************
@@ -294,7 +296,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
294
296
  securityGroupId?: string;
295
297
  /**
296
298
  * @remarks
297
- * The name of the IP address whitelist group. The default value is `default`.
299
+ * The name of the IP whitelist group. Default value: `default`.
298
300
  *
299
301
  * @example
300
302
  * default
@@ -302,7 +304,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
302
304
  securityIPArrayName?: string;
303
305
  /**
304
306
  * @remarks
305
- * The IP address whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
307
+ * The IP whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
306
308
  *
307
309
  * @example
308
310
  * 127.0.0.1,172.17.0.0/24
@@ -318,7 +320,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
318
320
  securityIPType?: string;
319
321
  /**
320
322
  * @remarks
321
- * The ID of the skill template.
323
+ * The skill template ID.
322
324
  *
323
325
  * @example
324
326
  * xxx
@@ -326,7 +328,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
326
328
  skillTemplateId?: string;
327
329
  /**
328
330
  * @remarks
329
- * The tag.
331
+ * The tags.
330
332
  */
331
333
  tag?: CreateApplicationShrinkRequestTag[];
332
334
  /**
@@ -347,7 +349,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
347
349
  usedTime?: string;
348
350
  /**
349
351
  * @remarks
350
- * The vSwitch. The default value is the current vSwitch in the primary zone of the instance.
352
+ * The vSwitch. Default value: the current vSwitch in the primary zone of the instance.
351
353
  *
352
354
  * @example
353
355
  * vsw-*********************
@@ -355,7 +357,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
355
357
  vSwitchId?: string;
356
358
  /**
357
359
  * @remarks
358
- * The ID of the Virtual Private Cloud (VPC).
360
+ * The VPC ID.
359
361
  *
360
362
  * @example
361
363
  * vpc-********************
@@ -363,7 +365,15 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
363
365
  vpcId?: string;
364
366
  /**
365
367
  * @remarks
366
- * The zone. The default value is the primary zone of the instance.
368
+ * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in the active state.
369
+ *
370
+ * @example
371
+ * ngw-xxx
372
+ */
373
+ vpcNatGatewayId?: string;
374
+ /**
375
+ * @remarks
376
+ * The zone. Default value: the primary zone of the instance.
367
377
  *
368
378
  * @example
369
379
  * cn-beijing-k
@@ -383,6 +393,8 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
383
393
  componentsShrink: 'Components',
384
394
  DBClusterId: 'DBClusterId',
385
395
  description: 'Description',
396
+ dnatEntriesShrink: 'DnatEntries',
397
+ dnatIpAddress: 'DnatIpAddress',
386
398
  dryRun: 'DryRun',
387
399
  endpointsShrink: 'Endpoints',
388
400
  knowledgeApplicationSpecShrink: 'KnowledgeApplicationSpec',
@@ -409,6 +421,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
409
421
  usedTime: 'UsedTime',
410
422
  vSwitchId: 'VSwitchId',
411
423
  vpcId: 'VpcId',
424
+ vpcNatGatewayId: 'VpcNatGatewayId',
412
425
  zoneId: 'ZoneId',
413
426
  };
414
427
  }
@@ -427,6 +440,8 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
427
440
  componentsShrink: 'string',
428
441
  DBClusterId: 'string',
429
442
  description: 'string',
443
+ dnatEntriesShrink: 'string',
444
+ dnatIpAddress: 'string',
430
445
  dryRun: 'boolean',
431
446
  endpointsShrink: 'string',
432
447
  knowledgeApplicationSpecShrink: 'string',
@@ -453,6 +468,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
453
468
  usedTime: 'string',
454
469
  vSwitchId: 'string',
455
470
  vpcId: 'string',
471
+ vpcNatGatewayId: 'string',
456
472
  zoneId: 'string',
457
473
  };
458
474
  }
@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class CreateKBSyncLinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
+ * The client ID.
9
+ *
8
10
  * This parameter is required.
9
11
  *
10
12
  * @example
@@ -13,6 +15,8 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
13
15
  clientId?: string;
14
16
  /**
15
17
  * @remarks
18
+ * The client secret.
19
+ *
16
20
  * This parameter is required.
17
21
  *
18
22
  * @example
@@ -20,12 +24,17 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
20
24
  */
21
25
  clientSecret?: string;
22
26
  /**
27
+ * @remarks
28
+ * The description of the synchronization link.
29
+ *
23
30
  * @example
24
31
  * testDesc
25
32
  */
26
33
  description?: string;
27
34
  /**
28
35
  * @remarks
36
+ * The unique identifier of the knowledge base.
37
+ *
29
38
  * This parameter is required.
30
39
  *
31
40
  * @example
@@ -34,24 +43,44 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
34
43
  knowledgeBaseId?: string;
35
44
  /**
36
45
  * @remarks
46
+ * The name of the synchronization link.
47
+ *
37
48
  * This parameter is required.
38
49
  *
39
50
  * @example
40
51
  * testName
41
52
  */
42
53
  linkName?: string;
54
+ /**
55
+ * @remarks
56
+ * The DingTalk document MCP Server endpoint.
57
+ *
58
+ * @example
59
+ * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx789?key=d5e6fxxxxxx876
60
+ */
43
61
  mcpEndpoint?: string;
44
62
  /**
45
63
  * @remarks
64
+ * The region ID.
65
+ *
46
66
  * This parameter is required.
47
67
  *
48
68
  * @example
49
69
  * cn-beijing
50
70
  */
51
71
  regionId?: string;
72
+ /**
73
+ * @remarks
74
+ * The DingTalk spreadsheet MCP Server endpoint.
75
+ *
76
+ * @example
77
+ * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx567?key=d5e6fxxxxxx543
78
+ */
52
79
  sheetMcpEndpoint?: string;
53
80
  /**
54
81
  * @remarks
82
+ * The source directory address for synchronization.
83
+ *
55
84
  * This parameter is required.
56
85
  *
57
86
  * @example
@@ -60,6 +89,8 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
60
89
  sourceDir?: string;
61
90
  /**
62
91
  * @remarks
92
+ * The data source type. Valid values: FEISHU and SHAREPOINT.
93
+ *
63
94
  * This parameter is required.
64
95
  *
65
96
  * @example
@@ -67,15 +98,28 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
67
98
  */
68
99
  sourceType?: string;
69
100
  /**
101
+ * @remarks
102
+ * The synchronization interval. Unit: minutes.
103
+ *
70
104
  * @example
71
105
  * 30
72
106
  */
73
107
  syncIntervalMinutes?: number;
74
108
  /**
109
+ * @remarks
110
+ * The tenant ID. This parameter is required when SourceType is set to SHAREPOINT.
111
+ *
75
112
  * @example
76
113
  * 63eexxxx-xxxx-xxxx-xxxx-xxxxxx090f82
77
114
  */
78
115
  tenantId?: string;
116
+ /**
117
+ * @remarks
118
+ * The DingTalk operator user ID.
119
+ *
120
+ * @example
121
+ * 123***56
122
+ */
79
123
  userId?: string;
80
124
  static names(): { [key: string]: string } {
81
125
  return {
@@ -4,51 +4,87 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class CreateKBSyncLinkResponseBody extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The client ID.
9
+ *
7
10
  * @example
8
11
  * cli_xxxxxxbe8
9
12
  */
10
13
  clientId?: string;
11
14
  /**
15
+ * @remarks
16
+ * The creation time.
17
+ *
12
18
  * @example
13
19
  * 2026-08-14T05:58:42Z
14
20
  */
15
21
  creationTime?: string;
16
22
  /**
23
+ * @remarks
24
+ * The description of the synchronization link.
25
+ *
17
26
  * @example
18
27
  * testDesc
19
28
  */
20
29
  description?: string;
21
30
  /**
31
+ * @remarks
32
+ * The source channel of the synchronization link. Valid values:
33
+ * - FEISHU
34
+ * - SHAREPOINT
35
+ *
22
36
  * @example
23
37
  * FEISHU
24
38
  */
25
39
  imPlatform?: string;
26
40
  /**
41
+ * @remarks
42
+ * The synchronization link ID.
43
+ *
27
44
  * @example
28
45
  * pkbl-xxxxxx
29
46
  */
30
47
  linkId?: string;
31
48
  /**
49
+ * @remarks
50
+ * The name of the synchronization link.
51
+ *
32
52
  * @example
33
53
  * testName
34
54
  */
35
55
  linkName?: string;
36
56
  /**
57
+ * @remarks
58
+ * Id of the request
59
+ *
37
60
  * @example
38
61
  * 24A1990B-4F6E-482B-B8CB-75C612******
39
62
  */
40
63
  requestId?: string;
41
64
  /**
65
+ * @remarks
66
+ * The source directory address for synchronization.
67
+ *
42
68
  * @example
43
69
  * https://example.feishu.cn/wiki/space/xxxxxx
44
70
  */
45
71
  sourceDir?: string;
46
72
  /**
73
+ * @remarks
74
+ * The synchronization interval. Unit: minutes.
75
+ *
47
76
  * @example
48
77
  * 30
49
78
  */
50
79
  syncIntervalMinutes?: number;
51
80
  /**
81
+ * @remarks
82
+ * The synchronization status. Valid values:
83
+ * - CREATING
84
+ * - RUNNING
85
+ * - PAUSED
86
+ * - DELETING
87
+ *
52
88
  * @example
53
89
  * CREATING
54
90
  */
@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class DeleteKBSyncLinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
+ * The unique ID of the knowledge base.
9
+ *
8
10
  * This parameter is required.
9
11
  *
10
12
  * @example
@@ -13,6 +15,8 @@ export class DeleteKBSyncLinkRequest extends $dara.Model {
13
15
  knowledgeBaseId?: string;
14
16
  /**
15
17
  * @remarks
18
+ * The synchronization link ID.
19
+ *
16
20
  * This parameter is required.
17
21
  *
18
22
  * @example
@@ -21,6 +25,8 @@ export class DeleteKBSyncLinkRequest extends $dara.Model {
21
25
  linkId?: string;
22
26
  /**
23
27
  * @remarks
28
+ * The region ID.
29
+ *
24
30
  * This parameter is required.
25
31
  *
26
32
  * @example
@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class DeleteKBSyncLinkResponseBody extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * Id of the request
9
+ *
7
10
  * @example
8
11
  * 69A85BAF-1089-4CDF-A82F-0A140F******
9
12
  */