@alicloud/polardb20170801 7.10.0 → 7.11.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 (56) hide show
  1. package/dist/client.d.ts +113 -26
  2. package/dist/client.js +191 -26
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/BindResourceControlRequest.d.ts +9 -9
  5. package/dist/models/CreateAidbclusterApiKeyRequest.d.ts +33 -0
  6. package/dist/models/CreateAidbclusterApiKeyRequest.js +60 -0
  7. package/dist/models/CreateAidbclusterApiKeyRequest.js.map +1 -0
  8. package/dist/models/CreateAidbclusterApiKeyResponse.d.ts +19 -0
  9. package/dist/models/CreateAidbclusterApiKeyResponse.js +69 -0
  10. package/dist/models/CreateAidbclusterApiKeyResponse.js.map +1 -0
  11. package/dist/models/CreateAidbclusterApiKeyResponseBody.d.ts +78 -0
  12. package/dist/models/CreateAidbclusterApiKeyResponseBody.js +90 -0
  13. package/dist/models/CreateAidbclusterApiKeyResponseBody.js.map +1 -0
  14. package/dist/models/CreateResourceControlRequest.d.ts +8 -8
  15. package/dist/models/DeleteAidbclusterApiKeyRequest.d.ts +34 -0
  16. package/dist/models/DeleteAidbclusterApiKeyRequest.js +60 -0
  17. package/dist/models/DeleteAidbclusterApiKeyRequest.js.map +1 -0
  18. package/dist/models/DeleteAidbclusterApiKeyResponse.d.ts +19 -0
  19. package/dist/models/DeleteAidbclusterApiKeyResponse.js +69 -0
  20. package/dist/models/DeleteAidbclusterApiKeyResponse.js.map +1 -0
  21. package/dist/models/DeleteAidbclusterApiKeyResponseBody.d.ts +29 -0
  22. package/dist/models/DeleteAidbclusterApiKeyResponseBody.js +60 -0
  23. package/dist/models/DeleteAidbclusterApiKeyResponseBody.js.map +1 -0
  24. package/dist/models/DeleteResourceControlRequest.d.ts +6 -5
  25. package/dist/models/DeleteResourceControlRequest.js.map +1 -1
  26. package/dist/models/DescribeAidbclusterApiKeysRequest.d.ts +23 -0
  27. package/dist/models/DescribeAidbclusterApiKeysRequest.js +58 -0
  28. package/dist/models/DescribeAidbclusterApiKeysRequest.js.map +1 -0
  29. package/dist/models/DescribeAidbclusterApiKeysResponse.d.ts +19 -0
  30. package/dist/models/DescribeAidbclusterApiKeysResponse.js +69 -0
  31. package/dist/models/DescribeAidbclusterApiKeysResponse.js.map +1 -0
  32. package/dist/models/DescribeAidbclusterApiKeysResponseBody.d.ts +78 -0
  33. package/dist/models/DescribeAidbclusterApiKeysResponseBody.js +90 -0
  34. package/dist/models/DescribeAidbclusterApiKeysResponseBody.js.map +1 -0
  35. package/dist/models/ModifyResourceControlRequest.d.ts +9 -9
  36. package/dist/models/UnbindResourceControlRequest.d.ts +11 -11
  37. package/dist/models/model.d.ts +11 -0
  38. package/dist/models/model.js +57 -35
  39. package/dist/models/model.js.map +1 -1
  40. package/package.json +1 -1
  41. package/src/client.ts +202 -26
  42. package/src/models/BindResourceControlRequest.ts +9 -9
  43. package/src/models/CreateAidbclusterApiKeyRequest.ts +48 -0
  44. package/src/models/CreateAidbclusterApiKeyResponse.ts +40 -0
  45. package/src/models/CreateAidbclusterApiKeyResponseBody.ts +114 -0
  46. package/src/models/CreateResourceControlRequest.ts +8 -8
  47. package/src/models/DeleteAidbclusterApiKeyRequest.ts +49 -0
  48. package/src/models/DeleteAidbclusterApiKeyResponse.ts +40 -0
  49. package/src/models/DeleteAidbclusterApiKeyResponseBody.ts +44 -0
  50. package/src/models/DeleteResourceControlRequest.ts +6 -5
  51. package/src/models/DescribeAidbclusterApiKeysRequest.ts +36 -0
  52. package/src/models/DescribeAidbclusterApiKeysResponse.ts +40 -0
  53. package/src/models/DescribeAidbclusterApiKeysResponseBody.ts +114 -0
  54. package/src/models/ModifyResourceControlRequest.ts +9 -9
  55. package/src/models/UnbindResourceControlRequest.ts +11 -11
  56. package/src/models/model.ts +11 -0
