@alicloud/polardb20170801 7.10.0 → 7.11.1

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 (58) hide show
  1. package/dist/client.d.ts +113 -26
  2. package/dist/client.js +192 -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/CreateGwConsumerOrderRequest.d.ts +6 -6
  15. package/dist/models/CreateResourceControlRequest.d.ts +8 -8
  16. package/dist/models/DeleteAidbclusterApiKeyRequest.d.ts +34 -0
  17. package/dist/models/DeleteAidbclusterApiKeyRequest.js +60 -0
  18. package/dist/models/DeleteAidbclusterApiKeyRequest.js.map +1 -0
  19. package/dist/models/DeleteAidbclusterApiKeyResponse.d.ts +19 -0
  20. package/dist/models/DeleteAidbclusterApiKeyResponse.js +69 -0
  21. package/dist/models/DeleteAidbclusterApiKeyResponse.js.map +1 -0
  22. package/dist/models/DeleteAidbclusterApiKeyResponseBody.d.ts +29 -0
  23. package/dist/models/DeleteAidbclusterApiKeyResponseBody.js +60 -0
  24. package/dist/models/DeleteAidbclusterApiKeyResponseBody.js.map +1 -0
  25. package/dist/models/DeleteResourceControlRequest.d.ts +6 -5
  26. package/dist/models/DeleteResourceControlRequest.js.map +1 -1
  27. package/dist/models/DescribeAidbclusterApiKeysRequest.d.ts +23 -0
  28. package/dist/models/DescribeAidbclusterApiKeysRequest.js +58 -0
  29. package/dist/models/DescribeAidbclusterApiKeysRequest.js.map +1 -0
  30. package/dist/models/DescribeAidbclusterApiKeysResponse.d.ts +19 -0
  31. package/dist/models/DescribeAidbclusterApiKeysResponse.js +69 -0
  32. package/dist/models/DescribeAidbclusterApiKeysResponse.js.map +1 -0
  33. package/dist/models/DescribeAidbclusterApiKeysResponseBody.d.ts +78 -0
  34. package/dist/models/DescribeAidbclusterApiKeysResponseBody.js +90 -0
  35. package/dist/models/DescribeAidbclusterApiKeysResponseBody.js.map +1 -0
  36. package/dist/models/ModifyResourceControlRequest.d.ts +9 -9
  37. package/dist/models/UnbindResourceControlRequest.d.ts +11 -11
  38. package/dist/models/model.d.ts +11 -0
  39. package/dist/models/model.js +57 -35
  40. package/dist/models/model.js.map +1 -1
  41. package/package.json +1 -1
  42. package/src/client.ts +203 -26
  43. package/src/models/BindResourceControlRequest.ts +9 -9
  44. package/src/models/CreateAidbclusterApiKeyRequest.ts +48 -0
  45. package/src/models/CreateAidbclusterApiKeyResponse.ts +40 -0
  46. package/src/models/CreateAidbclusterApiKeyResponseBody.ts +114 -0
  47. package/src/models/CreateGwConsumerOrderRequest.ts +6 -6
  48. package/src/models/CreateResourceControlRequest.ts +8 -8
  49. package/src/models/DeleteAidbclusterApiKeyRequest.ts +49 -0
  50. package/src/models/DeleteAidbclusterApiKeyResponse.ts +40 -0
  51. package/src/models/DeleteAidbclusterApiKeyResponseBody.ts +44 -0
  52. package/src/models/DeleteResourceControlRequest.ts +6 -5
  53. package/src/models/DescribeAidbclusterApiKeysRequest.ts +36 -0
  54. package/src/models/DescribeAidbclusterApiKeysResponse.ts +40 -0
  55. package/src/models/DescribeAidbclusterApiKeysResponseBody.ts +114 -0
  56. package/src/models/ModifyResourceControlRequest.ts +9 -9
  57. package/src/models/UnbindResourceControlRequest.ts +11 -11
  58. package/src/models/model.ts +11 -0
