@alicloud/polardb20170801 8.4.1 → 8.4.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 (30) hide show
  1. package/dist/client.d.ts +4 -4
  2. package/dist/client.js +10 -4
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateApplicationRequest.d.ts +30 -22
  5. package/dist/models/CreateApplicationRequest.js +2 -0
  6. package/dist/models/CreateApplicationRequest.js.map +1 -1
  7. package/dist/models/CreateApplicationResponseBody.d.ts +1 -1
  8. package/dist/models/CreateApplicationShrinkRequest.d.ts +14 -6
  9. package/dist/models/CreateApplicationShrinkRequest.js +2 -0
  10. package/dist/models/CreateApplicationShrinkRequest.js.map +1 -1
  11. package/dist/models/CreateKbsyncLinkRequest.d.ts +3 -3
  12. package/dist/models/CreateKbsyncLinkResponseBody.d.ts +3 -1
  13. package/dist/models/CreateKbsyncLinkResponseBody.js.map +1 -1
  14. package/dist/models/CreateNetworkChannelRequest.d.ts +5 -0
  15. package/dist/models/CreateNetworkChannelRequest.js +2 -0
  16. package/dist/models/CreateNetworkChannelRequest.js.map +1 -1
  17. package/dist/models/DescribeNetworkChannelResponseBody.d.ts +5 -0
  18. package/dist/models/DescribeNetworkChannelResponseBody.js +2 -0
  19. package/dist/models/DescribeNetworkChannelResponseBody.js.map +1 -1
  20. package/dist/models/ModifyDbclusterEndpointRequest.d.ts +21 -21
  21. package/package.json +1 -1
  22. package/src/client.ts +12 -4
  23. package/src/models/CreateApplicationRequest.ts +32 -22
  24. package/src/models/CreateApplicationResponseBody.ts +1 -1
  25. package/src/models/CreateApplicationShrinkRequest.ts +16 -6
  26. package/src/models/CreateKbsyncLinkRequest.ts +3 -3
  27. package/src/models/CreateKbsyncLinkResponseBody.ts +3 -1
  28. package/src/models/CreateNetworkChannelRequest.ts +7 -0
  29. package/src/models/DescribeNetworkChannelResponseBody.ts +7 -0
  30. package/src/models/ModifyDbclusterEndpointRequest.ts +21 -21
package/src/client.ts CHANGED
@@ -2933,7 +2933,7 @@ export default class Client extends OpenApi {
2933
2933
  }
2934
2934
 
