@alicloud/apig20240327 11.2.0 → 11.3.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 (57) hide show
  1. package/dist/client.d.ts +82 -58
  2. package/dist/client.js +115 -58
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AddGatewayQuotaRuleRequest.d.ts +20 -14
  5. package/dist/models/AddGatewayQuotaRuleRequest.js.map +1 -1
  6. package/dist/models/AddGatewayQuotaRuleResponseBody.d.ts +14 -9
  7. package/dist/models/AddGatewayQuotaRuleResponseBody.js.map +1 -1
  8. package/dist/models/GetDashboardRequest.d.ts +5 -5
  9. package/dist/models/GetDashboardResponseBody.d.ts +2 -2
  10. package/dist/models/GetDashboardShrinkRequest.d.ts +5 -5
  11. package/dist/models/GetGatewayQuotaRuleRequest.d.ts +4 -4
  12. package/dist/models/GetGatewayQuotaRuleResponseBody.d.ts +4 -4
  13. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.d.ts +3 -3
  14. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.d.ts +1 -1
  15. package/dist/models/HttpApiApiInfo.d.ts +1 -1
  16. package/dist/models/HttpApiApiInfoDeployCntMapValue.d.ts +1 -1
  17. package/dist/models/HttpRoute.d.ts +4 -1
  18. package/dist/models/HttpRoute.js.map +1 -1
  19. package/dist/models/ListConsumerGroupQuotaRulesRequest.d.ts +33 -0
  20. package/dist/models/ListConsumerGroupQuotaRulesRequest.js +64 -0
  21. package/dist/models/ListConsumerGroupQuotaRulesRequest.js.map +1 -0
  22. package/dist/models/ListConsumerGroupQuotaRulesResponse.d.ts +19 -0
  23. package/dist/models/ListConsumerGroupQuotaRulesResponse.js +69 -0
  24. package/dist/models/ListConsumerGroupQuotaRulesResponse.js.map +1 -0
  25. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.d.ts +132 -0
  26. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js +134 -0
  27. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js.map +1 -0
  28. package/dist/models/ResetGatewayQuotaRuleRequest.d.ts +9 -10
  29. package/dist/models/ResetGatewayQuotaRuleRequest.js.map +1 -1
  30. package/dist/models/ResetGatewayQuotaRuleResponseBody.d.ts +16 -16
  31. package/dist/models/UpdateGatewayQuotaRuleRequest.d.ts +8 -8
  32. package/dist/models/UpdateGatewayQuotaRuleResponseBody.d.ts +12 -12
  33. package/dist/models/model.d.ts +5 -0
  34. package/dist/models/model.js +26 -16
  35. package/dist/models/model.js.map +1 -1
  36. package/package.json +1 -1
  37. package/src/client.ts +121 -58
  38. package/src/models/AddGatewayQuotaRuleRequest.ts +20 -14
  39. package/src/models/AddGatewayQuotaRuleResponseBody.ts +14 -9
  40. package/src/models/GetDashboardRequest.ts +5 -5
  41. package/src/models/GetDashboardResponseBody.ts +2 -2
  42. package/src/models/GetDashboardShrinkRequest.ts +5 -5
  43. package/src/models/GetGatewayQuotaRuleRequest.ts +4 -4
  44. package/src/models/GetGatewayQuotaRuleResponseBody.ts +4 -4
  45. package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts +3 -3
  46. package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts +1 -1
  47. package/src/models/HttpApiApiInfo.ts +1 -1
  48. package/src/models/HttpApiApiInfoDeployCntMapValue.ts +1 -1
  49. package/src/models/HttpRoute.ts +4 -1
  50. package/src/models/ListConsumerGroupQuotaRulesRequest.ts +52 -0
  51. package/src/models/ListConsumerGroupQuotaRulesResponse.ts +40 -0
  52. package/src/models/ListConsumerGroupQuotaRulesResponseBody.ts +203 -0
  53. package/src/models/ResetGatewayQuotaRuleRequest.ts +9 -10
  54. package/src/models/ResetGatewayQuotaRuleResponseBody.ts +16 -16
  55. package/src/models/UpdateGatewayQuotaRuleRequest.ts +8 -8
  56. package/src/models/UpdateGatewayQuotaRuleResponseBody.ts +12 -12
  57. package/src/models/model.ts +5 -0