package/dist/client.d.ts CHANGED
@@ -232,11 +232,14 @@ export default class Client extends OpenApi {
232
232
  */
233
233
  bindPolarClawAgent(request: $_model.BindPolarClawAgentRequest): Promise<$_model.BindPolarClawAgentResponse>;
234
234
  /**
235
- * Associates resource control.
235
+ * Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL cluster. After the binding succeeds, the target object is subject to the CPU quota limit defined by the resource control rule.
236
236
  *
237
237
  * @remarks
238
- * ## Operation description
239
- * This API operation associates an agent (specified by `AgentId`) of PolarClaw (identified by `ApplicationId`) with a specified communication channel (`Channel`). You can also specify an account ID (`ChannelAccountId`) within the channel.
238
+ * Resource Control limits the CPU resources that can be used by specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
239
+ * ### Before you begin
240
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
241
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
242
+ * >Notice: This is a notice.</notice>
240
243
  *
241
244
  * @param request - BindResourceControlRequest
242
245
  * @param runtime - runtime options for this request RuntimeOptions
@@ -244,11 +247,14 @@ export default class Client extends OpenApi {
244
247
  */
245
248
  bindResourceControlWithOptions(request: $_model.BindResourceControlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BindResourceControlResponse>;
246
249
  /**
247
- * Associates resource control.
250
+ * Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL cluster. After the binding succeeds, the target object is subject to the CPU quota limit defined by the resource control rule.
248
251
  *
249
252
  * @remarks
250
- * ## Operation description
251
- * This API operation associates an agent (specified by `AgentId`) of PolarClaw (identified by `ApplicationId`) with a specified communication channel (`Channel`). You can also specify an account ID (`ChannelAccountId`) within the channel.
253
+ * Resource Control limits the CPU resources that can be used by specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
254
+ * ### Before you begin
255
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
256
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
257
+ * >Notice: This is a notice.</notice>
252
258
  *
253
259
  * @param request - BindResourceControlRequest
254
260
  * @returns BindResourceControlResponse
@@ -557,6 +563,21 @@ export default class Client extends OpenApi {
557
563
  * @returns CreateAIDBClusterResponse
558
564
  */
559
565
  createAIDBCluster(request: $_model.CreateAIDBClusterRequest): Promise<$_model.CreateAIDBClusterResponse>;
566
+ /**
567
+ * Creates a model service API key.
568
+ *
569
+ * @param request - CreateAIDBClusterApiKeyRequest
570
+ * @param runtime - runtime options for this request RuntimeOptions
571
+ * @returns CreateAIDBClusterApiKeyResponse
572
+ */
573
+ createAIDBClusterApiKeyWithOptions(request: $_model.CreateAIDBClusterApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAIDBClusterApiKeyResponse>;
574
+ /**
575
+ * Creates a model service API key.
576
+ *
577
+ * @param request - CreateAIDBClusterApiKeyRequest
578
+ * @returns CreateAIDBClusterApiKeyResponse
579
+ */
580
+ createAIDBClusterApiKey(request: $_model.CreateAIDBClusterApiKeyRequest): Promise<$_model.CreateAIDBClusterApiKeyResponse>;
560
581
  /**
561
582
  * Creates a dataset.
562
583
  *
@@ -1364,11 +1385,16 @@ export default class Client extends OpenApi {
1364
1385
  */
1365
1386
  createRateLimitPolicy(request: $_model.CreateRateLimitPolicyRequest): Promise<$_model.CreateRateLimitPolicyResponse>;
1366
1387
  /**
1367
- * Creates a resource control.
1388
+ * Creates a resource control rule for a specified PolarDB for MySQL cluster. You can set MaxCpu to specify the maximum CPU quota percentage that the rule can use, or set CpuCount to specify the maximum number of CPU cores that the rule can use. You must specify one and only one of MaxCpu and CpuCount when creating a rule.
1368
1389
  *
1369
1390
  * @remarks
1370
- * ## Operation description
1371
- * You can call this operation to define and create a cron job. The cron job is triggered periodically based on a specified schedule and carries specific messages or instructions. Advanced options such as custom execution frequency, time zone settings, and alert mechanisms for failures are supported. You can also configure the message content, target channel, and recipients.
1391
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
1392
+ * ### Before you begin
1393
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
1394
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
1395
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
1396
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
1397
+ * >Notice: This is a notice.</notice>
1372
1398
  *
1373
1399
  * @param request - CreateResourceControlRequest
1374
1400
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1376,11 +1402,16 @@ export default class Client extends OpenApi {
1376
1402
  */
1377
1403
  createResourceControlWithOptions(request: $_model.CreateResourceControlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateResourceControlResponse>;
1378
1404
  /**
1379
- * Creates a resource control.
1405
+ * Creates a resource control rule for a specified PolarDB for MySQL cluster. You can set MaxCpu to specify the maximum CPU quota percentage that the rule can use, or set CpuCount to specify the maximum number of CPU cores that the rule can use. You must specify one and only one of MaxCpu and CpuCount when creating a rule.
1380
1406
  *
1381
1407
  * @remarks
1382
- * ## Operation description
1383
- * You can call this operation to define and create a cron job. The cron job is triggered periodically based on a specified schedule and carries specific messages or instructions. Advanced options such as custom execution frequency, time zone settings, and alert mechanisms for failures are supported. You can also configure the message content, target channel, and recipients.
1408
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
1409
+ * ### Before you begin
1410
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
1411
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
1412
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
1413
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
1414
+ * >Notice: This is a notice.</notice>
1384
1415
  *
1385
1416
  * @param request - CreateResourceControlRequest
1386
1417
  * @returns CreateResourceControlResponse
@@ -1431,6 +1462,21 @@ export default class Client extends OpenApi {
1431
1462
  * @returns DeleteAIDBClusterResponse
1432
1463
  */
1433
1464
  deleteAIDBCluster(request: $_model.DeleteAIDBClusterRequest): Promise<$_model.DeleteAIDBClusterResponse>;
1465
+ /**
1466
+ * Deletes an API key for a model service.
1467
+ *
1468
+ * @param request - DeleteAIDBClusterApiKeyRequest
1469
+ * @param runtime - runtime options for this request RuntimeOptions
1470
+ * @returns DeleteAIDBClusterApiKeyResponse
1471
+ */
1472
+ deleteAIDBClusterApiKeyWithOptions(request: $_model.DeleteAIDBClusterApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAIDBClusterApiKeyResponse>;
1473
+ /**
1474
+ * Deletes an API key for a model service.
1475
+ *
1476
+ * @param request - DeleteAIDBClusterApiKeyRequest
1477
+ * @returns DeleteAIDBClusterApiKeyResponse
1478
+ */
1479
+ deleteAIDBClusterApiKey(request: $_model.DeleteAIDBClusterApiKeyRequest): Promise<$_model.DeleteAIDBClusterApiKeyResponse>;
1434
1480
  /**
1435
1481
  * Deletes a dataset.
1436
1482
  *
@@ -2214,10 +2260,14 @@ export default class Client extends OpenApi {
2214
2260
  */
2215
2261
  deleteRateLimitPolicy(request: $_model.DeleteRateLimitPolicyRequest): Promise<$_model.DeleteRateLimitPolicyResponse>;
2216
2262
  /**
2217
- * Deletes a resource control.
2263
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
2218
2264
  *
2219
2265
  * @remarks
2220
- * > The cluster must be in the Running state. Otherwise, the operation fails.
2266
+ * Resource Control is used to limit the CPU resources available to specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports the create, update, delete, attach, and detach operations for resource control rules. Querying Resource Control CPU usage is not supported.
2267
+ * ### Limits
2268
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
2269
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
2270
+ * >Notice: This is a notice.</notice>
2221
2271
  *
2222
2272
  * @param request - DeleteResourceControlRequest
2223
2273
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2225,10 +2275,14 @@ export default class Client extends OpenApi {
2225
2275
  */
2226
2276
  deleteResourceControlWithOptions(request: $_model.DeleteResourceControlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteResourceControlResponse>;
2227
2277
  /**
2228
- * Deletes a resource control.
2278
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
2229
2279
  *
2230
2280
  * @remarks
2231
- * > The cluster must be in the Running state. Otherwise, the operation fails.
2281
+ * Resource Control is used to limit the CPU resources available to specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports the create, update, delete, attach, and detach operations for resource control rules. Querying Resource Control CPU usage is not supported.
2282
+ * ### Limits
2283
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
2284
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
2285
+ * >Notice: This is a notice.</notice>
2232
2286
  *
2233
2287
  * @param request - DeleteResourceControlRequest
2234
2288
  * @returns DeleteResourceControlResponse
@@ -2249,6 +2303,21 @@ export default class Client extends OpenApi {
2249
2303
  * @returns DeleteSQLRateLimitingRulesResponse
2250
2304
  */
2251
2305
  deleteSQLRateLimitingRules(request: $_model.DeleteSQLRateLimitingRulesRequest): Promise<$_model.DeleteSQLRateLimitingRulesResponse>;
2306
+ /**
2307
+ * Queries the API key of a model service.
2308
+ *
2309
+ * @param request - DescribeAIDBClusterApiKeysRequest
2310
+ * @param runtime - runtime options for this request RuntimeOptions
2311
+ * @returns DescribeAIDBClusterApiKeysResponse
2312
+ */
2313
+ describeAIDBClusterApiKeysWithOptions(request: $_model.DescribeAIDBClusterApiKeysRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAIDBClusterApiKeysResponse>;
2314
+ /**
2315
+ * Queries the API key of a model service.
2316
+ *
2317
+ * @param request - DescribeAIDBClusterApiKeysRequest
2318
+ * @returns DescribeAIDBClusterApiKeysResponse
2319
+ */
2320
+ describeAIDBClusterApiKeys(request: $_model.DescribeAIDBClusterApiKeysRequest): Promise<$_model.DescribeAIDBClusterApiKeysResponse>;
2252
2321
  /**
2253
2322
  * Queries the details of a custom instance.
2254
2323
  *
@@ -6474,10 +6543,16 @@ export default class Client extends OpenApi {
6474
6543
  */
6475
6544
  modifyRateLimitPolicy(request: $_model.ModifyRateLimitPolicyRequest): Promise<$_model.ModifyRateLimitPolicyResponse>;
6476
6545
  /**
6477
- * Modifies resource control.
6546
+ * Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters.
6478
6547
  *
6479
6548
  * @remarks
6480
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
6549
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. It does not support querying Resource Control CPU usage.
6550
+ * ### Before you begin
6551
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
6552
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
6553
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
6554
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
6555
+ * >Notice: This is a notice.</notice>
6481
6556
  *
6482
6557
  * @param request - ModifyResourceControlRequest
6483
6558
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6485,10 +6560,16 @@ export default class Client extends OpenApi {
6485
6560
  */
6486
6561
  modifyResourceControlWithOptions(request: $_model.ModifyResourceControlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyResourceControlResponse>;
6487
6562
  /**
6488
- * Modifies resource control.
6563
+ * Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters.
6489
6564
  *
6490
6565
  * @remarks
6491
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
6566
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. It does not support querying Resource Control CPU usage.
6567
+ * ### Before you begin
6568
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
6569
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
6570
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
6571
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
6572
+ * >Notice: This is a notice.</notice>
6492
6573
  *
6493
6574
  * @param request - ModifyResourceControlRequest
6494
6575
  * @returns ModifyResourceControlResponse
@@ -7094,11 +7175,14 @@ export default class Client extends OpenApi {
7094
7175
  */
7095
7176
  unbindPolarClawAgent(request: $_model.UnbindPolarClawAgentRequest): Promise<$_model.UnbindPolarClawAgentResponse>;
7096
7177
  /**
7097
- * Unbinds a resource control.
7178
+ * Unbinds a specified resource control rule from a user, database, query, or connection in a PolarDB for MySQL cluster. After the unbinding is successful, the resource control rule no longer limits the CPU quota of the corresponding target object.
7098
7179
  *
7099
7180
  * @remarks
7100
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
7101
- * > * If the privileged user encounters issues, such as permissions being unexpectedly revoked (REVOKE), you can reset the permissions of the privileged user to restore it to normal.
7181
+ * Resource Control is used to limit the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release provides the capabilities to create, modify, delete, attach, and unbind resource control rules. It does not provide the capability to query Resource Control CPU usage.
7182
+ * ### Before you begin
7183
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
7184
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
7185
+ * >Notice: This is a notice.</notice>
7102
7186
  *
7103
7187
  * @param request - UnbindResourceControlRequest
7104
7188
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7106,11 +7190,14 @@ export default class Client extends OpenApi {
7106
7190
  */
7107
7191
  unbindResourceControlWithOptions(request: $_model.UnbindResourceControlRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UnbindResourceControlResponse>;
7108
7192
  /**
7109
- * Unbinds a resource control.
7193
+ * Unbinds a specified resource control rule from a user, database, query, or connection in a PolarDB for MySQL cluster. After the unbinding is successful, the resource control rule no longer limits the CPU quota of the corresponding target object.
7110
7194
  *
7111
7195
  * @remarks
7112
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
7113
- * > * If the privileged user encounters issues, such as permissions being unexpectedly revoked (REVOKE), you can reset the permissions of the privileged user to restore it to normal.
7196
+ * Resource Control is used to limit the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release provides the capabilities to create, modify, delete, attach, and unbind resource control rules. It does not provide the capability to query Resource Control CPU usage.
7197
+ * ### Before you begin
7198
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
7199
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
7200
+ * >Notice: This is a notice.</notice>
7114
7201
  *
7115
7202
  * @param request - UnbindResourceControlRequest
7116
7203
  * @returns UnbindResourceControlResponse
package/dist/client.js CHANGED
@@ -764,11 +764,14 @@ class Client extends openapi_core_1.default {
764
764
  return await this.bindPolarClawAgentWithOptions(request, runtime);
765
765
  }
766
766
  /**
767
- * Associates resource control.
767
+ * Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL cluster. After the binding succeeds, the target object is subject to the CPU quota limit defined by the resource control rule.
768
768
  *
769
769
  * @remarks
770
- * ## Operation description
771
- * This API operation associates an agent (specified by `AgentId`) of PolarClaw (identified by `ApplicationId`) with a specified communication channel (`Channel`). You can also specify an account ID (`ChannelAccountId`) within the channel.
770
+ * Resource Control limits the CPU resources that can be used by specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
771
+ * ### Before you begin
772
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
773
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
774
+ * >Notice: This is a notice.</notice>
772
775
  *
773
776
  * @param request - BindResourceControlRequest
774
777
  * @param runtime - runtime options for this request RuntimeOptions
@@ -809,11 +812,14 @@ class Client extends openapi_core_1.default {
809
812
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.BindResourceControlResponse({}));
810
813
  }
811
814
  /**
812
- * Associates resource control.
815
+ * Binds a specified resource control rule to a user, database, query, or connection in a PolarDB for MySQL cluster. After the binding succeeds, the target object is subject to the CPU quota limit defined by the resource control rule.
813
816
  *
814
817
  * @remarks
815
- * ## Operation description
816
- * This API operation associates an agent (specified by `AgentId`) of PolarClaw (identified by `ApplicationId`) with a specified communication channel (`Channel`). You can also specify an account ID (`ChannelAccountId`) within the channel.
818
+ * Resource Control limits the CPU resources that can be used by specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
819
+ * ### Before you begin
820
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
821
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
822
+ * >Notice: This is a notice.</notice>
817
823
  *
818
824
  * @param request - BindResourceControlRequest
819
825
  * @returns BindResourceControlResponse
@@ -1863,6 +1869,48 @@ class Client extends openapi_core_1.default {
1863
1869
  let runtime = new $dara.RuntimeOptions({});
1864
1870
  return await this.createAIDBClusterWithOptions(request, runtime);
1865
1871
  }
1872
+ /**
1873
+ * Creates a model service API key.
1874
+ *
1875
+ * @param request - CreateAIDBClusterApiKeyRequest
1876
+ * @param runtime - runtime options for this request RuntimeOptions
1877
+ * @returns CreateAIDBClusterApiKeyResponse
1878
+ */
1879
+ async createAIDBClusterApiKeyWithOptions(request, runtime) {
1880
+ request.validate();
1881
+ let query = {};
1882
+ if (!$dara.isNull(request.description)) {
1883
+ query["Description"] = request.description;
1884
+ }
1885
+ if (!$dara.isNull(request.regionId)) {
1886
+ query["RegionId"] = request.regionId;
1887
+ }
1888
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
1889
+ query: openapi_core_2.OpenApiUtil.query(query),
1890
+ });
1891
+ let params = new openapi_core_2.$OpenApiUtil.Params({
1892
+ action: "CreateAIDBClusterApiKey",
1893
+ version: "2017-08-01",
1894
+ protocol: "HTTPS",
1895
+ pathname: "/",
1896
+ method: "POST",
1897
+ authType: "AK",
1898
+ style: "RPC",
1899
+ reqBodyType: "formData",
1900
+ bodyType: "json",
1901
+ });
1902
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateAIDBClusterApiKeyResponse({}));
1903
+ }
1904
+ /**
1905
+ * Creates a model service API key.
1906
+ *
1907
+ * @param request - CreateAIDBClusterApiKeyRequest
1908
+ * @returns CreateAIDBClusterApiKeyResponse
1909
+ */
1910
+ async createAIDBClusterApiKey(request) {
1911
+ let runtime = new $dara.RuntimeOptions({});
1912
+ return await this.createAIDBClusterApiKeyWithOptions(request, runtime);
1913
+ }
1866
1914
  /**
1867
1915
  * Creates a dataset.
1868
1916
  *
@@ -5246,11 +5294,16 @@ class Client extends openapi_core_1.default {
5246
5294
  return await this.createRateLimitPolicyWithOptions(request, runtime);
5247
5295
  }
5248
5296
  /**
5249
- * Creates a resource control.
5297
+ * Creates a resource control rule for a specified PolarDB for MySQL cluster. You can set MaxCpu to specify the maximum CPU quota percentage that the rule can use, or set CpuCount to specify the maximum number of CPU cores that the rule can use. You must specify one and only one of MaxCpu and CpuCount when creating a rule.
5250
5298
  *
5251
5299
  * @remarks
5252
- * ## Operation description
5253
- * You can call this operation to define and create a cron job. The cron job is triggered periodically based on a specified schedule and carries specific messages or instructions. Advanced options such as custom execution frequency, time zone settings, and alert mechanisms for failures are supported. You can also configure the message content, target channel, and recipients.
5300
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
5301
+ * ### Before you begin
5302
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
5303
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
5304
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
5305
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
5306
+ * >Notice: This is a notice.</notice>
5254
5307
  *
5255
5308
  * @param request - CreateResourceControlRequest
5256
5309
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5291,11 +5344,16 @@ class Client extends openapi_core_1.default {
5291
5344
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateResourceControlResponse({}));
5292
5345
  }
5293
5346
  /**
5294
- * Creates a resource control.
5347
+ * Creates a resource control rule for a specified PolarDB for MySQL cluster. You can set MaxCpu to specify the maximum CPU quota percentage that the rule can use, or set CpuCount to specify the maximum number of CPU cores that the rule can use. You must specify one and only one of MaxCpu and CpuCount when creating a rule.
5295
5348
  *
5296
5349
  * @remarks
5297
- * ## Operation description
5298
- * You can call this operation to define and create a cron job. The cron job is triggered periodically based on a specified schedule and carries specific messages or instructions. Advanced options such as custom execution frequency, time zone settings, and alert mechanisms for failures are supported. You can also configure the message content, target channel, and recipients.
5350
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. Querying Resource Control CPU usage is not supported.
5351
+ * ### Before you begin
5352
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
5353
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
5354
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
5355
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
5356
+ * >Notice: This is a notice.</notice>
5299
5357
  *
5300
5358
  * @param request - CreateResourceControlRequest
5301
5359
  * @returns CreateResourceControlResponse
@@ -5460,6 +5518,48 @@ class Client extends openapi_core_1.default {
5460
5518
  let runtime = new $dara.RuntimeOptions({});
5461
5519
  return await this.deleteAIDBClusterWithOptions(request, runtime);
5462
5520
  }
5521
+ /**
5522
+ * Deletes an API key for a model service.
5523
+ *
5524
+ * @param request - DeleteAIDBClusterApiKeyRequest
5525
+ * @param runtime - runtime options for this request RuntimeOptions
5526
+ * @returns DeleteAIDBClusterApiKeyResponse
5527
+ */
5528
+ async deleteAIDBClusterApiKeyWithOptions(request, runtime) {
5529
+ request.validate();
5530
+ let query = {};
5531
+ if (!$dara.isNull(request.apiKey)) {
5532
+ query["ApiKey"] = request.apiKey;
5533
+ }
5534
+ if (!$dara.isNull(request.regionId)) {
5535
+ query["RegionId"] = request.regionId;
5536
+ }
5537
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
5538
+ query: openapi_core_2.OpenApiUtil.query(query),
5539
+ });
5540
+ let params = new openapi_core_2.$OpenApiUtil.Params({
5541
+ action: "DeleteAIDBClusterApiKey",
5542
+ version: "2017-08-01",
5543
+ protocol: "HTTPS",
5544
+ pathname: "/",
5545
+ method: "POST",
5546
+ authType: "AK",
5547
+ style: "RPC",
5548
+ reqBodyType: "formData",
5549
+ bodyType: "json",
5550
+ });
5551
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteAIDBClusterApiKeyResponse({}));
5552
+ }
5553
+ /**
5554
+ * Deletes an API key for a model service.
5555
+ *
5556
+ * @param request - DeleteAIDBClusterApiKeyRequest
5557
+ * @returns DeleteAIDBClusterApiKeyResponse
5558
+ */
5559
+ async deleteAIDBClusterApiKey(request) {
5560
+ let runtime = new $dara.RuntimeOptions({});
5561
+ return await this.deleteAIDBClusterApiKeyWithOptions(request, runtime);
5562
+ }
5463
5563
  /**
5464
5564
  * Deletes a dataset.
5465
5565
  *
@@ -7811,10 +7911,14 @@ class Client extends openapi_core_1.default {
7811
7911
  return await this.deleteRateLimitPolicyWithOptions(request, runtime);
7812
7912
  }
7813
7913
  /**
7814
- * Deletes a resource control.
7914
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
7815
7915
  *
7816
7916
  * @remarks
7817
- * > The cluster must be in the Running state. Otherwise, the operation fails.
7917
+ * Resource Control is used to limit the CPU resources available to specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports the create, update, delete, attach, and detach operations for resource control rules. Querying Resource Control CPU usage is not supported.
7918
+ * ### Limits
7919
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
7920
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
7921
+ * >Notice: This is a notice.</notice>
7818
7922
  *
7819
7923
  * @param request - DeleteResourceControlRequest
7820
7924
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7849,10 +7953,14 @@ class Client extends openapi_core_1.default {
7849
7953
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteResourceControlResponse({}));
7850
7954
  }
7851
7955
  /**
7852
- * Deletes a resource control.
7956
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
7853
7957
  *
7854
7958
  * @remarks
7855
- * > The cluster must be in the Running state. Otherwise, the operation fails.
7959
+ * Resource Control is used to limit the CPU resources available to specified users, databases, queries, or connections in a PolarDB for MySQL cluster. This release supports the create, update, delete, attach, and detach operations for resource control rules. Querying Resource Control CPU usage is not supported.
7960
+ * ### Limits
7961
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
7962
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
7963
+ * >Notice: This is a notice.</notice>
7856
7964
  *
7857
7965
  * @param request - DeleteResourceControlRequest
7858
7966
  * @returns DeleteResourceControlResponse
@@ -7915,6 +8023,45 @@ class Client extends openapi_core_1.default {
7915
8023
  let runtime = new $dara.RuntimeOptions({});
7916
8024
  return await this.deleteSQLRateLimitingRulesWithOptions(request, runtime);
7917
8025
  }
8026
+ /**
8027
+ * Queries the API key of a model service.
8028
+ *
8029
+ * @param request - DescribeAIDBClusterApiKeysRequest
8030
+ * @param runtime - runtime options for this request RuntimeOptions
8031
+ * @returns DescribeAIDBClusterApiKeysResponse
8032
+ */
8033
+ async describeAIDBClusterApiKeysWithOptions(request, runtime) {
8034
+ request.validate();
8035
+ let query = {};
8036
+ if (!$dara.isNull(request.regionId)) {
8037
+ query["RegionId"] = request.regionId;
8038
+ }
8039
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
8040
+ query: openapi_core_2.OpenApiUtil.query(query),
8041
+ });
8042
+ let params = new openapi_core_2.$OpenApiUtil.Params({
8043
+ action: "DescribeAIDBClusterApiKeys",
8044
+ version: "2017-08-01",
8045
+ protocol: "HTTPS",
8046
+ pathname: "/",
8047
+ method: "POST",
8048
+ authType: "AK",
8049
+ style: "RPC",
8050
+ reqBodyType: "formData",
8051
+ bodyType: "json",
8052
+ });
8053
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAIDBClusterApiKeysResponse({}));
8054
+ }
8055
+ /**
8056
+ * Queries the API key of a model service.
8057
+ *
8058
+ * @param request - DescribeAIDBClusterApiKeysRequest
8059
+ * @returns DescribeAIDBClusterApiKeysResponse
8060
+ */
8061
+ async describeAIDBClusterApiKeys(request) {
8062
+ let runtime = new $dara.RuntimeOptions({});
8063
+ return await this.describeAIDBClusterApiKeysWithOptions(request, runtime);
8064
+ }
7918
8065
  /**
7919
8066
  * Queries the details of a custom instance.
7920
8067
  *
@@ -23411,10 +23558,16 @@ class Client extends openapi_core_1.default {
23411
23558
  return await this.modifyRateLimitPolicyWithOptions(request, runtime);
23412
23559
  }
23413
23560
  /**
23414
- * Modifies resource control.
23561
+ * Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters.
23415
23562
  *
23416
23563
  * @remarks
23417
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
23564
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. It does not support querying Resource Control CPU usage.
23565
+ * ### Before you begin
23566
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
23567
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
23568
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
23569
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
23570
+ * >Notice: This is a notice.</notice>
23418
23571
  *
23419
23572
  * @param request - ModifyResourceControlRequest
23420
23573
  * @param runtime - runtime options for this request RuntimeOptions
@@ -23455,10 +23608,16 @@ class Client extends openapi_core_1.default {
23455
23608
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyResourceControlResponse({}));
23456
23609
  }
23457
23610
  /**
23458
- * Modifies resource control.
23611
+ * Modifies the CPU quota of an existing resource control rule in a specified PolarDB for MySQL cluster. You can modify the current quota value or switch between the maximum CPU percentage mode and the maximum CPU core count mode. You must specify one and only one of the MaxCpu and CpuCount parameters.
23459
23612
  *
23460
23613
  * @remarks
23461
- * > You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see [Backup settings](https://help.aliyun.com/document_detail/280422.html).
23614
+ * Resource Control limits the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release supports creating, modifying, deleting, binding, and unbinding resource control rules. It does not support querying Resource Control CPU usage.
23615
+ * ### Before you begin
23616
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
23617
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
23618
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
23619
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
23620
+ * >Notice: This is a notice.</notice>
23462
23621
  *
23463
23622
  * @param request - ModifyResourceControlRequest
23464
23623
  * @returns ModifyResourceControlResponse
@@ -25481,11 +25640,14 @@ class Client extends openapi_core_1.default {
25481
25640
  return await this.unbindPolarClawAgentWithOptions(request, runtime);
25482
25641
  }
25483
25642
  /**
25484
- * Unbinds a resource control.
25643
+ * Unbinds a specified resource control rule from a user, database, query, or connection in a PolarDB for MySQL cluster. After the unbinding is successful, the resource control rule no longer limits the CPU quota of the corresponding target object.
25485
25644
  *
25486
25645
  * @remarks
25487
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
25488
- * > * If the privileged user encounters issues, such as permissions being unexpectedly revoked (REVOKE), you can reset the permissions of the privileged user to restore it to normal.
25646
+ * Resource Control is used to limit the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release provides the capabilities to create, modify, delete, attach, and unbind resource control rules. It does not provide the capability to query Resource Control CPU usage.
25647
+ * ### Before you begin
25648
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
25649
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
25650
+ * >Notice: This is a notice.</notice>
25489
25651
  *
25490
25652
  * @param request - UnbindResourceControlRequest
25491
25653
  * @param runtime - runtime options for this request RuntimeOptions
@@ -25526,11 +25688,14 @@ class Client extends openapi_core_1.default {
25526
25688
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UnbindResourceControlResponse({}));
25527
25689
  }
25528
25690
  /**
25529
- * Unbinds a resource control.
25691
+ * Unbinds a specified resource control rule from a user, database, query, or connection in a PolarDB for MySQL cluster. After the unbinding is successful, the resource control rule no longer limits the CPU quota of the corresponding target object.
25530
25692
  *
25531
25693
  * @remarks
25532
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
25533
- * > * If the privileged user encounters issues, such as permissions being unexpectedly revoked (REVOKE), you can reset the permissions of the privileged user to restore it to normal.
25694
+ * Resource Control is used to limit the CPU resources that can be used by a specified user, database, query, or connection in a PolarDB for MySQL cluster. This release provides the capabilities to create, modify, delete, attach, and unbind resource control rules. It does not provide the capability to query Resource Control CPU usage.
25695
+ * ### Before you begin
25696
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
25697
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
25698
+ * >Notice: This is a notice.</notice>
25534
25699
  *
25535
25700
  * @param request - UnbindResourceControlRequest
25536
25701
  * @returns UnbindResourceControlResponse