2935
2935
  /**
2936
- * Creates an application associated with a PolarDB instance.
2936
+ * Creates an application that is associated with a PolarDB instance.
2937
2937
  *
2938
2938
  * @param tmpReq - CreateApplicationRequest
2939
2939
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2984,6 +2984,10 @@ export default class Client extends OpenApi {
2984
2984
  query["AgenticDBBranchSpec"] = request.agenticDBBranchSpecShrink;
2985
2985
  }
2986
2986
 
2987
+ if (!$dara.isNull(request.agenticDBClusterId)) {
2988
+ query["AgenticDBClusterId"] = request.agenticDBClusterId;
2989
+ }
2990
+
2987
2991
  if (!$dara.isNull(request.applicationType)) {
2988
2992
  query["ApplicationType"] = request.applicationType;
2989
2993
  }
@@ -3170,7 +3174,7 @@ export default class Client extends OpenApi {
3170
3174
  }
3171
3175
 
3172
3176
  /**
3173
- * Creates an application associated with a PolarDB instance.
3177
+ * Creates an application that is associated with a PolarDB instance.
3174
3178
  *
3175
3179
  * @param request - CreateApplicationRequest
3176
3180
  * @returns CreateApplicationResponse
@@ -6034,6 +6038,10 @@ export default class Client extends OpenApi {
6034
6038
  query["ResourceOwnerId"] = request.resourceOwnerId;
6035
6039
  }
6036
6040
 
6041
+ if (!$dara.isNull(request.securityGroupId)) {
6042
+ query["SecurityGroupId"] = request.securityGroupId;
6043
+ }
6044
+
6037
6045
  if (!$dara.isNull(request.targetDBClusterId)) {
6038
6046
  query["TargetDBClusterId"] = request.targetDBClusterId;
6039
6047
  }
@@ -25867,7 +25875,7 @@ export default class Client extends OpenApi {
25867
25875
  }
25868
25876
 
25869
25877
  /**
25870
- * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25878
+ * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25871
25879
  *
25872
25880
  * @param request - ModifyDBClusterEndpointRequest
25873
25881
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25950,7 +25958,7 @@ export default class Client extends OpenApi {
25950
25958
  }
25951
25959
 
25952
25960
  /**
25953
- * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25961
+ * Modifies the cluster endpoint attributes of a PolarDB cluster, including the read/write mode, whether new nodes are automatically added to the endpoint, consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
25954
25962
  *
25955
25963
  * @param request - ModifyDBClusterEndpointRequest
25956
25964
  * @returns ModifyDBClusterEndpointResponse
@@ -93,7 +93,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
93
93
  componentClass?: string;
94
94
  /**
95
95
  * @remarks
96
- * The maximum number of replicas for the application subcomponent with the same specification. Default value: the value of ComponentReplica.
96
+ * The maximum number of application subcomponents with the same specification. Default value: the value of ComponentReplica.
97
97
  *
98
98
  * - Only raycluster supports this parameter.
99
99
  *
@@ -130,7 +130,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
130
130
  componentType?: string;
131
131
  /**
132
132
  * @remarks
133
- * The maximum number of replicas for component scaling.
133
+ * The upper limit for component scaling.
134
134
  *
135
135
  * @example
136
136
  * 16
@@ -138,7 +138,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
138
138
  scaleMax?: string;
139
139
  /**
140
140
  * @remarks
141
- * The minimum number of replicas for component scaling.
141
+ * The lower limit for component scaling.
142
142
  *
143
143
  * @example
144
144
  * 1
@@ -146,7 +146,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
146
146
  scaleMin?: string;
147
147
  /**
148
148
  * @remarks
149
- * The list of security groups for the application subcomponent, separated by commas (,).
149
+ * The list of security groups for the application subcomponent. Separate multiple security groups with commas (,).
150
150
  *
151
151
  * @example
152
152
  * sg-********************
@@ -154,7 +154,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
154
154
  securityGroups?: string;
155
155
  /**
156
156
  * @remarks
157
- * The name of the whitelist IP address group for the application subcomponent. Default value: default.
157
+ * The name of the IP whitelist group for the application subcomponent. Default value: default.
158
158
  *
159
159
  * @example
160
160
  * default
@@ -162,7 +162,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
162
162
  securityIPArrayName?: string;
163
163
  /**
164
164
  * @remarks
165
- * The whitelist IP addresses of the application subcomponent, separated by commas (,).
165
+ * The whitelisted IP addresses for the application subcomponent. Separate multiple IP addresses with commas (,).
166
166
  *
167
167
  * @example
168
168
  * 127.0.0.1
@@ -170,7 +170,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
170
170
  securityIPList?: string;
171
171
  /**
172
172
  * @remarks
173
- * The type of the whitelist IP addresses for the application subcomponent. Default value: ipv4.
173
+ * The type of the whitelisted IP addresses for the application subcomponent. Default value: ipv4.
174
174
  *
175
175
  * @example
176
176
  * ipv4
@@ -218,7 +218,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
218
218
  export class CreateApplicationRequestDnatEntries extends $dara.Model {
219
219
  /**
220
220
  * @remarks
221
- * The frontend port. This parameter is optional. If not specified, the system automatically assigns a port that does not conflict with ports already in use on the gateway. You can query the assignment result by calling the DescribeApplicationAttribute operation.
221
+ * The frontend port. This parameter is optional. If not specified, the control plane automatically assigns a port that does not conflict with ports already in use on the gateway. You can query the assignment result by calling the DescribeApplicationAttribute operation.
222
222
  *
223
223
  * @example
224
224
  * 10001
@@ -226,7 +226,7 @@ export class CreateApplicationRequestDnatEntries extends $dara.Model {
226
226
  frontPort?: number;
227
227
  /**
228
228
  * @remarks
229
- * The port name. Valid values: webui, hermesagent, dashboard, and ssh.
229
+ * The port name. Valid values: webui | hermesagent | dashboard | ssh.
230
230
  *
231
231
  * @example
232
232
  * webui
@@ -308,7 +308,7 @@ export class CreateApplicationRequestKnowledgeApplicationSpec extends $dara.Mode
308
308
  dbPassword?: string;
309
309
  /**
310
310
  * @remarks
311
- * Required for knowledge applications. The LLM model name, such as qwen3-max.
311
+ * The LLM model name. This parameter is required for knowledge applications, such as qwen3-max.
312
312
  */