package/src/client.ts CHANGED
@@ -60,15 +60,15 @@ export default class Client extends OpenApi {
60
60
  * Creates a gateway quota throttling rule.
61
61
  *
62
62
  * @remarks
63
- * Creates a consumer-based quota rule for an AI gateway. This operation applies only to AI gateways running version 2.1.19 or later.
63
+ * Creates a consumer-based or consumer group-based quota rule for an AI gateway. This operation takes effect only on AI gateways of version 2.1.21 or later.
64
64
  * >
65
- * > Recommended call logic:
66
- * > - 1. Perform a dry run to check for rule conflicts.
67
- * > - - Set dryRun=true.
68
- * > - - The response contains a conflict preview with conflictHash.
69
- * > - 2. Submit the request after confirmation.
70
- * > - - No conflicts: dryRun=false, overwrite=false.
71
- * > - - Conflicts exist and you confirm overwrite: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
65
+ * > Recommended call sequence:
66
+ * > - Step 1: Perform a dry run to check for rule conflicts.
67
+ * > - - Set dryRun to true.
68
+ * > - - The response returns a conflict preview that contains the conflictHash value.
69
+ * > - Step 2: Submit the request after confirmation.
70
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
71
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
72
72
  *
73
73
  * @param request - AddGatewayQuotaRuleRequest
74
74
  * @param headers - map
@@ -152,15 +152,15 @@ export default class Client extends OpenApi {
152
152
  * Creates a gateway quota throttling rule.
153
153
  *
154
154
  * @remarks
155
- * Creates a consumer-based quota rule for an AI gateway. This operation applies only to AI gateways running version 2.1.19 or later.
155
+ * Creates a consumer-based or consumer group-based quota rule for an AI gateway. This operation takes effect only on AI gateways of version 2.1.21 or later.
156
156
  * >
157
- * > Recommended call logic:
158
- * > - 1. Perform a dry run to check for rule conflicts.
159
- * > - - Set dryRun=true.
160
- * > - - The response contains a conflict preview with conflictHash.
161
- * > - 2. Submit the request after confirmation.
162
- * > - - No conflicts: dryRun=false, overwrite=false.
163
- * > - - Conflicts exist and you confirm overwrite: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
157
+ * > Recommended call sequence:
158
+ * > - Step 1: Perform a dry run to check for rule conflicts.
159
+ * > - - Set dryRun to true.
160
+ * > - - The response returns a conflict preview that contains the conflictHash value.
161
+ * > - Step 2: Submit the request after confirmation.
162
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
163
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
164
164
  *
165
165
  * @param request - AddGatewayQuotaRuleRequest
166
166
  * @returns AddGatewayQuotaRuleResponse
@@ -2703,7 +2703,7 @@ export default class Client extends OpenApi {
2703
2703
  * Deletes a quota throttling rule from a gateway.
2704
2704
  *
2705
2705
  * @remarks
2706
- * Deletes a consumer-based quota rule from an AI gateway. This operation takes effect only for AI gateways of version 2.1.19 or later.
2706
+ * This operation deletes a consumer-based or consumer group-based quota rule from an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
2707
2707
  *
2708
2708
  * @param request - DeleteGatewayQuotaRuleRequest
2709
2709
  * @param headers - map
@@ -2733,7 +2733,7 @@ export default class Client extends OpenApi {
2733
2733
  * Deletes a quota throttling rule from a gateway.
2734
2734
  *
2735
2735
  * @remarks
2736
- * Deletes a consumer-based quota rule from an AI gateway. This operation takes effect only for AI gateways of version 2.1.19 or later.
2736
+ * This operation deletes a consumer-based or consumer group-based quota rule from an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
2737
2737
  *
2738
2738
  * @param request - DeleteGatewayQuotaRuleRequest
2739
2739
  * @returns DeleteGatewayQuotaRuleResponse
@@ -4027,10 +4027,10 @@ export default class Client extends OpenApi {
4027
4027
  }
4028
4028
 
4029
4029
  /**
4030
- * Queries the details of a gateway quota rate limiting rule.
4030
+ * Queries the details of a gateway quota throttling rule.
4031
4031
  *
4032
4032
  * @remarks
4033
- * Queries the details of a consumer quota rule on an AI gateway.
4033
+ * Queries a specific API consumer quota rule on an AI gateway.
4034
4034
  *
4035
4035
  * @param request - GetGatewayQuotaRuleRequest
4036
4036
  * @param headers - map
@@ -4075,10 +4075,10 @@ export default class Client extends OpenApi {
4075
4075
  }
4076
4076
 
4077
4077
  /**
4078
- * Queries the details of a gateway quota rate limiting rule.
4078
+ * Queries the details of a gateway quota throttling rule.
4079
4079
  *
4080
4080
  * @remarks
4081
- * Queries the details of a consumer quota rule on an AI gateway.
4081
+ * Queries a specific API consumer quota rule on an AI gateway.
4082
4082
  *
4083
4083
  * @param request - GetGatewayQuotaRuleRequest
4084
4084
  * @returns GetGatewayQuotaRuleResponse
@@ -4093,7 +4093,7 @@ export default class Client extends OpenApi {
4093
4093
  * Queries the usage details of a subject under a gateway quota throttling rule, including used quota, total quota, whether the limit is exceeded, usage details, and consumption records.
4094
4094
  *
4095
4095
  * @remarks
4096
- * Retrieves the usage details of a specific consumer under a quota rule. This operation applies only to AI gateways with a version later than 2.1.19.
4096
+ * Queries the usage details of a specific subject under a quota rule. This operation applies only to AI gateways with a version later than 2.1.19.
4097
4097
  *
4098
4098
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
4099
4099
  * @param headers - map
@@ -4137,7 +4137,7 @@ export default class Client extends OpenApi {
4137
4137
  * Queries the usage details of a subject under a gateway quota throttling rule, including used quota, total quota, whether the limit is exceeded, usage details, and consumption records.
4138
4138
  *
4139
4139
  * @remarks
4140
- * Retrieves the usage details of a specific consumer under a quota rule. This operation applies only to AI gateways with a version later than 2.1.19.
4140
+ * Queries the usage details of a specific subject under a quota rule. This operation applies only to AI gateways with a version later than 2.1.19.
4141
4141
  *
4142
4142
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
4143
4143
  * @returns GetGatewayQuotaRuleSubjectUsageResponse
@@ -5415,6 +5415,69 @@ export default class Client extends OpenApi {
5415
5415
  return await this.listConsumerGroupConsumersWithOptions(consumerGroupId, request, headers, runtime);
5416
5416
  }
5417
5417
 
5418
+ /**
5419
+ * 查询消费者组配额限流规则列表
5420
+ *
5421
+ * @remarks
5422
+ * 查询指定消费者组直接绑定的配额规则,不展开组内消费者个人绑定的规则;无直接绑定关系时返回空列表。
5423
+ *
5424
+ * @param request - ListConsumerGroupQuotaRulesRequest
5425
+ * @param headers - map
5426
+ * @param runtime - runtime options for this request RuntimeOptions
5427
+ * @returns ListConsumerGroupQuotaRulesResponse
5428
+ */
5429
+ async listConsumerGroupQuotaRulesWithOptions(consumerGroupId: string, request: $_model.ListConsumerGroupQuotaRulesRequest, headers: {[key: string ]: string}, runtime: $dara.RuntimeOptions): Promise<$_model.ListConsumerGroupQuotaRulesResponse> {
5430
+ request.validate();
5431
+ let query : {[key: string ]: any} = { };
5432
+ if (!$dara.isNull(request.gatewayId)) {
5433
+ query["gatewayId"] = request.gatewayId;
5434
+ }
5435
+
5436
+ if (!$dara.isNull(request.keyword)) {
5437
+ query["keyword"] = request.keyword;
5438
+ }
5439
+
5440
+ if (!$dara.isNull(request.pageNumber)) {
5441
+ query["pageNumber"] = request.pageNumber;
5442
+ }
5443
+
5444
+ if (!$dara.isNull(request.pageSize)) {
5445
+ query["pageSize"] = request.pageSize;
5446
+ }
5447
+
5448
+ let req = new $OpenApiUtil.OpenApiRequest({
5449
+ headers: headers,
5450
+ query: OpenApiUtil.query(query),
5451
+ });
5452
+ let params = new $OpenApiUtil.Params({
5453
+ action: "ListConsumerGroupQuotaRules",
5454
+ version: "2024-03-27",
5455
+ protocol: "HTTPS",
5456
+ pathname: `/v1/consumer-groups/${$dara.URL.percentEncode(consumerGroupId)}/quota-rules`,
5457
+ method: "GET",
5458
+ authType: "AK",
5459
+ style: "ROA",
5460
+ reqBodyType: "json",
5461
+ bodyType: "json",
5462
+ });
5463
+ return $dara.cast<$_model.ListConsumerGroupQuotaRulesResponse>(await this.callApi(params, req, runtime), new $_model.ListConsumerGroupQuotaRulesResponse({}));
5464
+ }
5465
+
5466
+ /**
5467
+ * 查询消费者组配额限流规则列表
5468
+ *
5469
+ * @remarks
5470
+ * 查询指定消费者组直接绑定的配额规则,不展开组内消费者个人绑定的规则;无直接绑定关系时返回空列表。
5471
+ *
5472
+ * @param request - ListConsumerGroupQuotaRulesRequest
5473
+ * @returns ListConsumerGroupQuotaRulesResponse
5474
+ */
5475
+ async listConsumerGroupQuotaRules(consumerGroupId: string, request: $_model.ListConsumerGroupQuotaRulesRequest): Promise<$_model.ListConsumerGroupQuotaRulesResponse> {
5476
+ let runtime = new $dara.RuntimeOptions({ });
5477
+ let headers : {[key: string ]: string} = { };
5478
+ return await this.listConsumerGroupQuotaRulesWithOptions(consumerGroupId, request, headers, runtime);
5479
+ }
5480
+
5418
5481
  /**
5419
5482
  * Queries the list of consumer groups.
5420
5483
  *
@@ -6054,10 +6117,10 @@ export default class Client extends OpenApi {
6054
6117
  }
6055
6118
 
6056
6119
  /**
6057
- * Queries the list of consumer quota rules bound to a gateway.
6120
+ * Queries the list of FinOps quota rules bound to a gateway.
6058
6121
  *
6059
6122
  * @remarks
6060
- * Queries the list of consumer quota rules bound to a gateway.
6123
+ * Queries the list of FinOps quota rules bound to a gateway.
6061
6124
  *
6062
6125
  * @param request - ListGatewayQuotaRulesRequest
6063
6126
  * @param headers - map
@@ -6106,10 +6169,10 @@ export default class Client extends OpenApi {
6106
6169
  }
6107
6170
 
6108
6171
  /**
6109
- * Queries the list of consumer quota rules bound to a gateway.
6172
+ * Queries the list of FinOps quota rules bound to a gateway.
6110
6173
  *
6111
6174
  * @remarks
6112
- * Queries the list of consumer quota rules bound to a gateway.
6175
+ * Queries the list of FinOps quota rules bound to a gateway.
6113
6176
  *
6114
6177
  * @param request - ListGatewayQuotaRulesRequest
6115
6178
  * @returns ListGatewayQuotaRulesResponse
@@ -8035,15 +8098,15 @@ export default class Client extends OpenApi {
8035
8098
  * Resets a quota throttling rule on a gateway.
8036
8099
  *
8037
8100
  * @remarks
8038
- * Resets a quota throttling rule on a gateway. This operation only takes effect for AI gateways with versions later than 2.1.19. Resetting clears the historical usage of consumers on the rule.
8101
+ * Resets a quota throttling rule on a gateway. This operation takes effect only on AI gateways of version 2.1.21 or later. Resetting clears the historical usage of consumption subjects on the rule.
8039
8102
  * >
8040
8103
  * > Recommended call logic:
8041
8104
  * > - 1. Perform a dry run to check for rule conflicts.
8042
- * > - - Set dryRun=true.
8043
- * > - - The response contains a conflict preview with conflictHash.
8044
- * > - 2. Submit the request after confirmation.
8045
- * > - - No conflict: dryRun=false, overwrite=false.
8046
- * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
8105
+ * > - - Set dryRun to true.
8106
+ * > - - The response contains a conflict preview with a conflictHash value.
8107
+ * > - 2. Confirm and submit the request.
8108
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
8109
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
8047
8110
  *
8048
8111
  * @param request - ResetGatewayQuotaRuleRequest
8049
8112
  * @param headers - map
@@ -8107,15 +8170,15 @@ export default class Client extends OpenApi {
8107
8170
  * Resets a quota throttling rule on a gateway.
8108
8171
  *
8109
8172
  * @remarks
8110
- * Resets a quota throttling rule on a gateway. This operation only takes effect for AI gateways with versions later than 2.1.19. Resetting clears the historical usage of consumers on the rule.
8173
+ * Resets a quota throttling rule on a gateway. This operation takes effect only on AI gateways of version 2.1.21 or later. Resetting clears the historical usage of consumption subjects on the rule.
8111
8174
  * >
8112
8175
  * > Recommended call logic:
8113
8176
  * > - 1. Perform a dry run to check for rule conflicts.
8114
- * > - - Set dryRun=true.
8115
- * > - - The response contains a conflict preview with conflictHash.
8116
- * > - 2. Submit the request after confirmation.
8117
- * > - - No conflict: dryRun=false, overwrite=false.
8118
- * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
8177
+ * > - - Set dryRun to true.
8178
+ * > - - The response contains a conflict preview with a conflictHash value.
8179
+ * > - 2. Confirm and submit the request.
8180
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
8181
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
8119
8182
  *
8120
8183
  * @param request - ResetGatewayQuotaRuleRequest
8121
8184
  * @returns ResetGatewayQuotaRuleResponse
@@ -9289,17 +9352,17 @@ export default class Client extends OpenApi {
9289
9352
  }
9290
9353
 
9291
9354
  /**
9292
- * Edits a quota rate-limiting rule on a gateway.
9355
+ * Edits a quota throttling rule on a gateway.
9293
9356
  *
9294
9357
  * @remarks
9295
- * Edits a quota rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19. Editing preserves the historical usage of consumers on the rule.
9296
- * > Recommended call logic:
9297
- * > - 1. Perform a dry run to check for rule conflicts.
9358
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways with a version later than 2.1.21. Editing a rule preserves the historical usage of consumer principals bound to the rule.
9359
+ * > Recommended call sequence:
9360
+ * > - Step 1: Perform a dry run to check for rule conflicts.
9298
9361
  * > - - Set dryRun to true.
9299
- * > - - The response contains a conflict preview with conflictHash.
9300
- * > - 2. Submit the request after confirmation.
9301
- * > - - No conflict: Set dryRun to false and overwrite to false.
9302
- * > - - Conflict exists and overwrite confirmed: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
9362
+ * > - - The response returns a conflict preview that contains conflictHash.
9363
+ * > - Step 2: Confirm and submit the request.
9364
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
9365
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
9303
9366
  *
9304
9367
  * @param request - UpdateGatewayQuotaRuleRequest
9305
9368
  * @param headers - map
@@ -9360,17 +9423,17 @@ export default class Client extends OpenApi {
9360
9423
  }
9361
9424
 
9362
9425
  /**
9363
- * Edits a quota rate-limiting rule on a gateway.
9426
+ * Edits a quota throttling rule on a gateway.
9364
9427
  *
9365
9428
  * @remarks
9366
- * Edits a quota rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19. Editing preserves the historical usage of consumers on the rule.
9367
- * > Recommended call logic:
9368
- * > - 1. Perform a dry run to check for rule conflicts.
9429
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways with a version later than 2.1.21. Editing a rule preserves the historical usage of consumer principals bound to the rule.
9430
+ * > Recommended call sequence:
9431
+ * > - Step 1: Perform a dry run to check for rule conflicts.
9369
9432
  * > - - Set dryRun to true.
9370
- * > - - The response contains a conflict preview with conflictHash.
9371
- * > - 2. Submit the request after confirmation.
9372
- * > - - No conflict: Set dryRun to false and overwrite to false.
9373
- * > - - Conflict exists and overwrite confirmed: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
9433
+ * > - - The response returns a conflict preview that contains conflictHash.
9434
+ * > - Step 2: Confirm and submit the request.
9435
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
9436
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
9374
9437
  *
9375
9438
  * @param request - UpdateGatewayQuotaRuleRequest
9376
9439
  * @returns UpdateGatewayQuotaRuleResponse
@@ -9385,7 +9448,7 @@ export default class Client extends OpenApi {
9385
9448
  * Enables or disables a quota throttling rule for a gateway.
9386
9449
  *
9387
9450
  * @remarks
9388
- * Enables or disables a quota rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19.
9451
+ * Enables or disables a quota rule on a gateway. This operation takes effect only on AI gateways with a version later than 2.1.21.
9389
9452
  *
9390
9453
  * @param request - UpdateGatewayQuotaRuleStatusRequest
9391
9454
  * @param headers - map
@@ -9425,7 +9488,7 @@ export default class Client extends OpenApi {
9425
9488
  * Enables or disables a quota throttling rule for a gateway.
9426
9489
  *
9427
9490
  * @remarks
9428
- * Enables or disables a quota rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19.
9491
+ * Enables or disables a quota rule on a gateway. This operation takes effect only on AI gateways with a version later than 2.1.21.
9429
9492
  *
9430
9493
  * @param request - UpdateGatewayQuotaRuleStatusRequest
9431
9494
  * @returns UpdateGatewayQuotaRuleStatusResponse
@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class AddGatewayQuotaRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The conflict snapshot hash, used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response of a previous dryRun=true request.
8
+ * The conflict snapshot hash used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response of a previous dry run (dryRun=true).
9
9
  *
10
- * This parameter is not required in the following cases: no conflicts exist, the request is a dry run (dryRun=true), or overwrite=false (no overwrite confirmation).
10
+ * This parameter is not required in the following cases: no conflicts exist, the request is a dry run (dryRun=true), or overwrite is set to false.
11
11
  *
12
- * When dryRun=false and overwrite=true, if this parameter is not provided or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. Perform a dry run again to confirm the new conflicts.
12
+ * When dryRun is set to false and overwrite is set to true, if this parameter is not provided or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. In this case, perform a new dry run to confirm the latest conflicts.
13
13
  *
14
14
  * @example
15
15
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
@@ -17,7 +17,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
17
17
  conflictHash?: string;
18
18
  /**
19
19
  * @remarks
20
- * The list of consumer group IDs (not supported currently).
20
+ * The list of API consumer group IDs to bind to the rule. This parameter is used when subjectType is set to consumer_group and cannot be specified together with consumerIds.
21
21
  *
22
22
  * @example
23
23
  * group1,group2
@@ -25,7 +25,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
25
25
  consumerGroupIds?: string[];
26
26
  /**
27
27
  * @remarks
28
- * The list of consumer IDs to bind to the rule. A maximum of 1000 consumers can be specified in a single request.
28
+ * The list of API consumer IDs to bind to the rule. A maximum of 1,000 consumers can be specified in a single request.
29
29
  *
30
30
  * @example
31
31
  * 1001,1002,1003
@@ -33,7 +33,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
33
33
  consumerIds?: string[];
34
34
  /**
35
35
  * @remarks
36
- * Specifies whether to perform only a dry run without applying the configuration. A dry run checks whether conflicting rules exist on the bound consumers. For example, a consumer that already has a calendar-day quota cannot have another calendar-day quota rule added.
36
+ * Specifies whether to perform only a dry run without persisting or applying the configuration. A dry run checks whether conflicting rules exist on the bound consumer subjects. For example, a consumer subject that already has a calendar-day quota rule cannot have another calendar-day quota rule added.
37
37
  *
38
38
  * @example
39
39
  * false
@@ -41,7 +41,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
41
41
  dryRun?: boolean;
42
42
  /**
43
43
  * @remarks
44
- * Specifies whether to allow overwriting when conflicts exist. If overwriting is allowed, the conflicting subjects (consumers) are unbound from the old rule and bound to the new rule.
44
+ * Specifies whether to allow overwriting when conflicts exist. If overwriting is allowed, the conflicting subjects (consumers or consumer groups) are unbound from the old rule and bound to the new rule.
45
45
  *
46
46
  * @example
47
47
  * false
@@ -49,7 +49,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
49
49
  overwrite?: boolean;
50
50
  /**
51
51
  * @remarks
52
- * The period multiplier. This parameter applies to epoch period rules.
52
+ * The period multiplier, which specifies the number of periods after which the quota resets. This parameter is required for custom (epoch) period rules. Minimum value: 1. Maximum value: 60.
53
53
  *
54
54
  * @example
55
55
  * 10
@@ -57,7 +57,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
57
57
  periodMultiplier?: number;
58
58
  /**
59
59
  * @remarks
60
- * The period type. For calendar periods, statistics are collected by day, week, or month. Valid values: day, week, and month. For epoch periods, only day is supported.
60
+ * The period type. For calendar periods, the quota can be calculated by day, week, or month. Valid values: day, week, and month. For custom (epoch) periods, only day is supported.
61
61
  *
62
62
  * This parameter is required.
63
63
  *
@@ -67,7 +67,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
67
67
  periodType?: string;
68
68
  /**
69
69
  * @remarks
70
- * The quota dimension or throttling type. Valid values: token and credit. The credit quota applies only to dedicated instances running version 2.1.19 or later.
70
+ * The quota dimension or throttling type. Valid values: token and credit.
71
71
  *
72
72
  * This parameter is required.
73
73
  *
@@ -77,7 +77,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
77
77
  quotaDimension?: string;
78
78
  /**
79
79
  * @remarks
80
- * The total available quota per period (limit).
80
+ * The total available quota per period.
81
81
  *
82
82
  * This parameter is required.
83
83
  *
@@ -97,7 +97,11 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
97
97
  ruleName?: string;
98
98
  /**
99
99
  * @remarks
100
- * The rule subject type. Valid values: consumer (a consumer) and consumer_group (a consumer group). Default value: consumer.
100
+ * The type of the rule subject. Valid values:
101
+ * - consumer: API consumer.
102
+ * - consumer_group: API consumer group.
103
+ *
104
+ * Default value: consumer.
101
105
  *
102
106
  * @example
103
107
  * consumer_group
@@ -105,7 +109,7 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
105
109
  subjectType?: string;
106
110
  /**
107
111
  * @remarks
108
- * The time zone for the calendar period, in UTC+x format.
112
+ * The time zone for calendar periods, in UTC+x format.
109
113
  *
110
114
  * @example
111
115
  * UTC+8
@@ -113,7 +117,9 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
113
117
  timezone?: string;
114
118
  /**
115
119
  * @remarks
116
- * The reset period type. Valid values: calendar (the period starts from the beginning of a calendar day, week, or month) and epoch (the period starts from when the rule is applied). The epoch type applies only to dedicated instances running version 2.1.19 or later.
120
+ * The reset period alignment type. Valid values:
121
+ * - calendar: The quota resets at the beginning of a calendar day, week, or month.
122
+ * - epoch: The quota resets based on a custom period that starts when the rule takes effect.
117
123
  *
118
124
  * @example
119
125
  * calendar
@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The period type of the existing conflicting rule on the consumer. A value of day, week, or month indicates the conflicting rule has a daily, weekly, or monthly period respectively.
8
+ * The period type of the existing conflicting rule on the consumer subject. Valid values:
9
+ * - day: The existing conflicting rule has a daily period.
10
+ * - week: The existing conflicting rule has a weekly period.
11
+ * - month: The existing conflicting rule has a monthly period.
9
12
  *
10
13
  * @example
11
14
  * week
@@ -13,7 +16,9 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
13
16
  conflictPeriodType?: string;
14
17
  /**
15
18
  * @remarks
16
- * The type of the existing conflicting rule on the consumer. A value of calendar indicates the conflicting rule uses a calendar period. A value of epoch indicates the conflicting rule uses an epoch period.
19
+ * The type of the existing conflicting rule on the consumer subject. Valid values:
20
+ * - calendar: The existing conflicting rule uses a calendar period.
21
+ * - epoch: The existing conflicting rule uses a custom period.
17
22
  *
18
23
  * @example
19
24
  * calendar
@@ -21,7 +26,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
21
26
  conflictType?: string;
22
27
  /**
23
28
  * @remarks
24
- * The consumer ID.
29
+ * The conflicting consumer ID. You can use subjectId instead.
25
30
  *
26
31
  * @example
27
32
  * cs-xxxxxx
@@ -29,7 +34,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
29
34
  consumerId?: string;
30
35
  /**
31
36
  * @remarks
32
- * The consumer name.
37
+ * The conflicting consumer name. You can use subjectName instead.
33
38
  *
34
39
  * @example
35
40
  * consumer-a
@@ -95,7 +100,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
95
100
  export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
96
101
  /**
97
102
  * @remarks
98
- * The conflict hash.
103
+ * The conflict snapshot hash.
99
104
  *
100
105
  * @example
101
106
  * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
@@ -103,7 +108,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Mo
103
108
  conflictHash?: string;
104
109
  /**
105
110
  * @remarks
106
- * The list of conflicting subjects (consumers).
111
+ * The list of conflicting subjects (consumers or consumer groups).
107
112
  */
108
113
  items?: AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
109
114
  /**
@@ -145,7 +150,7 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Mo
145
150
  export class AddGatewayQuotaRuleResponseBodyData extends $dara.Model {
146
151
  /**
147
152
  * @remarks
148
- * Indicates whether the write request is accepted by the system. A value of false typically indicates a retryable scenario such as an unconfirmed conflict overwrite.
153
+ * Indicates whether the write request is accepted by the system. A value of false typically indicates a retryable scenario, such as an unconfirmed conflict overwrite.
149
154
  *
150
155
  * @example
151
156
  * true
@@ -221,7 +226,7 @@ export class AddGatewayQuotaRuleResponseBody extends $dara.Model {
221
226
  data?: AddGatewayQuotaRuleResponseBodyData;
222
227
  /**
223
228
  * @remarks
224
- * The message content.
229
+ * The response message.
225
230
  *
226
231
  * @example
227
232
  * success
@@ -229,7 +234,7 @@ export class AddGatewayQuotaRuleResponseBody extends $dara.Model {
229
234
  message?: string;
230
235
  /**
231
236
  * @remarks
232
- * The unique identifier of the request.
237
+ * The request ID.
233
238
  *
234
239
  * @example
235
240
  * 1234567890
@@ -36,8 +36,8 @@ export class GetDashboardRequest extends $dara.Model {
36
36
  /**
37
37
  * @remarks
38
38
  * The language. Valid values:
39
- * - zh: Chinese.
40
- * - en: English.
39
+ * - zh: Chinese
40
+ * - en: English
41
41
  *
42
42
  * @example
43
43
  * zh
@@ -59,8 +59,8 @@ export class GetDashboardRequest extends $dara.Model {
59
59
  /**
60
60
  * @remarks
61
61
  * The dashboard name. Valid values:
62
- * - LOG: access log.
63
- * - PLUGIN: plugin log.
62
+ * - LOG: access log
63
+ * - PLUGIN: plugin log
64
64
  *
65
65
  * @example
66
66
  * PLUGIN
@@ -93,7 +93,7 @@ export class GetDashboardRequest extends $dara.Model {
93
93
  /**
94
94
  * @remarks
95
95
  * The dashboard source. Valid values:
96
- * - SLS: log dashboard.
96
+ * - SLS: log dashboard
97
97
  *
98
98
  * @example
99
99
  * SLS
@@ -81,7 +81,7 @@ export class GetDashboardResponseBody extends $dara.Model {
81
81
  * The backend error code.
82
82
  *
83
83
  * @example
84
- * Ok
84
+ * CloudProductInactive.LogDeliveryNotEnabled
85
85
  */
86
86
  errorCode?: string;
87
87
  /**
@@ -89,7 +89,7 @@ export class GetDashboardResponseBody extends $dara.Model {
89
89
  * The error message.
90
90
  *
91
91
  * @example
92
- * success
92
+ * SLS log delivery configuration is not enabled.
93
93
  */
94
94
  message?: string;
95
95
  /**
@@ -6,8 +6,8 @@ export class GetDashboardShrinkRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
8
  * The language. Valid values:
9
- * - zh: Chinese.
10
- * - en: English.
9
+ * - zh: Chinese
10
+ * - en: English
11
11
  *
12
12
  * @example
13
13
  * zh
@@ -29,8 +29,8 @@ export class GetDashboardShrinkRequest extends $dara.Model {
29
29
  /**
30
30
  * @remarks
31
31
  * The dashboard name. Valid values:
32
- * - LOG: access log.
33
- * - PLUGIN: plugin log.
32
+ * - LOG: access log
33
+ * - PLUGIN: plugin log
34
34
  *
35
35
  * @example
36
36
  * PLUGIN
@@ -63,7 +63,7 @@ export class GetDashboardShrinkRequest extends $dara.Model {
63
63
  /**
64
64
  * @remarks
65
65
  * The dashboard source. Valid values:
66
- * - SLS: log dashboard.
66
+ * - SLS: log dashboard
67
67
  *
68
68
  * @example
69
69
  * SLS
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class GetGatewayQuotaRuleRequest extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The page number of the consumer list.
8
+ * The page number.
9
9
  *
10
10
  * @example
11
11
  * 1
@@ -15,7 +15,7 @@ export class GetGatewayQuotaRuleRequest extends $dara.Model {
15
15
  consumerPageNumber?: string;
16
16
  /**
17
17
  * @remarks
18
- * The page size of the consumer list.
18
+ * The page size.
19
19
  *
20
20
  * @example
21
21
  * 10
@@ -25,12 +25,12 @@ export class GetGatewayQuotaRuleRequest extends $dara.Model {
25
25
  consumerPageSize?: string;
26
26
  /**
27
27
  * @remarks
28
- * Specifies whether to return the consumer list.
28
+ * Specifies whether to return the API consumer list.
29
29
  */
30
30
  withConsumers?: boolean;
31
31
  /**
32
32
  * @remarks
33
- * Specifies whether to return the general subject list. This parameter applies to both consumer and consumer group rules.
33
+ * Specifies whether to return the general subject list. This parameter applies to both API consumer and API consumer group rules.
34
34
  */
35
35
  withSubjects?: boolean;
36
36
  static names(): { [key: string]: string } {