package/src/client.ts CHANGED
@@ -66,6 +66,7 @@ export default class Client extends OpenApi {
66
66
  'cn-hongkong': "polardb.cn-hongkong.aliyuncs.com",
67
67
  'cn-guangzhou': "polardb.cn-guangzhou.aliyuncs.com",
68
68
  'cn-chengdu': "polardb.cn-chengdu.aliyuncs.com",
69
+ 'ap-southeast-8': "polardb.ap-southeast-8.aliyuncs.com",
69
70
  'ap-southeast-7': "polardb.ap-southeast-7.aliyuncs.com",
70
71
  'ap-southeast-6': "polardb.ap-southeast-6.aliyuncs.com",
71
72
  'ap-southeast-5': "polardb.ap-southeast-5.aliyuncs.com",
@@ -788,11 +789,14 @@ export default class Client extends OpenApi {
788
789
  }
789
790
 
790
791
  /**
791
- * Associates resource control.
792
+ * 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.
792
793
  *
793
794
  * @remarks
794
- * ## Operation description
795
- * 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.
795
+ * 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.
796
+ * ### Before you begin
797
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
798
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
799
+ * >Notice: This is a notice.</notice>
796
800
  *
797
801
  * @param request - BindResourceControlRequest
798
802
  * @param runtime - runtime options for this request RuntimeOptions
@@ -839,11 +843,14 @@ export default class Client extends OpenApi {
839
843
  }
840
844
 
841
845
  /**
842
- * Associates resource control.
846
+ * 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.
843
847
  *
844
848
  * @remarks
845
- * ## Operation description
846
- * 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.
849
+ * 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.
850
+ * ### Before you begin
851
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
852
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
853
+ * >Notice: This is a notice.</notice>
847
854
  *
848
855
  * @param request - BindResourceControlRequest
849
856
  * @returns BindResourceControlResponse
@@ -2055,6 +2062,52 @@ export default class Client extends OpenApi {
2055
2062
  return await this.createAIDBClusterWithOptions(request, runtime);
2056
2063
  }
2057
2064
 
2065
+ /**
2066
+ * Creates a model service API key.
2067
+ *
2068
+ * @param request - CreateAIDBClusterApiKeyRequest
2069
+ * @param runtime - runtime options for this request RuntimeOptions
2070
+ * @returns CreateAIDBClusterApiKeyResponse
2071
+ */
2072
+ async createAIDBClusterApiKeyWithOptions(request: $_model.CreateAIDBClusterApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAIDBClusterApiKeyResponse> {
2073
+ request.validate();
2074
+ let query = { };
2075
+ if (!$dara.isNull(request.description)) {
2076
+ query["Description"] = request.description;
2077
+ }
2078
+
2079
+ if (!$dara.isNull(request.regionId)) {
2080
+ query["RegionId"] = request.regionId;
2081
+ }
2082
+
2083
+ let req = new $OpenApiUtil.OpenApiRequest({
2084
+ query: OpenApiUtil.query(query),
2085
+ });
2086
+ let params = new $OpenApiUtil.Params({
2087
+ action: "CreateAIDBClusterApiKey",
2088
+ version: "2017-08-01",
2089
+ protocol: "HTTPS",
2090
+ pathname: "/",
2091
+ method: "POST",
2092
+ authType: "AK",
2093
+ style: "RPC",
2094
+ reqBodyType: "formData",
2095
+ bodyType: "json",
2096
+ });
2097
+ return $dara.cast<$_model.CreateAIDBClusterApiKeyResponse>(await this.callApi(params, req, runtime), new $_model.CreateAIDBClusterApiKeyResponse({}));
2098
+ }
2099
+
2100
+ /**
2101
+ * Creates a model service API key.
2102
+ *
2103
+ * @param request - CreateAIDBClusterApiKeyRequest
2104
+ * @returns CreateAIDBClusterApiKeyResponse
2105
+ */
2106
+ async createAIDBClusterApiKey(request: $_model.CreateAIDBClusterApiKeyRequest): Promise<$_model.CreateAIDBClusterApiKeyResponse> {
2107
+ let runtime = new $dara.RuntimeOptions({ });
2108
+ return await this.createAIDBClusterApiKeyWithOptions(request, runtime);
2109
+ }
2110
+
2058
2111
  /**
2059
2112
  * Creates a dataset.
2060
2113
  *
@@ -6064,11 +6117,16 @@ export default class Client extends OpenApi {
6064
6117
  }
6065
6118
 
6066
6119
  /**
6067
- * Creates a resource control.
6120
+ * 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.
6068
6121
  *
6069
6122
  * @remarks
6070
- * ## Operation description
6071
- * 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.
6123
+ * 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.
6124
+ * ### Before you begin
6125
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
6126
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
6127
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
6128
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
6129
+ * >Notice: This is a notice.</notice>
6072
6130
  *
6073
6131
  * @param request - CreateResourceControlRequest
6074
6132
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6115,11 +6173,16 @@ export default class Client extends OpenApi {
6115
6173
  }
6116
6174
 
6117
6175
  /**
6118
- * Creates a resource control.
6176
+ * 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.
6119
6177
  *
6120
6178
  * @remarks
6121
- * ## Operation description
6122
- * 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.
6179
+ * 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.
6180
+ * ### Before you begin
6181
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
6182
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
6183
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
6184
+ * - The maximum value of CpuCount is determined by the kernel parameter resource_control_cpu_count_limit of the target cluster.
6185
+ * >Notice: This is a notice.</notice>
6123
6186
  *
6124
6187
  * @param request - CreateResourceControlRequest
6125
6188
  * @returns CreateResourceControlResponse
@@ -6307,6 +6370,52 @@ export default class Client extends OpenApi {
6307
6370
  return await this.deleteAIDBClusterWithOptions(request, runtime);
6308
6371
  }
6309
6372
 
6373
+ /**
6374
+ * Deletes an API key for a model service.
6375
+ *
6376
+ * @param request - DeleteAIDBClusterApiKeyRequest
6377
+ * @param runtime - runtime options for this request RuntimeOptions
6378
+ * @returns DeleteAIDBClusterApiKeyResponse
6379
+ */
6380
+ async deleteAIDBClusterApiKeyWithOptions(request: $_model.DeleteAIDBClusterApiKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAIDBClusterApiKeyResponse> {
6381
+ request.validate();
6382
+ let query = { };
6383
+ if (!$dara.isNull(request.apiKey)) {
6384
+ query["ApiKey"] = request.apiKey;
6385
+ }
6386
+
6387
+ if (!$dara.isNull(request.regionId)) {
6388
+ query["RegionId"] = request.regionId;
6389
+ }
6390
+
6391
+ let req = new $OpenApiUtil.OpenApiRequest({
6392
+ query: OpenApiUtil.query(query),
6393
+ });
6394
+ let params = new $OpenApiUtil.Params({
6395
+ action: "DeleteAIDBClusterApiKey",
6396
+ version: "2017-08-01",
6397
+ protocol: "HTTPS",
6398
+ pathname: "/",
6399
+ method: "POST",
6400
+ authType: "AK",
6401
+ style: "RPC",
6402
+ reqBodyType: "formData",
6403
+ bodyType: "json",
6404
+ });
6405
+ return $dara.cast<$_model.DeleteAIDBClusterApiKeyResponse>(await this.callApi(params, req, runtime), new $_model.DeleteAIDBClusterApiKeyResponse({}));
6406
+ }
6407
+
6408
+ /**
6409
+ * Deletes an API key for a model service.
6410
+ *
6411
+ * @param request - DeleteAIDBClusterApiKeyRequest
6412
+ * @returns DeleteAIDBClusterApiKeyResponse
6413
+ */
6414
+ async deleteAIDBClusterApiKey(request: $_model.DeleteAIDBClusterApiKeyRequest): Promise<$_model.DeleteAIDBClusterApiKeyResponse> {
6415
+ let runtime = new $dara.RuntimeOptions({ });
6416
+ return await this.deleteAIDBClusterApiKeyWithOptions(request, runtime);
6417
+ }
6418
+
6310
6419
  /**
6311
6420
  * Deletes a dataset.
6312
6421
  *
@@ -8960,10 +9069,14 @@ export default class Client extends OpenApi {
8960
9069
  }
8961
9070
 
8962
9071
  /**
8963
- * Deletes a resource control.
9072
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
8964
9073
  *
8965
9074
  * @remarks
8966
- * > The cluster must be in the Running state. Otherwise, the operation fails.
9075
+ * 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.
9076
+ * ### Limits
9077
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
9078
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
9079
+ * >Notice: This is a notice.</notice>
8967
9080
  *
8968
9081
  * @param request - DeleteResourceControlRequest
8969
9082
  * @param runtime - runtime options for this request RuntimeOptions
@@ -9002,10 +9115,14 @@ export default class Client extends OpenApi {
9002
9115
  }
9003
9116
 
9004
9117
  /**
9005
- * Deletes a resource control.
9118
+ * Deletes a resource control rule from a specified PolarDB for MySQL cluster.
9006
9119
  *
9007
9120
  * @remarks
9008
- * > The cluster must be in the Running state. Otherwise, the operation fails.
9121
+ * 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.
9122
+ * ### Limits
9123
+ * - This feature applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
9124
+ * - In the cluster kernel parameter Settings, loose_enable_resource_control must be set to ON.
9125
+ * >Notice: This is a notice.</notice>
9009
9126
  *
9010
9127
  * @param request - DeleteResourceControlRequest
9011
9128
  * @returns DeleteResourceControlResponse
@@ -9077,6 +9194,48 @@ export default class Client extends OpenApi {
9077
9194
  return await this.deleteSQLRateLimitingRulesWithOptions(request, runtime);
9078
9195
  }
9079
9196
 
9197
+ /**
9198
+ * Queries the API key of a model service.
9199
+ *
9200
+ * @param request - DescribeAIDBClusterApiKeysRequest
9201
+ * @param runtime - runtime options for this request RuntimeOptions
9202
+ * @returns DescribeAIDBClusterApiKeysResponse
9203
+ */
9204
+ async describeAIDBClusterApiKeysWithOptions(request: $_model.DescribeAIDBClusterApiKeysRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAIDBClusterApiKeysResponse> {
9205
+ request.validate();
9206
+ let query = { };
9207
+ if (!$dara.isNull(request.regionId)) {
9208
+ query["RegionId"] = request.regionId;
9209
+ }
9210
+
9211
+ let req = new $OpenApiUtil.OpenApiRequest({
9212
+ query: OpenApiUtil.query(query),
9213
+ });
9214
+ let params = new $OpenApiUtil.Params({
9215
+ action: "DescribeAIDBClusterApiKeys",
9216
+ version: "2017-08-01",
9217
+ protocol: "HTTPS",
9218
+ pathname: "/",
9219
+ method: "POST",
9220
+ authType: "AK",
9221
+ style: "RPC",
9222
+ reqBodyType: "formData",
9223
+ bodyType: "json",
9224
+ });
9225
+ return $dara.cast<$_model.DescribeAIDBClusterApiKeysResponse>(await this.callApi(params, req, runtime), new $_model.DescribeAIDBClusterApiKeysResponse({}));
9226
+ }
9227
+
9228
+ /**
9229
+ * Queries the API key of a model service.
9230
+ *
9231
+ * @param request - DescribeAIDBClusterApiKeysRequest
9232
+ * @returns DescribeAIDBClusterApiKeysResponse
9233
+ */
9234
+ async describeAIDBClusterApiKeys(request: $_model.DescribeAIDBClusterApiKeysRequest): Promise<$_model.DescribeAIDBClusterApiKeysResponse> {
9235
+ let runtime = new $dara.RuntimeOptions({ });
9236
+ return await this.describeAIDBClusterApiKeysWithOptions(request, runtime);
9237
+ }
9238
+
9080
9239
  /**
9081
9240
  * Queries the details of a custom instance.
9082
9241
  *
@@ -27012,10 +27171,16 @@ export default class Client extends OpenApi {
27012
27171
  }
27013
27172
 
27014
27173
  /**
27015
- * Modifies resource control.
27174
+ * 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.
27016
27175
  *
27017
27176
  * @remarks
27018
- * > 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).
27177
+ * 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.
27178
+ * ### Before you begin
27179
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
27180
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
27181
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
27182
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
27183
+ * >Notice: This is a notice.</notice>
27019
27184
  *
27020
27185
  * @param request - ModifyResourceControlRequest
27021
27186
  * @param runtime - runtime options for this request RuntimeOptions
@@ -27062,10 +27227,16 @@ export default class Client extends OpenApi {
27062
27227
  }
27063
27228
 
27064
27229
  /**
27065
- * Modifies resource control.
27230
+ * 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.
27066
27231
  *
27067
27232
  * @remarks
27068
- * > 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).
27233
+ * 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.
27234
+ * ### Before you begin
27235
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
27236
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
27237
+ * - MaxCpu and CpuCount are two mutually exclusive CPU quota modes.
27238
+ * - The maximum value of CpuCount is determined by the cluster kernel parameter resource_control_cpu_count_limit.
27239
+ * >Notice: This is a notice.</notice>
27069
27240
  *
27070
27241
  * @param request - ModifyResourceControlRequest
27071
27242
  * @returns ModifyResourceControlResponse
@@ -29374,11 +29545,14 @@ export default class Client extends OpenApi {
29374
29545
  }
29375
29546
 
29376
29547
  /**
29377
- * Unbinds a resource control.
29548
+ * 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.
29378
29549
  *
29379
29550
  * @remarks
29380
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
29381
- * > * 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.
29551
+ * 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.
29552
+ * ### Before you begin
29553
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
29554
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
29555
+ * >Notice: This is a notice.</notice>
29382
29556
  *
29383
29557
  * @param request - UnbindResourceControlRequest
29384
29558
  * @param runtime - runtime options for this request RuntimeOptions
@@ -29425,11 +29599,14 @@ export default class Client extends OpenApi {
29425
29599
  }
29426
29600
 
29427
29601
  /**
29428
- * Unbinds a resource control.
29602
+ * 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.
29429
29603
  *
29430
29604
  * @remarks
29431
- * > * Only the privileged user of a PolarDB for MySQL cluster can be reset.
29432
- * > * 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.
29605
+ * 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.
29606
+ * ### Before you begin
29607
+ * - This operation applies only to PolarDB for MySQL Cluster Edition clusters that support Resource Control. PolarDB for MySQL Standard Edition is not supported.
29608
+ * - The cluster kernel parameter loose_enable_resource_control must be set to ON.
29609
+ * >Notice: This is a notice.</notice>
29433
29610
  *
29434
29611
  * @param request - UnbindResourceControlRequest
29435
29612
  * @returns UnbindResourceControlResponse
@@ -5,17 +5,17 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class BindResourceControlRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The cluster ID.
8
+ * The PolarDB cluster ID.
9
9
  *
10
10
  * This parameter is required.
11
11
  *
12
12
  * @example
13
- * pm-xxxxxx
13
+ * pc-**************
14
14
  */
15
15
  DBClusterId?: string;
16
16
  /**
17
17
  * @remarks
18
- * The region ID.
18
+ * The region ID of the PolarDB cluster.
19
19
  *
20
20
  * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query available regions.
21
21
  *
@@ -25,32 +25,32 @@ export class BindResourceControlRequest extends $dara.Model {
25
25
  regionId?: string;
26
26
  /**
27
27
  * @remarks
28
- * The resource control name.
28
+ * The name of the resource control rule. The name must be 1 to 63 ASCII bytes in length, start with a letter, and can contain only letters, digits, and underscores.
29
29
  *
30
30
  * This parameter is required.
31
31
  *
32
32
  * @example
33
- * test-rc
33
+ * test_rc
34
34
  */
35
35
  resourceControlName?: string;
36
36
  /**
37
37
  * @remarks
38
- * The target instance type.
38
+ * The type of the binding target. Valid values: USER, DATABASE, QUERY, CONNECTION. The value is case-insensitive.
39
39
  *
40
40
  * This parameter is required.
41
41
  *
42
42
  * @example
43
- * 4
43
+ * USER
44
44
  */
45
45
  targetType?: string;
46
46
  /**
47
47
  * @remarks
48
- * The target value. This parameter applies to target tracking rules and prediction rules. The value of TargetValue can contain up to three decimal places and must be greater than 0.
48
+ * The value of the binding target. The format depends on the value of TargetType. For more information, see the table below.
49
49
  *
50
50
  * This parameter is required.
51
51
  *
52
52
  * @example
53
- * 646060ae9852280007a62545,68b696cb0a7fa600078d41af
53
+ * app_user
54
54
  */
55
55
  targetValue?: string;
56
56
  static names(): { [key: string]: string } {
@@ -0,0 +1,48 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class CreateAIDBClusterApiKeyRequest extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The description.
9
+ *
10
+ * @example
11
+ * test
12
+ */
13
+ description?: string;
14
+ /**
15
+ * @remarks
16
+ * The region ID.
17
+ * > * You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query the regions of all clusters under the specified account.
18
+ * > * If you leave this parameter empty, scheduled tasks across all regions under the current account are queried.
19
+ *
20
+ * This parameter is required.
21
+ *
22
+ * @example
23
+ * cn-beijing
24
+ */
25
+ regionId?: string;
26
+ static names(): { [key: string]: string } {
27
+ return {
28
+ description: 'Description',
29
+ regionId: 'RegionId',
30
+ };
31
+ }
32
+
33
+ static types(): { [key: string]: any } {
34
+ return {
35
+ description: 'string',
36
+ regionId: 'string',
37
+ };
38
+ }
39
+
40
+ validate() {
41
+ super.validate();
42
+ }
43
+
44
+ constructor(map?: { [key: string]: any }) {
45
+ super(map);
46
+ }
47
+ }
48
+
@@ -0,0 +1,40 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+ import { CreateAIDBClusterApiKeyResponseBody } from "./CreateAidbclusterApiKeyResponseBody";
4
+
5
+
6
+ export class CreateAIDBClusterApiKeyResponse extends $dara.Model {
7
+ headers?: { [key: string]: string };
8
+ statusCode?: number;
9
+ body?: CreateAIDBClusterApiKeyResponseBody;
10
+ static names(): { [key: string]: string } {
11
+ return {
12
+ headers: 'headers',
13
+ statusCode: 'statusCode',
14
+ body: 'body',
15
+ };
16
+ }
17
+
18
+ static types(): { [key: string]: any } {
19
+ return {
20
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
21
+ statusCode: 'number',
22
+ body: CreateAIDBClusterApiKeyResponseBody,
23
+ };
24
+ }
25
+
26
+ validate() {
27
+ if(this.headers) {
28
+ $dara.Model.validateMap(this.headers);
29
+ }
30
+ if(this.body && typeof (this.body as any).validate === 'function') {
31
+ (this.body as any).validate();
32
+ }
33
+ super.validate();
34
+ }
35
+
36
+ constructor(map?: { [key: string]: any }) {
37
+ super(map);
38
+ }
39
+ }
40
+
@@ -0,0 +1,114 @@
1
+ // This file is auto-generated, don't edit it
2
+ import * as $dara from '@darabonba/typescript';
3
+
4
+
5
+ export class CreateAIDBClusterApiKeyResponseBodyApiKey extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The API key of the model service.
9
+ *
10
+ * @example
11
+ * xxx
12
+ */
13
+ apiKey?: string;
14
+ /**
15
+ * @remarks
16
+ * The creation time.
17
+ *
18
+ * @example
19
+ * 2026-06-12T03:41:53Z
20
+ */
21
+ createTime?: string;
22
+ /**
23
+ * @remarks
24
+ * The description.
25
+ *
26
+ * @example
27
+ * test
28
+ */
29
+ description?: string;
30
+ /**
31
+ * @remarks
32
+ * id
33
+ *
34
+ * @example
35
+ * 393
36
+ */
37
+ id?: string;
38
+ /**
39
+ * @remarks
40
+ * The API key status.
41
+ *
42
+ * @example
43
+ * active
44
+ */
45
+ status?: string;
46
+ static names(): { [key: string]: string } {
47
+ return {
48
+ apiKey: 'ApiKey',
49
+ createTime: 'CreateTime',
50
+ description: 'Description',
51
+ id: 'Id',
52
+ status: 'Status',
53
+ };
54
+ }
55
+
56
+ static types(): { [key: string]: any } {
57
+ return {
58
+ apiKey: 'string',
59
+ createTime: 'string',
60
+ description: 'string',
61
+ id: 'string',
62
+ status: 'string',
63
+ };
64
+ }
65
+
66
+ validate() {
67
+ super.validate();
68
+ }
69
+
70
+ constructor(map?: { [key: string]: any }) {
71
+ super(map);
72
+ }
73
+ }
74
+
75
+ export class CreateAIDBClusterApiKeyResponseBody extends $dara.Model {
76
+ /**
77
+ * @remarks
78
+ * The API key.
79
+ */
80
+ apiKey?: CreateAIDBClusterApiKeyResponseBodyApiKey;
81
+ /**
82
+ * @remarks
83
+ * Id of the request
84
+ *
85
+ * @example
86
+ * 2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
87
+ */
88
+ requestId?: string;
89
+ static names(): { [key: string]: string } {
90
+ return {
91
+ apiKey: 'ApiKey',
92
+ requestId: 'RequestId',
93
+ };
94
+ }
95
+
96
+ static types(): { [key: string]: any } {
97
+ return {
98
+ apiKey: CreateAIDBClusterApiKeyResponseBodyApiKey,
99
+ requestId: 'string',
100
+ };
101
+ }
102
+
103
+ validate() {
104
+ if(this.apiKey && typeof (this.apiKey as any).validate === 'function') {
105
+ (this.apiKey as any).validate();
106
+ }
107
+ super.validate();
108
+ }
109
+
110
+ constructor(map?: { [key: string]: any }) {
111
+ super(map);
112
+ }
113
+ }
114
+
@@ -15,8 +15,6 @@ export class CreateGwConsumerOrderRequest extends $dara.Model {
15
15
  * @remarks
16
16
  * The expiration time of the API key in ISO 8601 format. The value must be later than the current time.
17
17
  *
18
- * This parameter is required.
19
- *
20
18
  * @example
21
19
  * 2027-07-23T03:09:08Z
22
20
  */
@@ -33,7 +31,7 @@ export class CreateGwConsumerOrderRequest extends $dara.Model {
33
31
  gatewayId?: string;
34
32
  /**
35
33
  * @remarks
36
- * The number of API keys to generate, which corresponds to the number of resource plans to purchase. Valid values: 1 to 30.
34
+ * The number of API keys to generate, which is the number of resource plans to order. Valid values: 1 to 30.
37
35
  *
38
36
  * This parameter is required.
39
37
  *
@@ -45,9 +43,11 @@ export class CreateGwConsumerOrderRequest extends $dara.Model {
45
43
  * @remarks
46
44
  * The specification tier of the resource plan. Valid values:
47
45
  *
48
- * - basic: 3000 points per plan.
49
- * - advanced: 6000 points per plan.
50
- * - pro: 9000 points per plan.
46
+ * - basic
47
+ * - advanced
48
+ * - pro
49
+ *
50
+ * Each value represents the number of credits for a single key.
51
51
  *
52
52
  * This parameter is required.
53
53
  *