313
313
  llmModel?: string;
314
314
  static names(): { [key: string]: string } {
@@ -363,7 +363,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
363
363
  dbUser?: string;
364
364
  /**
365
365
  * @remarks
366
- * Required for mem0 applications. The embedder model name, such as text-embedding-v4.
366
+ * The embedder model name. This parameter is required for mem0 applications, such as text-embedding-v4.
367
367
  *
368
368
  * @example
369
369
  * text-embedding-v4
@@ -387,7 +387,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
387
387
  graphLlmModel?: string;
388
388
  /**
389
389
  * @remarks
390
- * Required for mem0 applications. The LLM model name, such as qwen3-max.
390
+ * The LLM model name. This parameter is required for mem0 applications, such as qwen3-max.
391
391
  *
392
392
  * @example
393
393
  * qwen3-max
@@ -395,7 +395,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
395
395
  llmModel?: string;
396
396
  /**
397
397
  * @remarks
398
- * The project name, which corresponds to the database schema that stores project data.
398
+ * The project name, which corresponds to the schema in the database where project data is stored.
399
399
  *
400
400
  * @example
401
401
  * test-project-name
@@ -403,7 +403,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
403
403
  projectName?: string;
404
404
  /**
405
405
  * @remarks
406
- * Required for mem0 applications. The reranker model name, such as qwen3-rerank.
406
+ * The reranker model name. This parameter is required for mem0 applications, such as qwen3-rerank.
407
407
  *
408
408
  * @example
409
409
  * qwen3-rerank
@@ -507,7 +507,7 @@ export class CreateApplicationRequestStorages extends $dara.Model {
507
507
  containerMountPath?: string;
508
508
  /**
509
509
  * @remarks
510
- * The storage endpoint ID.
510
+ * The ID of the storage endpoint.
511
511
  *
512
512
  * @example
513
513
  * pe-xxxx
@@ -531,7 +531,7 @@ export class CreateApplicationRequestStorages extends $dara.Model {
531
531
  storageCapacity?: string;
532
532
  /**
533
533
  * @remarks
534
- * The storage access endpoint.
534
+ * The storage access address.
535
535
  *
536
536
  * @example
537
537
  * polarfs.example.com
@@ -653,6 +653,14 @@ export class CreateApplicationRequest extends $dara.Model {
653
653
  * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
654
654
  */
655
655
  agenticDBBranchSpec?: CreateApplicationRequestAgenticDBBranchSpec;
656
+ /**
657
+ * @remarks
658
+ * The AgenticDB cluster ID.
659
+ *
660
+ * @example
661
+ * pagc-xxx
662
+ */
663
+ agenticDBClusterId?: string;
656
664
  /**
657
665
  * @remarks
658
666
  * The application type. Valid values:
@@ -697,7 +705,7 @@ export class CreateApplicationRequest extends $dara.Model {
697
705
  authProviderConfig?: string;
698
706
  /**
699
707
  * @remarks
700
- * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
708
+ * Specifies whether to automatically create an elastic IP address (EIP) and associate it with the instance.
701
709
  *
702
710
  * @example
703
711
  * qwen3-max
@@ -705,7 +713,7 @@ export class CreateApplicationRequest extends $dara.Model {
705
713
  autoAllocatePublicEip?: boolean;
706
714
  /**
707
715
  * @remarks
708
- * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
716
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase. Valid values:
709
717
  * * false (default): Automatic creation is disabled.
710
718
  * * true: Automatic creation is enabled.
711
719
  *
@@ -759,7 +767,7 @@ export class CreateApplicationRequest extends $dara.Model {
759
767
  dnatEntries?: CreateApplicationRequestDnatEntries[];
760
768
  /**
761
769
  * @remarks
762
- * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
770
+ * The DNAT-dedicated NAT IP address allocated by the customer, which must be separate from the SNAT IP address. The IP address must belong to the specified gateway and be in an available state. The vSwitch where the gateway resides must be in a primary CIDR block reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: The customer has bound an SNAT entry to the vSwitch where the application resides.
763
771
  *
764
772
  * @example
765
773
  * 10.64.0.10
@@ -816,7 +824,7 @@ export class CreateApplicationRequest extends $dara.Model {
816
824
  * @remarks
817
825
  * The model source. Valid values:
818
826
  *
819
- * * bailian: Alibaba Cloud Model Studio model.
827
+ * * bailian: Bailian model.
820
828
  * * custom: Custom model.
821
829
  * * maas: PolarDB model operator.
822
830
  *
@@ -907,7 +915,7 @@ export class CreateApplicationRequest extends $dara.Model {
907
915
  securityIPArrayName?: string;
908
916
  /**
909
917
  * @remarks
910
- * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
918
+ * The IP whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
911
919
  *
912
920
  * @example
913
921
  * 127.0.0.1,172.17.0.0/24
@@ -976,7 +984,7 @@ export class CreateApplicationRequest extends $dara.Model {
976
984
  vpcId?: string;
977
985
  /**
978
986
  * @remarks
979
- * 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 an active state.
987
+ * 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 active status.
980
988
  *
981
989
  * @example
982
990
  * ngw-xxx
@@ -994,6 +1002,7 @@ export class CreateApplicationRequest extends $dara.Model {
994
1002
  return {
995
1003
  AIDBClusterId: 'AIDBClusterId',
996
1004
  agenticDBBranchSpec: 'AgenticDBBranchSpec',
1005
+ agenticDBClusterId: 'AgenticDBClusterId',
997
1006
  applicationType: 'ApplicationType',
998
1007
  architecture: 'Architecture',
999
1008
  authProvider: 'AuthProvider',
@@ -1043,6 +1052,7 @@ export class CreateApplicationRequest extends $dara.Model {
1043
1052
  return {
1044
1053
  AIDBClusterId: 'string',
1045
1054
  agenticDBBranchSpec: CreateApplicationRequestAgenticDBBranchSpec,
1055
+ agenticDBClusterId: 'string',
1046
1056
  applicationType: 'string',
1047
1057
  architecture: 'string',
1048
1058
  authProvider: 'string',
@@ -48,7 +48,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
48
48
  components?: CreateApplicationResponseBodyComponents[];
49
49
  /**
50
50
  * @remarks
51
- * The application description.
51
+ * The description of the application.
52
52
  *
53
53
  * @example
54
54
  * myapp
@@ -59,6 +59,14 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
59
59
  * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
60
60
  */
61
61
  agenticDBBranchSpecShrink?: string;
62
+ /**
63
+ * @remarks
64
+ * The AgenticDB cluster ID.
65
+ *
66
+ * @example
67
+ * pagc-xxx
68
+ */
69
+ agenticDBClusterId?: string;
62
70
  /**
63
71
  * @remarks
64
72
  * The application type. Valid values:
@@ -103,7 +111,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
103
111
  authProviderConfig?: string;
104
112
  /**
105
113
  * @remarks
106
- * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
114
+ * Specifies whether to automatically create an elastic IP address (EIP) and associate it with the instance.
107
115
  *
108
116
  * @example
109
117
  * qwen3-max
@@ -111,7 +119,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
111
119
  autoAllocatePublicEip?: boolean;
112
120
  /**
113
121
  * @remarks
114
- * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
122
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase. Valid values:
115
123
  * * false (default): Automatic creation is disabled.
116
124
  * * true: Automatic creation is enabled.
117
125
  *
@@ -165,7 +173,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
165
173
  dnatEntriesShrink?: string;
166
174
  /**
167
175
  * @remarks
168
- * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
176
+ * The DNAT-dedicated NAT IP address allocated by the customer, which must be separate from the SNAT IP address. The IP address must belong to the specified gateway and be in an available state. The vSwitch where the gateway resides must be in a primary CIDR block reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: The customer has bound an SNAT entry to the vSwitch where the application resides.
169
177
  *
170
178
  * @example
171
179
  * 10.64.0.10
@@ -222,7 +230,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
222
230
  * @remarks
223
231
  * The model source. Valid values:
224
232
  *
225
- * * bailian: Alibaba Cloud Model Studio model.
233
+ * * bailian: Bailian model.
226
234
  * * custom: Custom model.
227
235
  * * maas: PolarDB model operator.
228
236
  *
@@ -313,7 +321,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
313
321
  securityIPArrayName?: string;
314
322
  /**
315
323
  * @remarks
316
- * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
324
+ * The IP whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
317
325
  *
318
326
  * @example
319
327
  * 127.0.0.1,172.17.0.0/24
@@ -382,7 +390,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
382
390
  vpcId?: string;
383
391
  /**
384
392
  * @remarks
385
- * 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 an active state.
393
+ * 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 active status.
386
394
  *
387
395
  * @example
388
396
  * ngw-xxx
@@ -400,6 +408,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
400
408
  return {
401
409
  AIDBClusterId: 'AIDBClusterId',
402
410
  agenticDBBranchSpecShrink: 'AgenticDBBranchSpec',
411
+ agenticDBClusterId: 'AgenticDBClusterId',
403
412
  applicationType: 'ApplicationType',
404
413
  architecture: 'Architecture',
405
414
  authProvider: 'AuthProvider',
@@ -449,6 +458,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
449
458
  return {
450
459
  AIDBClusterId: 'string',
451
460
  agenticDBBranchSpecShrink: 'string',
461
+ agenticDBClusterId: 'string',
452
462
  applicationType: 'string',
453
463
  architecture: 'string',
454
464
  authProvider: 'string',
@@ -53,7 +53,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
53
53
  linkName?: string;
54
54
  /**
55
55
  * @remarks
56
- * The MCP Server address for DingTalk documents.
56
+ * The MCP Server endpoint for DingTalk documents.
57
57
  *
58
58
  * @example
59
59
  * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx789?key=d5e6fxxxxxx876
@@ -71,7 +71,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
71
71
  regionId?: string;
72
72
  /**
73
73
  * @remarks
74
- * The MCP Server address for DingTalk sheets.
74
+ * The MCP Server endpoint for DingTalk spreadsheets.
75
75
  *
76
76
  * @example
77
77
  * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx567?key=d5e6fxxxxxx543
@@ -79,7 +79,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
79
79
  sheetMcpEndpoint?: string;
80
80
  /**
81
81
  * @remarks
82
- * The source directory address for synchronization.
82
+ * The directory address of the synchronization source.
83
83
  *
84
84
  * This parameter is required.
85
85
  *
@@ -15,6 +15,8 @@ export class CreateKBSyncLinkResponseBody extends $dara.Model {
15
15
  * @remarks
16
16
  * The time when the synchronization link was created.
17
17
  *
18
+ * The time is in the ISO 8601 standard in the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ).
19
+ *
18
20
  * @example
19
21
  * 2026-08-14T05:58:42Z
20
22
  */
@@ -63,7 +65,7 @@ export class CreateKBSyncLinkResponseBody extends $dara.Model {
63
65
  requestId?: string;
64
66
  /**
65
67
  * @remarks
66
- * The source directory address for synchronization.
68
+ * The directory address of the synchronization source.
67
69
  *
68
70
  * @example
69
71
  * https://example.feishu.cn/wiki/space/xxxxxx
@@ -59,6 +59,11 @@ export class CreateNetworkChannelRequest extends $dara.Model {
59
59
  resourceGroupId?: string;
60
60
  resourceOwnerAccount?: string;
61
61
  resourceOwnerId?: number;
62
+ /**
63
+ * @example
64
+ * sg-2z********
65
+ */
66
+ securityGroupId?: string;
62
67
  /**
63
68
  * @remarks
64
69
  * The name of the destination instance.
@@ -103,6 +108,7 @@ export class CreateNetworkChannelRequest extends $dara.Model {
103
108
  resourceGroupId: 'ResourceGroupId',
104
109
  resourceOwnerAccount: 'ResourceOwnerAccount',
105
110
  resourceOwnerId: 'ResourceOwnerId',
111
+ securityGroupId: 'SecurityGroupId',
106
112
  targetDBClusterId: 'TargetDBClusterId',
107
113
  targetIp: 'TargetIp',
108
114
  targetPort: 'TargetPort',
@@ -122,6 +128,7 @@ export class CreateNetworkChannelRequest extends $dara.Model {
122
128
  resourceGroupId: 'string',
123
129
  resourceOwnerAccount: 'string',
124
130
  resourceOwnerId: 'number',
131
+ securityGroupId: 'string',
125
132
  targetDBClusterId: 'string',
126
133
  targetIp: 'string',
127
134
  targetPort: 'string',
@@ -19,6 +19,11 @@ export class DescribeNetworkChannelResponseBodyChannelInfos extends $dara.Model
19
19
  * pc-*************
20
20
  */
21
21
  DBClusterId?: string;
22
+ /**
23
+ * @example
24
+ * eni-2z******
25
+ */
26
+ eniId?: string;
22
27
  /**
23
28
  * @remarks
24
29
  * The notes about the channel.
@@ -79,6 +84,7 @@ export class DescribeNetworkChannelResponseBodyChannelInfos extends $dara.Model
79
84
  return {
80
85
  channelName: 'ChannelName',
81
86
  DBClusterId: 'DBClusterId',
87
+ eniId: 'EniId',
82
88
  notes: 'Notes',
83
89
  regionId: 'RegionId',
84
90
  targetDBClusterId: 'TargetDBClusterId',
@@ -93,6 +99,7 @@ export class DescribeNetworkChannelResponseBodyChannelInfos extends $dara.Model
93
99
  return {
94
100
  channelName: 'string',
95
101
  DBClusterId: 'string',
102
+ eniId: 'string',
96
103
  notes: 'string',
97
104
  regionId: 'string',
98
105
  targetDBClusterId: 'string',
@@ -44,55 +44,55 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
44
44
  DBEndpointId?: string;
45
45
  /**
46
46
  * @remarks
47
- * The advanced configuration of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
47
+ * The advanced configuration of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, connection pooling, and other settings.
48
48
  *
49
- * * To set the load balancing policy, use the format `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
49
+ * * To configure the load balancing policy, use the format `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:
50
50
  * * **0**: connection-based load balancing (default)
51
51
  * * **1**: active-request-based load balancing
52
52
  *
53
- * * To set whether the primary node accepts read requests, use the format `{\\"MasterAcceptReads\\":\\"Whether the primary node accepts reads\\"}`. Valid values:
53
+ * * To configure whether the primary node accepts read requests, use the format `{\\"MasterAcceptReads\\":\\"Whether the primary node accepts reads\\"}`. Valid values:
54
54
  * * **on**: The primary node accepts read requests. (Default)
55
55
  * * **off**: The primary node does not accept read requests.
56
56
  *
57
- * * To set transaction splitting, use the format `{\\"DistributedTransaction\\":\\"Transaction splitting\\"}`. Valid values:
57
+ * * To configure transaction splitting, use the format `{\\"DistributedTransaction\\":\\"Transaction splitting\\"}`. Valid values:
58
58
  * * **on**: Transaction splitting is enabled. (Default)
59
59
  * * **off**: Transaction splitting is disabled.
60
60
  *
61
- * * To set the consistency level, use the format `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
61
+ * * To configure the consistency level, use the format `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
62
62
  * * **0**: eventual consistency (weak)
63
63
  * * **1**: session consistency (medium) (default)
64
64
  * * **2**: global consistency (strong)
65
65
  *
66
- * * To set the global consistency read timeout period, use the format `{\\"ConsistTimeout\\":\\"Global consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
66
+ * * To configure the global consistency read timeout period, use the format `{\\"ConsistTimeout\\":\\"Global consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
67
67
  *
68
- * * To set the session consistency read timeout period, use the format `{\\"ConsistSessionTimeout\\":\\"Session consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
68
+ * * To configure the session consistency read timeout period, use the format `{\\"ConsistSessionTimeout\\":\\"Session consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
69
69
  *
70
- * * To set the global (or session) consistency read timeout policy, use the format `{\\"ConsistTimeoutAction\\":\\"Global consistency read timeout policy\\"}`. Valid values:
70
+ * * To configure the global (or session) consistency read timeout policy, use the format `{\\"ConsistTimeoutAction\\":\\"Global consistency read timeout policy\\"}`. Valid values:
71
71
  * * **0**: Forward the read request to the primary node. (Default)
72
72
  * * **1**: The proxy returns the error message `wait replication complete timeout, please retry` to the application.
73
73
  *
74
- * * To set the connection pool, use the format `{\\"ConnectionPersist\\":\\"Connection pool\\"}`. Valid values:
75
- * * **off**: The connection pool is disabled. (Default)
76
- * * **Session**: The session-level connection pool is enabled.
77
- * * **Transaction**: The transaction-level connection pooling is enabled.
74
+ * * To configure connection pooling, use the format `{\\"ConnectionPersist\\":\\"Connection pool\\"}`. Valid values:
75
+ * * **off**: Connection pooling is disabled. (Default)
76
+ * * **Session**: Session-level connection pooling is enabled.
77
+ * * **Transaction**: Transaction-level connection pooling is enabled.
78
78
  *
79
- * * To set parallel query, use the format `{\\"MaxParallelDegree\\":\\"Parallel query\\"}`. Valid values:
79
+ * * To configure parallel query, use the format `{\\"MaxParallelDegree\\":\\"Parallel query\\"}`. Valid values:
80
80
  * * **on**: Parallel query is enabled.
81
81
  * * **off**: Parallel query is disabled. (Default)
82
82
  *
83
- * * To set automatic request distribution among row offload reads from primary nodes, use the format `{\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store\\"}`. Valid values:
83
+ * * To configure automatic request distribution among row offload reads from primary nodes, use the format `{\\"EnableHtapImci\\":\\"Row store/column store automatic request distribution\\"}`. Valid values:
84
84
  * * **on**: Automatic request distribution among row offload reads from primary nodes is enabled.
85
85
  * * **off**: Automatic request distribution among row offload reads from primary nodes is disabled. (Default)
86
86
  *
87
87
  *
88
- * * To set whether to enable overload protection, use the format `{\\"EnableOverloadThrottle\\":\\"Whether to enable overload protection\\"}`. Valid values:
88
+ * * To configure overload protection, use the format `{\\"EnableOverloadThrottle\\":\\"Whether to enable overload protection\\"}`. Valid values:
89
89
  * * **on**: Overload protection is enabled.
90
90
  * * **off**: Overload protection is disabled. (Default)
91
91
  *
92
- * * To set node weights, use the format `{\\"NodesWeight\\":{\\"Node ID\\":\\"Weight value\\"}}`.
92
+ * * To configure node weights, use the format `{\\"NodesWeight\\":{\\"Node ID\\":\\"Weight value\\"}}`.
93
93
  *
94
94
  * > * Transaction splitting, whether the primary node accepts read requests, connection pooling, and overload protection can be configured only when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**.
95
- * > * When the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadOnly**, both **connection-based load balancing** and **active-request-based load balancing** policies are supported. The **ReadWrite (automatic read/write splitting)** mode supports only the **active-request-based load balancing** policy.
95
+ * > * When the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadOnly**, both **connection-based load balancing** and **active-request-based load balancing** are supported. When the read/write mode is **ReadWrite (automatic read/write splitting)**, only **active-request-based load balancing** is supported.
96
96
  * > * Automatic request distribution among row offload reads from primary nodes can be configured when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**, or when the read/write mode is **ReadOnly** and the load balancing policy is **active-request-based load balancing**.
97
97
  * > * Only PolarDB for MySQL supports setting the consistency level to global consistency.
98
98
  * > * If **ReadWriteMode** is set to **ReadOnly**, the consistency level can only be set to **0**.
@@ -109,10 +109,10 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
109
109
  *
110
110
  * > * For PolarDB for MySQL, specify node IDs.
111
111
  * > * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`.
112
- * > * If **ReadWriteMode** is set to **ReadOnly**, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Select at least 2 nodes to improve availability.
112
+ * > * If **ReadWriteMode** is set to **ReadOnly**, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Mount at least 2 nodes to improve availability.
113
113
  * > * If **ReadWriteMode** is set to **ReadWrite**, select at least 2 nodes.
114
- * * PolarDB for MySQL allows you to select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
115
- * * PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle) require the primary node to be included.
114
+ * * For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
115
+ * * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), the primary node must be included.
116
116
  *
117
117
  * @example
118
118
  * pi-**************,pi-*************
@@ -124,7 +124,7 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
124
124
  * @remarks
125
125
  * The timeout policy for global consistency. Valid values:
126
126
  *
127
- * - **0**: Send the request to the primary node.
127
+ * - **0**: Sends the request to the primary node.
128
128
  *
129
129
  * - **2**: Timeout degradation. When the global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.
130
130
  *