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