@alicloud/gpdb20160503 3.11.0 → 3.12.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 (183) hide show
  1. package/dist/client.d.ts +182 -56
  2. package/dist/client.js +377 -59
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CheckSaasServiceVersionRequest.d.ts +31 -0
  5. package/dist/models/CheckSaasServiceVersionRequest.js +60 -0
  6. package/dist/models/CheckSaasServiceVersionRequest.js.map +1 -0
  7. package/dist/models/CheckSaasServiceVersionResponse.d.ts +19 -0
  8. package/dist/models/CheckSaasServiceVersionResponse.js +69 -0
  9. package/dist/models/CheckSaasServiceVersionResponse.js.map +1 -0
  10. package/dist/models/CheckSaasServiceVersionResponseBody.d.ts +45 -0
  11. package/dist/models/CheckSaasServiceVersionResponseBody.js +64 -0
  12. package/dist/models/CheckSaasServiceVersionResponseBody.js.map +1 -0
  13. package/dist/models/CreateApiKeyRequest.d.ts +14 -0
  14. package/dist/models/CreateApiKeyRequest.js.map +1 -1
  15. package/dist/models/CreateApiKeyResponseBody.d.ts +9 -0
  16. package/dist/models/CreateApiKeyResponseBody.js.map +1 -1
  17. package/dist/models/CreateApiKeyShrinkRequest.d.ts +14 -0
  18. package/dist/models/CreateApiKeyShrinkRequest.js.map +1 -1
  19. package/dist/models/CreateDbinstanceRequest.d.ts +116 -171
  20. package/dist/models/CreateDbinstanceRequest.js.map +1 -1
  21. package/dist/models/CreateDbinstanceResponseBody.d.ts +3 -3
  22. package/dist/models/CreateSupabaseProjectRequest.d.ts +20 -5
  23. package/dist/models/CreateSupabaseProjectRequest.js +27 -1
  24. package/dist/models/CreateSupabaseProjectRequest.js.map +1 -1
  25. package/dist/models/CreateSupabaseProjectResponseBody.d.ts +2 -2
  26. package/dist/models/DeleteApiKeyRequest.d.ts +5 -0
  27. package/dist/models/DeleteApiKeyRequest.js.map +1 -1
  28. package/dist/models/DeleteApiKeyResponseBody.d.ts +6 -0
  29. package/dist/models/DeleteApiKeyResponseBody.js.map +1 -1
  30. package/dist/models/DeleteWorkspaceRequest.d.ts +5 -0
  31. package/dist/models/DeleteWorkspaceRequest.js.map +1 -1
  32. package/dist/models/DeleteWorkspaceResponseBody.d.ts +6 -0
  33. package/dist/models/DeleteWorkspaceResponseBody.js.map +1 -1
  34. package/dist/models/GetApiEndpointsRequest.d.ts +37 -0
  35. package/dist/models/GetApiEndpointsRequest.js +62 -0
  36. package/dist/models/GetApiEndpointsRequest.js.map +1 -0
  37. package/dist/models/GetApiEndpointsResponse.d.ts +19 -0
  38. package/dist/models/GetApiEndpointsResponse.js +69 -0
  39. package/dist/models/GetApiEndpointsResponse.js.map +1 -0
  40. package/dist/models/GetApiEndpointsResponseBody.d.ts +89 -0
  41. package/dist/models/GetApiEndpointsResponseBody.js +92 -0
  42. package/dist/models/GetApiEndpointsResponseBody.js.map +1 -0
  43. package/dist/models/GetApiKeyRequest.d.ts +5 -0
  44. package/dist/models/GetApiKeyRequest.js.map +1 -1
  45. package/dist/models/GetApiKeyResponseBody.d.ts +34 -0
  46. package/dist/models/GetApiKeyResponseBody.js.map +1 -1
  47. package/dist/models/GetSaasServiceRequest.d.ts +5 -0
  48. package/dist/models/GetSaasServiceRequest.js.map +1 -1
  49. package/dist/models/GetSaasServiceResponseBody.d.ts +38 -0
  50. package/dist/models/GetSaasServiceResponseBody.js.map +1 -1
  51. package/dist/models/GetServiceAccessInfoRequest.d.ts +5 -0
  52. package/dist/models/GetServiceAccessInfoRequest.js.map +1 -1
  53. package/dist/models/GetServiceAccessInfoResponseBody.d.ts +9 -0
  54. package/dist/models/GetServiceAccessInfoResponseBody.js.map +1 -1
  55. package/dist/models/GetWorkspaceRequest.d.ts +5 -0
  56. package/dist/models/GetWorkspaceRequest.js.map +1 -1
  57. package/dist/models/GetWorkspaceResponseBody.d.ts +83 -0
  58. package/dist/models/GetWorkspaceResponseBody.js.map +1 -1
  59. package/dist/models/GrantApiKeyRequest.d.ts +48 -0
  60. package/dist/models/GrantApiKeyRequest.js +67 -0
  61. package/dist/models/GrantApiKeyRequest.js.map +1 -0
  62. package/dist/models/GrantApiKeyResponse.d.ts +19 -0
  63. package/dist/models/GrantApiKeyResponse.js +69 -0
  64. package/dist/models/GrantApiKeyResponse.js.map +1 -0
  65. package/dist/models/GrantApiKeyResponseBody.d.ts +21 -0
  66. package/dist/models/GrantApiKeyResponseBody.js +58 -0
  67. package/dist/models/GrantApiKeyResponseBody.js.map +1 -0
  68. package/dist/models/GrantApiKeyShrinkRequest.d.ts +48 -0
  69. package/dist/models/GrantApiKeyShrinkRequest.js +64 -0
  70. package/dist/models/GrantApiKeyShrinkRequest.js.map +1 -0
  71. package/dist/models/ListApiKeysRequest.d.ts +14 -0
  72. package/dist/models/ListApiKeysRequest.js.map +1 -1
  73. package/dist/models/ListApiKeysResponseBody.d.ts +45 -0
  74. package/dist/models/ListApiKeysResponseBody.js.map +1 -1
  75. package/dist/models/ListSaasServiceRequest.d.ts +1 -1
  76. package/dist/models/ListSaasServiceResponseBody.d.ts +80 -1
  77. package/dist/models/ListSaasServiceResponseBody.js +37 -1
  78. package/dist/models/ListSaasServiceResponseBody.js.map +1 -1
  79. package/dist/models/ListWorkspacesResponseBody.d.ts +21 -1
  80. package/dist/models/ListWorkspacesResponseBody.js +37 -1
  81. package/dist/models/ListWorkspacesResponseBody.js.map +1 -1
  82. package/dist/models/ModifySaasServiceDeletionProtectionRequest.d.ts +39 -0
  83. package/dist/models/ModifySaasServiceDeletionProtectionRequest.js +62 -0
  84. package/dist/models/ModifySaasServiceDeletionProtectionRequest.js.map +1 -0
  85. package/dist/models/ModifySaasServiceDeletionProtectionResponse.d.ts +19 -0
  86. package/dist/models/ModifySaasServiceDeletionProtectionResponse.js +69 -0
  87. package/dist/models/ModifySaasServiceDeletionProtectionResponse.js.map +1 -0
  88. package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.d.ts +37 -0
  89. package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.js +62 -0
  90. package/dist/models/ModifySaasServiceDeletionProtectionResponseBody.js.map +1 -0
  91. package/dist/models/PauseSaasServiceRequest.d.ts +5 -0
  92. package/dist/models/PauseSaasServiceRequest.js.map +1 -1
  93. package/dist/models/PauseSaasServiceResponseBody.d.ts +6 -0
  94. package/dist/models/PauseSaasServiceResponseBody.js.map +1 -1
  95. package/dist/models/QueryContentAdvanceRequest.d.ts +26 -27
  96. package/dist/models/QueryContentAdvanceRequest.js.map +1 -1
  97. package/dist/models/QueryContentRequest.d.ts +26 -27
  98. package/dist/models/QueryContentRequest.js.map +1 -1
  99. package/dist/models/QueryContentResponseBody.d.ts +2 -2
  100. package/dist/models/QueryContentShrinkRequest.d.ts +24 -24
  101. package/dist/models/ResumeSaasServiceRequest.d.ts +5 -0
  102. package/dist/models/ResumeSaasServiceRequest.js.map +1 -1
  103. package/dist/models/ResumeSaasServiceResponseBody.d.ts +6 -0
  104. package/dist/models/ResumeSaasServiceResponseBody.js.map +1 -1
  105. package/dist/models/RevokeApiKeyRequest.d.ts +48 -0
  106. package/dist/models/RevokeApiKeyRequest.js +67 -0
  107. package/dist/models/RevokeApiKeyRequest.js.map +1 -0
  108. package/dist/models/RevokeApiKeyResponse.d.ts +19 -0
  109. package/dist/models/RevokeApiKeyResponse.js +69 -0
  110. package/dist/models/RevokeApiKeyResponse.js.map +1 -0
  111. package/dist/models/RevokeApiKeyResponseBody.d.ts +21 -0
  112. package/dist/models/RevokeApiKeyResponseBody.js +58 -0
  113. package/dist/models/RevokeApiKeyResponseBody.js.map +1 -0
  114. package/dist/models/RevokeApiKeyShrinkRequest.d.ts +48 -0
  115. package/dist/models/RevokeApiKeyShrinkRequest.js +64 -0
  116. package/dist/models/RevokeApiKeyShrinkRequest.js.map +1 -0
  117. package/dist/models/UpdateSaasServiceVersionRequest.d.ts +31 -0
  118. package/dist/models/UpdateSaasServiceVersionRequest.js +60 -0
  119. package/dist/models/UpdateSaasServiceVersionRequest.js.map +1 -0
  120. package/dist/models/UpdateSaasServiceVersionResponse.d.ts +19 -0
  121. package/dist/models/UpdateSaasServiceVersionResponse.js +69 -0
  122. package/dist/models/UpdateSaasServiceVersionResponse.js.map +1 -0
  123. package/dist/models/UpdateSaasServiceVersionResponseBody.d.ts +37 -0
  124. package/dist/models/UpdateSaasServiceVersionResponseBody.js +62 -0
  125. package/dist/models/UpdateSaasServiceVersionResponseBody.js.map +1 -0
  126. package/dist/models/model.d.ts +24 -0
  127. package/dist/models/model.js +80 -32
  128. package/dist/models/model.js.map +1 -1
  129. package/package.json +2 -2
  130. package/src/client.ts +410 -59
  131. package/src/models/CheckSaasServiceVersionRequest.ts +46 -0
  132. package/src/models/CheckSaasServiceVersionResponse.ts +40 -0
  133. package/src/models/CheckSaasServiceVersionResponseBody.ts +64 -0
  134. package/src/models/CreateApiKeyRequest.ts +14 -0
  135. package/src/models/CreateApiKeyResponseBody.ts +9 -0
  136. package/src/models/CreateApiKeyShrinkRequest.ts +14 -0
  137. package/src/models/CreateDbinstanceRequest.ts +124 -179
  138. package/src/models/CreateDbinstanceResponseBody.ts +3 -3
  139. package/src/models/CreateSupabaseProjectRequest.ts +37 -5
  140. package/src/models/CreateSupabaseProjectResponseBody.ts +2 -2
  141. package/src/models/DeleteApiKeyRequest.ts +5 -0
  142. package/src/models/DeleteApiKeyResponseBody.ts +6 -0
  143. package/src/models/DeleteWorkspaceRequest.ts +5 -0
  144. package/src/models/DeleteWorkspaceResponseBody.ts +6 -0
  145. package/src/models/GetApiEndpointsRequest.ts +54 -0
  146. package/src/models/GetApiEndpointsResponse.ts +40 -0
  147. package/src/models/GetApiEndpointsResponseBody.ts +127 -0
  148. package/src/models/GetApiKeyRequest.ts +5 -0
  149. package/src/models/GetApiKeyResponseBody.ts +34 -0
  150. package/src/models/GetSaasServiceRequest.ts +5 -0
  151. package/src/models/GetSaasServiceResponseBody.ts +38 -0
  152. package/src/models/GetServiceAccessInfoRequest.ts +5 -0
  153. package/src/models/GetServiceAccessInfoResponseBody.ts +9 -0
  154. package/src/models/GetWorkspaceRequest.ts +5 -0
  155. package/src/models/GetWorkspaceResponseBody.ts +83 -0
  156. package/src/models/GrantApiKeyRequest.ts +70 -0
  157. package/src/models/GrantApiKeyResponse.ts +40 -0
  158. package/src/models/GrantApiKeyResponseBody.ts +34 -0
  159. package/src/models/GrantApiKeyShrinkRequest.ts +67 -0
  160. package/src/models/ListApiKeysRequest.ts +14 -0
  161. package/src/models/ListApiKeysResponseBody.ts +45 -0
  162. package/src/models/ListSaasServiceRequest.ts +1 -1
  163. package/src/models/ListSaasServiceResponseBody.ts +107 -1
  164. package/src/models/ListWorkspacesResponseBody.ts +48 -1
  165. package/src/models/ModifySaasServiceDeletionProtectionRequest.ts +56 -0
  166. package/src/models/ModifySaasServiceDeletionProtectionResponse.ts +40 -0
  167. package/src/models/ModifySaasServiceDeletionProtectionResponseBody.ts +54 -0
  168. package/src/models/PauseSaasServiceRequest.ts +5 -0
  169. package/src/models/PauseSaasServiceResponseBody.ts +6 -0
  170. package/src/models/QueryContentAdvanceRequest.ts +26 -27
  171. package/src/models/QueryContentRequest.ts +26 -27
  172. package/src/models/QueryContentResponseBody.ts +2 -2
  173. package/src/models/QueryContentShrinkRequest.ts +24 -24
  174. package/src/models/ResumeSaasServiceRequest.ts +5 -0
  175. package/src/models/ResumeSaasServiceResponseBody.ts +6 -0
  176. package/src/models/RevokeApiKeyRequest.ts +70 -0
  177. package/src/models/RevokeApiKeyResponse.ts +40 -0
  178. package/src/models/RevokeApiKeyResponseBody.ts +34 -0
  179. package/src/models/RevokeApiKeyShrinkRequest.ts +67 -0
  180. package/src/models/UpdateSaasServiceVersionRequest.ts +46 -0
  181. package/src/models/UpdateSaasServiceVersionResponse.ts +40 -0
  182. package/src/models/UpdateSaasServiceVersionResponseBody.ts +54 -0
  183. package/src/models/model.ts +24 -0
@@ -13,7 +13,7 @@ export class CreateDBInstanceRequestAINodeSpecInfos extends $dara.Model {
13
13
  AINodeNum?: string;
14
14
  /**
15
15
  * @remarks
16
- * The specifications of the AI nodes.
16
+ * The AI node specifications.
17
17
  *
18
18
  * @example
19
19
  * ADB.AIMedium.2
@@ -47,11 +47,9 @@ export class CreateDBInstanceRequestTag extends $dara.Model {
47
47
  * @remarks
48
48
  * The tag key. The following limits apply:
49
49
  *
50
- * - The tag key cannot be empty.
51
- *
50
+ * - The tag key cannot be an empty string.
52
51
  * - The tag key can be up to 128 characters in length.
53
- *
54
- * - The tag key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.
52
+ * - The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
55
53
  *
56
54
  * @example
57
55
  * TestKey
@@ -61,11 +59,9 @@ export class CreateDBInstanceRequestTag extends $dara.Model {
61
59
  * @remarks
62
60
  * The tag value. The following limits apply:
63
61
  *
64
- * - The tag value can be empty.
65
- *
62
+ * - The tag value can be an empty string.
66
63
  * - The tag value can be up to 128 characters in length.
67
- *
68
- * - The tag value cannot start with `acs:` and cannot contain `http://` or `https://`.
64
+ * - The tag value cannot start with `acs:`, and cannot contain `http://` or `https://`.
69
65
  *
70
66
  * @example
71
67
  * TestValue
@@ -97,14 +93,14 @@ export class CreateDBInstanceRequestTag extends $dara.Model {
97
93
  export class CreateDBInstanceRequest extends $dara.Model {
98
94
  /**
99
95
  * @remarks
100
- * The AI node specifications.
96
+ * The AI node specifications information.
101
97
  */
102
98
  AINodeSpecInfos?: CreateDBInstanceRequestAINodeSpecInfos[];
103
99
  /**
104
100
  * @remarks
105
- * The ID of the backup set.
101
+ * The backup set ID.
106
102
  *
107
- * > You can call the [DescribeDataBackups](https://help.aliyun.com/document_detail/210093.html) operation to query the backup set IDs for the source instance.
103
+ * > You can call the [DescribeDataBackups](https://help.aliyun.com/document_detail/210093.html) operation to query the backup set IDs of all backup sets for the target instance.
108
104
  *
109
105
  * @example
110
106
  * 1111111111
@@ -112,7 +108,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
112
108
  backupId?: string;
113
109
  /**
114
110
  * @remarks
115
- * The cache size for a serverless instance, in GB.
111
+ * The Serverless cache storage size. Valid values: 800 to 102400. The step size is 32 GB. Unit: GB.
116
112
  *
117
113
  * @example
118
114
  * 800
@@ -120,7 +116,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
120
116
  cacheStorageSize?: string;
121
117
  /**
122
118
  * @remarks
123
- * A client token used to ensure the idempotence of the request. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/327176.html).
119
+ * The client token used for idempotence checks. For more information, see [How to ensure idempotence](https://help.aliyun.com/document_detail/327176.html).
124
120
  *
125
121
  * @example
126
122
  * 0c593ea1-3bea-11e9-b96b-88**********
@@ -130,11 +126,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
130
126
  * @remarks
131
127
  * Specifies whether to load a sample dataset after the instance is created. Valid values:
132
128
  *
133
- * - **true**: A sample dataset is loaded.
129
+ * - **true**: Load a sample dataset.
130
+ * - **false**: Do not load a sample dataset.
134
131
  *
135
- * - **false**: A sample dataset is not loaded.
136
- *
137
- * > If this parameter is not specified, a sample dataset is not loaded.
132
+ * > If you do not specify this parameter, the default value is false.
138
133
  *
139
134
  * @example
140
135
  * false
@@ -144,11 +139,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
144
139
  * @remarks
145
140
  * The instance edition. Valid values:
146
141
  *
147
- * - **HighAvailability**: High-availability Edition
148
- *
149
- * - **Basic**: Basic Edition
142
+ * - **HighAvailability**: high-availability edition.
143
+ * - **Basic**: basic edition.
150
144
  *
151
- * > This parameter is required for instances in elastic storage mode.
145
+ * > This parameter is required when you create a storage elastic mode instance.
152
146
  *
153
147
  * @example
154
148
  * HighAvailability
@@ -156,9 +150,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
156
150
  DBInstanceCategory?: string;
157
151
  /**
158
152
  * @remarks
159
- * The instance type. For more information, see the description of the `DBInstanceClass` parameter.
153
+ * The instance specifications. For more information, see the supplementary description of the DBInstanceClass parameter.
160
154
  *
161
- * > This parameter is required for instances in reserved storage mode.
155
+ * > This parameter is required when you create a storage reservation mode instance.
162
156
  *
163
157
  * @example
164
158
  * gpdb.group.segsdx1
@@ -166,7 +160,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
166
160
  DBInstanceClass?: string;
167
161
  /**
168
162
  * @remarks
169
- * The instance description.
163
+ * The description of the instance.
170
164
  *
171
165
  * @example
172
166
  * test
@@ -176,7 +170,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
176
170
  * @remarks
177
171
  * The number of compute groups. Valid values: 2, 4, 8, 12, 16, 24, 32, 64, 96, and 128.
178
172
  *
179
- * > This parameter is required for instances in reserved storage mode.
173
+ * > This parameter is required when you create a storage reservation mode instance.
180
174
  *
181
175
  * @example
182
176
  * 2
@@ -184,13 +178,12 @@ export class CreateDBInstanceRequest extends $dara.Model {
184
178
  DBInstanceGroupCount?: string;
185
179
  /**
186
180
  * @remarks
187
- * The instance resource mode. Valid values:
188
- *
189
- * - **StorageElastic**: elastic storage mode
181
+ * The resource type of the instance. Valid values:
190
182
  *
191
- * - **Serverless**: serverless mode
192
- *
193
- * - **Classic**: reserved storage mode
183
+ * - **StorageElastic**: storage elastic mode.
184
+ * - **Serverless**: Serverless mode.
185
+ * - **ServerlessPro**: Serverless Pro mode.
186
+ * - **Classic**: storage reservation mode.
194
187
  *
195
188
  * > This parameter is required.
196
189
  *
@@ -203,14 +196,12 @@ export class CreateDBInstanceRequest extends $dara.Model {
203
196
  /**
204
197
  * @remarks
205
198
  * The deployment mode. Valid values:
199
+ * - multiple: multi-zone deployment.
200
+ * - single: single-zone deployment.
206
201
  *
207
- * - multiple: multi-AZ deployment.
208
- *
209
- * - single: single-AZ deployment.
210
- *
211
- * > * If this parameter is not specified, the default value is single.
212
- * >
213
- * > * Defaults to `single` (single-AZ deployment), which is the only mode currently supported.
202
+ * >
203
+ * > - If you do not specify this parameter, the default value is single-zone deployment.
204
+ * > - Currently, only single-zone deployment is supported.
214
205
  *
215
206
  * @example
216
207
  * single
@@ -218,11 +209,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
218
209
  deployMode?: string;
219
210
  /**
220
211
  * @remarks
221
- * Specifies whether to enable SSL encryption. Valid values:
222
- *
223
- * - **true**: SSL encryption is enabled.
224
- *
225
- * - **false** (default): SSL encryption is disabled.
212
+ * Indicates whether to enable Secure Sockets Layer (SSL) encryption. Valid values:
213
+ * - **true**: Enable SSL encryption.
214
+ * - **false** (default): Do not enable SSL encryption.
226
215
  *
227
216
  * @example
228
217
  * false
@@ -230,9 +219,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
230
219
  enableSSL?: boolean;
231
220
  /**
232
221
  * @remarks
233
- * The ID of the encryption key.
222
+ * The encryption key ID.
234
223
  *
235
- * > If `EncryptionType` is set to `CloudDisk`, you must specify the ID of an encryption key in the same region. Otherwise, leave this parameter empty.
224
+ * > If the **EncryptionType** parameter is set to **CloudDisk**, specify the encryption key ID in the same region. Otherwise, leave this parameter empty.
236
225
  *
237
226
  * @example
238
227
  * 0d2470df-da7b-4786-b981-88888888****
@@ -242,11 +231,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
242
231
  * @remarks
243
232
  * The encryption type. Valid values:
244
233
  *
245
- * - **NULL**: disables encryption. This is the default value.
246
- *
247
- * - **CloudDisk**: Enables cloud disk encryption. If you select this option, you must also specify a value for `EncryptionKey`.
234
+ * - **NULL**: Encryption is not enabled. This is the default value.
235
+ * - **CloudDisk**: Cloud disk encryption is enabled. Use the **EncryptionKey** parameter to specify the encryption key.
248
236
  *
249
- * > After cloud disk encryption is enabled, it cannot be disabled.
237
+ * > Cloud disk encryption cannot be disabled after it is enabled.
250
238
  *
251
239
  * @example
252
240
  * CloudDisk
@@ -265,10 +253,8 @@ export class CreateDBInstanceRequest extends $dara.Model {
265
253
  /**
266
254
  * @remarks
267
255
  * The database engine version. Valid values:
268
- *
269
- * - **6.0**
270
- *
271
- * - **7.0**
256
+ * - **6.0**: version 6.0.
257
+ * - **7.0**: version 7.0.
272
258
  *
273
259
  * This parameter is required.
274
260
  *
@@ -278,9 +264,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
278
264
  engineVersion?: string;
279
265
  /**
280
266
  * @remarks
281
- * The period of inactivity, in seconds, after which the instance is considered idle. Minimum value: 60. Default value: 600.
267
+ * The idle release wait time. The instance transitions to an idle state after no service traffic is detected for the specified duration. Unit: seconds. Minimum value: 60. Default value: 600.
282
268
  *
283
- * > This parameter is required only for serverless instances that use auto-scheduling.
269
+ * > This parameter is required only for Serverless instances in automatic scheduling mode.
284
270
  *
285
271
  * @example
286
272
  * 600
@@ -288,11 +274,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
288
274
  idleTime?: number;
289
275
  /**
290
276
  * @remarks
291
- * The instance network type. Set the value to **VPC**.
277
+ * The network type of the instance. Set the value to **VPC**.
292
278
  *
293
- * > - Only VPCs are supported.
294
- * >
295
- * > - If this parameter is not specified, VPC is used by default.
279
+ * > - Only VPC is supported on the public cloud.
280
+ * > - If you do not specify this parameter, the default value is VPC.
296
281
  *
297
282
  * @example
298
283
  * VPC
@@ -300,33 +285,24 @@ export class CreateDBInstanceRequest extends $dara.Model {
300
285
  instanceNetworkType?: string;
301
286
  /**
302
287
  * @remarks
303
- * The instance type for the compute nodes.
304
- *
305
- * Valid values for a High-availability Edition instance in elastic storage mode:
288
+ * The node specifications of compute nodes.
306
289
  *
290
+ * Valid values for storage elastic mode (high-availability edition):
307
291
  * - **2C16G**
308
- *
309
292
  * - **4C32G**
310
- *
311
293
  * - **16C128G**
312
294
  *
313
- * Valid values for a Basic Edition instance in elastic storage mode:
314
- *
295
+ * Valid values for storage elastic mode (basic edition):
315
296
  * - **2C8G**
316
- *
317
297
  * - **4C16G**
318
- *
319
298
  * - **8C32G**
320
- *
321
299
  * - **16C64G**
322
300
  *
323
- * Valid values for a serverless instance:
324
- *
301
+ * Valid values for Serverless mode:
325
302
  * - **4C16G**
326
- *
327
303
  * - **8C32G**
328
304
  *
329
- * > This parameter is required for instances in elastic storage mode or serverless mode.
305
+ * > This parameter is required when you create a storage elastic mode instance or a Serverless mode instance.
330
306
  *
331
307
  * @example
332
308
  * 2C16G
@@ -334,15 +310,11 @@ export class CreateDBInstanceRequest extends $dara.Model {
334
310
  instanceSpec?: string;
335
311
  /**
336
312
  * @remarks
337
- * Use this parameter to configure the coordinator node as a MasterAI node.
338
- *
339
- * > - This parameter and `MasterCU` are mutually exclusive.
340
- * >
341
- * > - This feature is available only in some regions and zones.
342
- * >
343
- * > - MasterAI nodes are supported only for AnalyticDB for PostgreSQL V7.0 Basic Edition instances.
344
- * >
345
- * > - For a list of all possible values, see the coordinator node specification change page in the console.
313
+ * Specify this parameter if you want to change the master node to a MasterAI node.
314
+ * > - This parameter and MasterCU cannot be specified at the same time.
315
+ * > - Only specific regions and zones support changing the master node to a MasterAI node.
316
+ * > - Only basic edition instances of AnalyticDB for PostgreSQL 7.0 support MasterAI nodes.
317
+ * > - You can view all valid values of this parameter on the specification change page for the master node.
346
318
  *
347
319
  * @example
348
320
  * ADB.AIMedium.2
@@ -350,19 +322,13 @@ export class CreateDBInstanceRequest extends $dara.Model {
350
322
  masterAISpec?: string;
351
323
  /**
352
324
  * @remarks
353
- * The resources for the coordinator node. Valid values:
354
- *
355
- * - 2 CU
356
- *
357
- * - 4 CU
358
- *
359
- * - 8 CU
360
- *
361
- * - 16 CU
362
- *
363
- * - 32 CU
364
- *
365
- * > You are charged for coordinator node resources of 8 CUs or more.
325
+ * The master resources. Valid values:
326
+ * - 2 CU
327
+ * - 4 CU
328
+ * - 8 CU
329
+ * - 16 CU
330
+ * - 32 CU
331
+ * > Master resources above 8 CU incur additional fees.
366
332
  *
367
333
  * @example
368
334
  * 8 CU
@@ -370,7 +336,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
370
336
  masterCU?: number;
371
337
  /**
372
338
  * @remarks
373
- * This parameter is deprecated.
339
+ * **[Deprecated]** This parameter is deprecated. You do not need to specify this parameter.
374
340
  *
375
341
  * @example
376
342
  * null
@@ -379,15 +345,13 @@ export class CreateDBInstanceRequest extends $dara.Model {
379
345
  ownerId?: number;
380
346
  /**
381
347
  * @remarks
382
- * The billing method for the instance. Valid values:
348
+ * The billing method. Valid values:
383
349
  *
384
350
  * - **Postpaid**: pay-as-you-go.
385
- *
386
351
  * - **Prepaid**: subscription.
387
352
  *
388
- * > * If this parameter is not specified, the default billing method is pay-as-you-go.
389
- * >
390
- * > * Discounts are available for subscriptions of one year or longer. Select a billing method based on your business needs.
353
+ * > - If you do not specify this parameter, the default value is pay-as-you-go.
354
+ * > - Discounts are available for subscription instances when you purchase them for one year or longer. Select a billing method based on your business requirements.
391
355
  *
392
356
  * @example
393
357
  * Prepaid
@@ -396,12 +360,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
396
360
  /**
397
361
  * @remarks
398
362
  * The unit of the subscription duration. Valid values:
363
+ * - **Month**: month.
364
+ * - **Year**: year.
399
365
  *
400
- * - **Month**
401
- *
402
- * - **Year**
403
- *
404
- * > This parameter is required for subscription instances.
366
+ * > This parameter is required when you create a subscription instance.
405
367
  *
406
368
  * @example
407
369
  * Month
@@ -409,7 +371,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
409
371
  period?: string;
410
372
  /**
411
373
  * @remarks
412
- * This parameter is deprecated.
374
+ * **[Deprecated]** This parameter is deprecated. You do not need to specify this parameter.
413
375
  *
414
376
  * @example
415
377
  * null
@@ -418,12 +380,10 @@ export class CreateDBInstanceRequest extends $dara.Model {
418
380
  /**
419
381
  * @remarks
420
382
  * The product type. Valid values:
421
- *
422
383
  * - **standard**: Standard Edition.
384
+ * - **cost-effective**: Economy Edition.
423
385
  *
424
- * - **cost-effective**: Cost-effective Edition.
425
- *
426
- * > If this parameter is not specified, the default value is standard.
386
+ * > If you do not specify this parameter, the default value is Standard Edition.
427
387
  *
428
388
  * @example
429
389
  * standard
@@ -431,9 +391,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
431
391
  prodType?: string;
432
392
  /**
433
393
  * @remarks
434
- * The ID of the region for the instance.
394
+ * The region ID.
435
395
  *
436
- * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the IDs of available regions.
396
+ * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query available region IDs.
437
397
  *
438
398
  * This parameter is required.
439
399
  *
@@ -443,7 +403,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
443
403
  regionId?: string;
444
404
  /**
445
405
  * @remarks
446
- * The ID of the resource group for the instance.
406
+ * The ID of the enterprise resource group to which the instance belongs.
447
407
  *
448
408
  * @example
449
409
  * rg-bp67acfmxazb4p****
@@ -451,9 +411,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
451
411
  resourceGroupId?: string;
452
412
  /**
453
413
  * @remarks
454
- * The IP address whitelist for the instance.
414
+ * The IP address whitelist.
455
415
  *
456
- * A value of 127.0.0.1 blocks all external access. After you create the instance, you can call the [ModifySecurityIps](https://help.aliyun.com/document_detail/86928.html) operation to modify the IP address whitelist.
416
+ * A value of 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. After the instance is created, you can call the [ModifySecurityIps](https://help.aliyun.com/document_detail/86928.html) operation to modify the IP address whitelist.
457
417
  *
458
418
  * @example
459
419
  * 127.0.0.1
@@ -461,17 +421,14 @@ export class CreateDBInstanceRequest extends $dara.Model {
461
421
  securityIPList?: string;
462
422
  /**
463
423
  * @remarks
464
- * The performance level of the ESSDs. Valid values:
465
- *
466
- * - **pl0**: PL0
424
+ * The performance level (PL) of the ESSD cloud disk. Valid values:
467
425
  *
468
- * - **pl1**: PL1
426
+ * - **pl0**: PL0.
427
+ * - **pl1**: PL1.
428
+ * - **pl2**: PL2.
469
429
  *
470
- * - **pl2**: PL2
471
- *
472
- * > * This parameter applies only if the segment node storage type is ESSD.
473
- * >
474
- * > * If this parameter is not specified, pl1 is used by default.
430
+ * > - This parameter takes effect only when the cloud disk storage type is ESSD cloud disk.
431
+ * > - If you do not specify this parameter, the default value is PL1.
475
432
  *
476
433
  * @example
477
434
  * pl1
@@ -481,13 +438,11 @@ export class CreateDBInstanceRequest extends $dara.Model {
481
438
  * @remarks
482
439
  * The number of compute nodes. Valid values:
483
440
  *
484
- * - For a High-availability Edition instance in elastic storage mode, the value must be a multiple of 4, from 4 to 512.
485
- *
486
- * - For a Basic Edition instance in elastic storage mode, the value must be a multiple of 2, from 2 to 512.
487
- *
488
- * - For a serverless instance, the value must be a multiple of 2, from 2 to 512.
441
+ * - Storage elastic mode (high-availability edition): 4 to 512. The value must be a multiple of 4.
442
+ * - Storage elastic mode (basic edition): 2 to 512. The value must be a multiple of 2.
443
+ * - Serverless mode: 2 to 512. The value must be a multiple of 2.
489
444
  *
490
- * > This parameter is required for instances in elastic storage mode or serverless mode.
445
+ * > This parameter is required when you create a storage elastic mode instance or a Serverless mode instance.
491
446
  *
492
447
  * @example
493
448
  * 4
@@ -495,9 +450,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
495
450
  segNodeNum?: string;
496
451
  /**
497
452
  * @remarks
498
- * The storage type for the segment nodes. Only ESSDs are supported. Set the value to **cloud_essd**.
453
+ * The cloud disk storage type. Currently, only ESSD cloud disks are supported. Set the value to **cloud_essd**.
499
454
  *
500
- * > This parameter is required for instances in elastic storage mode.
455
+ * > This parameter is required when you create a storage elastic mode instance.
501
456
  *
502
457
  * @example
503
458
  * cloud_essd
@@ -505,15 +460,13 @@ export class CreateDBInstanceRequest extends $dara.Model {
505
460
  segStorageType?: string;
506
461
  /**
507
462
  * @remarks
508
- * The mode of the serverless instance. Valid values:
463
+ * The mode of the Serverless instance. Valid values:
509
464
  *
510
465
  * - **Manual**: manual scheduling. This is the default value.
466
+ * - **Auto**: automatic scheduling.
511
467
  *
512
- * - **Auto**: auto-scheduling.
513
- *
514
- * > * This parameter is required only for instances in serverless mode.
515
- * >
516
- * > * Auto-scheduling for AnalyticDB for PostgreSQL instances in serverless mode is in preview. To use this feature, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?product=rds) to be added to the whitelist.
468
+ * > - This parameter is required only for Serverless mode instances.
469
+ * > - The automatic scheduling mode for AnalyticDB for PostgreSQL Serverless is in invitational preview. To use this feature, [submit a ticket](https://smartservice.console.aliyun.com/service/create-ticket?product=rds) to apply for access.
517
470
  *
518
471
  * @example
519
472
  * Auto
@@ -521,19 +474,19 @@ export class CreateDBInstanceRequest extends $dara.Model {
521
474
  serverlessMode?: string;
522
475
  /**
523
476
  * @remarks
524
- * The threshold for computing resources, in AnalyticDB Compute Units (ACUs). The value must be a multiple of 8, ranging from 8 to 32. The default value is 32.
477
+ * The compute resource threshold. Valid values: 16 to 1024. The step size is 8. Unit: ACU.
525
478
  *
526
- * > This parameter is required only for serverless instances that use auto-scheduling.
479
+ * > This parameter is required only for Serverless instances in automatic scheduling mode.
527
480
  *
528
481
  * @example
529
- * 32
482
+ * 16
530
483
  */
531
484
  serverlessResource?: number;
532
485
  /**
533
486
  * @remarks
534
- * The ID of the source instance to be cloned.
487
+ * The ID of the source instance to clone.
535
488
  *
536
- * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in the destination region, including instance IDs.
489
+ * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in the target region, including instance IDs.
537
490
  *
538
491
  * @example
539
492
  * gp-bp***************
@@ -541,11 +494,11 @@ export class CreateDBInstanceRequest extends $dara.Model {
541
494
  srcDbInstanceName?: string;
542
495
  /**
543
496
  * @remarks
544
- * The ID of the vSwitch in the standby zone.
497
+ * The vSwitch ID in the secondary zone.
545
498
  *
546
- * > - This parameter is required only for a multi-AZ deployment.
547
- * >
548
- * > - The vSwitch must be in the standby zone specified in `StandbyZoneId`.
499
+ * >
500
+ * > - This parameter is required only for multi-zone deployment.
501
+ * > - The vSwitch must be in the same zone as the value specified by StandbyZoneId.
549
502
  *
550
503
  * @example
551
504
  * vsw-bp1cpq8mr64paltkb****
@@ -553,13 +506,12 @@ export class CreateDBInstanceRequest extends $dara.Model {
553
506
  standbyVSwitchId?: string;
554
507
  /**
555
508
  * @remarks
556
- * The ID of the standby zone.
509
+ * The secondary zone ID.
557
510
  *
558
- * > - This parameter is required only for a multi-AZ deployment.
559
- * >
560
- * > - You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the IDs of available zones.
561
- * >
562
- * > - The standby zone must be different from the primary zone.
511
+ * >
512
+ * > - This parameter is required only for multi-zone deployment.
513
+ * > - You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query available zone IDs.
514
+ * > - The secondary zone ID must be different from the primary zone ID.
563
515
  *
564
516
  * @example
565
517
  * cn-hangzhou-j
@@ -567,9 +519,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
567
519
  standbyZoneId?: string;
568
520
  /**
569
521
  * @remarks
570
- * The storage capacity for the instance, in GB. Valid values: <props="china">50 to 8000<props="intl">50 to 6000.
522
+ * The storage capacity. Unit: GB. Valid values: <props="china">50 to 8000<props="intl">50 to 6000.
571
523
  *
572
- * > This parameter is required for instances in elastic storage mode.
524
+ * > This parameter is required when you create a storage elastic mode instance.
573
525
  *
574
526
  * @example
575
527
  * 200
@@ -577,7 +529,7 @@ export class CreateDBInstanceRequest extends $dara.Model {
577
529
  storageSize?: number;
578
530
  /**
579
531
  * @remarks
580
- * This parameter is deprecated.
532
+ * **[Deprecated]** This parameter is deprecated. You do not need to specify this parameter.
581
533
  *
582
534
  * @example
583
535
  * null
@@ -585,18 +537,16 @@ export class CreateDBInstanceRequest extends $dara.Model {
585
537
  storageType?: string;
586
538
  /**
587
539
  * @remarks
588
- * The tags to add to the instance. You can add up to 20 tags.
540
+ * The Nth tag. Valid values of N: 1 to 20.
589
541
  */
590
542
  tag?: CreateDBInstanceRequestTag[];
591
543
  /**
592
544
  * @remarks
593
545
  * The subscription duration. Valid values:
546
+ * - If **Period** is set to **Month**, valid values are 1 to 9.
547
+ * - If **Period** is set to **Year**, valid values are 1 to 3.
594
548
  *
595
- * - If **Period** is **Month**, the value can be an integer from 1 to 9.
596
- *
597
- * - If **Period** is **Year**, the value can be an integer from 1 to 3.
598
- *
599
- * > This parameter is required for subscription instances.
549
+ * > This parameter is required when you create a subscription instance.
600
550
  *
601
551
  * @example
602
552
  * 1
@@ -606,9 +556,8 @@ export class CreateDBInstanceRequest extends $dara.Model {
606
556
  * @remarks
607
557
  * The VPC ID.
608
558
  *
609
- * > - This parameter is required.
610
- * >
611
- * > - The VPC must be in the region specified by `RegionId`.
559
+ * > - **VPCId** is required.
560
+ * > - The VPC must be in the same region as the value specified by **RegionId**.
612
561
  *
613
562
  * @example
614
563
  * vpc-bp19ame5m1r3oejns****
@@ -618,9 +567,8 @@ export class CreateDBInstanceRequest extends $dara.Model {
618
567
  * @remarks
619
568
  * The vSwitch ID.
620
569
  *
621
- * > - This parameter is required.
622
- * >
623
- * > - The vSwitch must be in the zone specified by `ZoneId`.
570
+ * > - **vSwitchId** is required.
571
+ * > - The vSwitch must be in the same zone as the value specified by **ZoneId**.
624
572
  *
625
573
  * @example
626
574
  * vsw-bp1cpq8mr64paltkb****
@@ -629,14 +577,11 @@ export class CreateDBInstanceRequest extends $dara.Model {
629
577
  /**
630
578
  * @remarks
631
579
  * Specifies whether to enable vector engine optimization. Valid values:
580
+ * - **enabled**: Enable vector engine optimization.
581
+ * - **disabled** (default): Do not enable vector engine optimization.
632
582
  *
633
- * - **enabled**: enables vector engine optimization.
634
- *
635
- * - **disabled** (default): disables vector engine optimization.
636
- *
637
- * > * For mainstream analytics, data warehousing, and real-time data warehousing scenarios, we recommend that you **disable** vector engine optimization.
638
- * >
639
- * > * For AIGC and vector search scenarios, we recommend that you **enable** vector engine optimization.
583
+ * > - For mainstream analytics, data warehousing, and real-time data warehouse scenarios, **do not enable** vector engine optimization.
584
+ * > - For scenarios that use the vector analysis engine for AIGC and AISearch, **enable** vector engine optimization.
640
585
  *
641
586
  * @example
642
587
  * enabled
@@ -644,9 +589,9 @@ export class CreateDBInstanceRequest extends $dara.Model {
644
589
  vectorConfigurationStatus?: string;
645
590
  /**
646
591
  * @remarks
647
- * The ID of the zone for the instance.
592
+ * The zone ID.
648
593
  *
649
- * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the IDs of available zones.
594
+ * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query available zone IDs.
650
595
  *
651
596
  * This parameter is required.
652
597
  *