@alicloud/apig20240327 11.2.0 → 11.3.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 (61) hide show
  1. package/dist/client.d.ts +82 -58
  2. package/dist/client.js +121 -85
  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 +19 -3
  14. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.js +4 -0
  15. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.js.map +1 -1
  16. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.d.ts +75 -5
  17. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.js +18 -0
  18. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.js.map +1 -1
  19. package/dist/models/HttpApiApiInfo.d.ts +1 -1
  20. package/dist/models/HttpApiApiInfoDeployCntMapValue.d.ts +1 -1
  21. package/dist/models/HttpRoute.d.ts +4 -1
  22. package/dist/models/HttpRoute.js.map +1 -1
  23. package/dist/models/ListConsumerGroupQuotaRulesRequest.d.ts +33 -0
  24. package/dist/models/ListConsumerGroupQuotaRulesRequest.js +64 -0
  25. package/dist/models/ListConsumerGroupQuotaRulesRequest.js.map +1 -0
  26. package/dist/models/ListConsumerGroupQuotaRulesResponse.d.ts +19 -0
  27. package/dist/models/ListConsumerGroupQuotaRulesResponse.js +69 -0
  28. package/dist/models/ListConsumerGroupQuotaRulesResponse.js.map +1 -0
  29. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.d.ts +132 -0
  30. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js +134 -0
  31. package/dist/models/ListConsumerGroupQuotaRulesResponseBody.js.map +1 -0
  32. package/dist/models/ResetGatewayQuotaRuleRequest.d.ts +9 -10
  33. package/dist/models/ResetGatewayQuotaRuleRequest.js.map +1 -1
  34. package/dist/models/ResetGatewayQuotaRuleResponseBody.d.ts +16 -16
  35. package/dist/models/UpdateGatewayQuotaRuleRequest.d.ts +8 -8
  36. package/dist/models/UpdateGatewayQuotaRuleResponseBody.d.ts +12 -12
  37. package/dist/models/model.d.ts +5 -0
  38. package/dist/models/model.js +26 -16
  39. package/dist/models/model.js.map +1 -1
  40. package/package.json +1 -1
  41. package/src/client.ts +129 -85
  42. package/src/models/AddGatewayQuotaRuleRequest.ts +20 -14
  43. package/src/models/AddGatewayQuotaRuleResponseBody.ts +14 -9
  44. package/src/models/GetDashboardRequest.ts +5 -5
  45. package/src/models/GetDashboardResponseBody.ts +2 -2
  46. package/src/models/GetDashboardShrinkRequest.ts +5 -5
  47. package/src/models/GetGatewayQuotaRuleRequest.ts +4 -4
  48. package/src/models/GetGatewayQuotaRuleResponseBody.ts +4 -4
  49. package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts +23 -3
  50. package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts +93 -5
  51. package/src/models/HttpApiApiInfo.ts +1 -1
  52. package/src/models/HttpApiApiInfoDeployCntMapValue.ts +1 -1
  53. package/src/models/HttpRoute.ts +4 -1
  54. package/src/models/ListConsumerGroupQuotaRulesRequest.ts +52 -0
  55. package/src/models/ListConsumerGroupQuotaRulesResponse.ts +40 -0
  56. package/src/models/ListConsumerGroupQuotaRulesResponseBody.ts +203 -0
  57. package/src/models/ResetGatewayQuotaRuleRequest.ts +9 -10
  58. package/src/models/ResetGatewayQuotaRuleResponseBody.ts +16 -16
  59. package/src/models/UpdateGatewayQuotaRuleRequest.ts +8 -8
  60. package/src/models/UpdateGatewayQuotaRuleResponseBody.ts +12 -12
  61. package/src/models/model.ts +5 -0
package/dist/client.d.ts CHANGED
@@ -12,15 +12,15 @@ export default class Client extends OpenApi {
12
12
  * Creates a gateway quota throttling rule.
13
13
  *
14
14
  * @remarks
15
- * Creates a consumer-based quota rule for an AI gateway. This operation applies only to AI gateways running version 2.1.19 or later.
15
+ * 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.
16
16
  * >
17
- * > Recommended call logic:
18
- * > - 1. Perform a dry run to check for rule conflicts.
19
- * > - - Set dryRun=true.
20
- * > - - The response contains a conflict preview with conflictHash.
21
- * > - 2. Submit the request after confirmation.
22
- * > - - No conflicts: dryRun=false, overwrite=false.
23
- * > - - Conflicts exist and you confirm overwrite: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
17
+ * > Recommended call sequence:
18
+ * > - Step 1: Perform a dry run to check for rule conflicts.
19
+ * > - - Set dryRun to true.
20
+ * > - - The response returns a conflict preview that contains the conflictHash value.
21
+ * > - Step 2: Submit the request after confirmation.
22
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
23
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
24
24
  *
25
25
  * @param request - AddGatewayQuotaRuleRequest
26
26
  * @param headers - map
@@ -34,15 +34,15 @@ export default class Client extends OpenApi {
34
34
  * Creates a gateway quota throttling rule.
35
35
  *
36
36
  * @remarks
37
- * Creates a consumer-based quota rule for an AI gateway. This operation applies only to AI gateways running version 2.1.19 or later.
37
+ * 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.
38
38
  * >
39
- * > Recommended call logic:
40
- * > - 1. Perform a dry run to check for rule conflicts.
41
- * > - - Set dryRun=true.
42
- * > - - The response contains a conflict preview with conflictHash.
43
- * > - 2. Submit the request after confirmation.
44
- * > - - No conflicts: dryRun=false, overwrite=false.
45
- * > - - Conflicts exist and you confirm overwrite: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
39
+ * > Recommended call sequence:
40
+ * > - Step 1: Perform a dry run to check for rule conflicts.
41
+ * > - - Set dryRun to true.
42
+ * > - - The response returns a conflict preview that contains the conflictHash value.
43
+ * > - Step 2: Submit the request after confirmation.
44
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
45
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
46
46
  *
47
47
  * @param request - AddGatewayQuotaRuleRequest
48
48
  * @returns AddGatewayQuotaRuleResponse
@@ -837,7 +837,7 @@ export default class Client extends OpenApi {
837
837
  * Deletes a quota throttling rule from a gateway.
838
838
  *
839
839
  * @remarks
840
- * 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.
840
+ * 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.
841
841
  *
842
842
  * @param request - DeleteGatewayQuotaRuleRequest
843
843
  * @param headers - map
@@ -851,7 +851,7 @@ export default class Client extends OpenApi {
851
851
  * Deletes a quota throttling rule from a gateway.
852
852
  *
853
853
  * @remarks
854
- * 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.
854
+ * 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.
855
855
  *
856
856
  * @param request - DeleteGatewayQuotaRuleRequest
857
857
  * @returns DeleteGatewayQuotaRuleResponse
@@ -1390,10 +1390,10 @@ export default class Client extends OpenApi {
1390
1390
  */
1391
1391
  getGatewayElasticPolicy(gatewayId: string, request: $_model.GetGatewayElasticPolicyRequest): Promise<$_model.GetGatewayElasticPolicyResponse>;
1392
1392
  /**
1393
- * Queries the details of a gateway quota rate limiting rule.
1393
+ * Queries the details of a gateway quota throttling rule.
1394
1394
  *
1395
1395
  * @remarks
1396
- * Queries the details of a consumer quota rule on an AI gateway.
1396
+ * Queries a specific API consumer quota rule on an AI gateway.
1397
1397
  *
1398
1398
  * @param request - GetGatewayQuotaRuleRequest
1399
1399
  * @param headers - map
@@ -1404,10 +1404,10 @@ export default class Client extends OpenApi {
1404
1404
  [key: string]: string;
1405
1405
  }, runtime: $dara.RuntimeOptions): Promise<$_model.GetGatewayQuotaRuleResponse>;
1406
1406
  /**
1407
- * Queries the details of a gateway quota rate limiting rule.
1407
+ * Queries the details of a gateway quota throttling rule.
1408
1408
  *
1409
1409
  * @remarks
1410
- * Queries the details of a consumer quota rule on an AI gateway.
1410
+ * Queries a specific API consumer quota rule on an AI gateway.
1411
1411
  *
1412
1412
  * @param request - GetGatewayQuotaRuleRequest
1413
1413
  * @returns GetGatewayQuotaRuleResponse
@@ -1417,7 +1417,7 @@ export default class Client extends OpenApi {
1417
1417
  * 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.
1418
1418
  *
1419
1419
  * @remarks
1420
- * 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.
1420
+ * Queries the usage details of a specific subject under a quota rule. This operation takes effect only for AI gateways with a version later than 2.1.19.
1421
1421
  *
1422
1422
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
1423
1423
  * @param headers - map
@@ -1431,7 +1431,7 @@ export default class Client extends OpenApi {
1431
1431
  * 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.
1432
1432
  *
1433
1433
  * @remarks
1434
- * 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.
1434
+ * Queries the usage details of a specific subject under a quota rule. This operation takes effect only for AI gateways with a version later than 2.1.19.
1435
1435
  *
1436
1436
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
1437
1437
  * @returns GetGatewayQuotaRuleSubjectUsageResponse
@@ -1904,6 +1904,30 @@ export default class Client extends OpenApi {
1904
1904
  * @returns ListConsumerGroupConsumersResponse
1905
1905
  */
1906
1906
  listConsumerGroupConsumers(consumerGroupId: string, request: $_model.ListConsumerGroupConsumersRequest): Promise<$_model.ListConsumerGroupConsumersResponse>;
1907
+ /**
1908
+ * 查询消费者组配额限流规则列表
1909
+ *
1910
+ * @remarks
1911
+ * 查询指定消费者组直接绑定的配额规则,不展开组内消费者个人绑定的规则;无直接绑定关系时返回空列表。
1912
+ *
1913
+ * @param request - ListConsumerGroupQuotaRulesRequest
1914
+ * @param headers - map
1915
+ * @param runtime - runtime options for this request RuntimeOptions
1916
+ * @returns ListConsumerGroupQuotaRulesResponse
1917
+ */
1918
+ listConsumerGroupQuotaRulesWithOptions(consumerGroupId: string, request: $_model.ListConsumerGroupQuotaRulesRequest, headers: {
1919
+ [key: string]: string;
1920
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.ListConsumerGroupQuotaRulesResponse>;
1921
+ /**
1922
+ * 查询消费者组配额限流规则列表
1923
+ *
1924
+ * @remarks
1925
+ * 查询指定消费者组直接绑定的配额规则,不展开组内消费者个人绑定的规则;无直接绑定关系时返回空列表。
1926
+ *
1927
+ * @param request - ListConsumerGroupQuotaRulesRequest
1928
+ * @returns ListConsumerGroupQuotaRulesResponse
1929
+ */
1930
+ listConsumerGroupQuotaRules(consumerGroupId: string, request: $_model.ListConsumerGroupQuotaRulesRequest): Promise<$_model.ListConsumerGroupQuotaRulesResponse>;
1907
1931
  /**
1908
1932
  * Queries the list of consumer groups.
1909
1933
  *
@@ -2110,10 +2134,10 @@ export default class Client extends OpenApi {
2110
2134
  */
2111
2135
  listGatewayLoadBalancers(gatewayId: string, request: $_model.ListGatewayLoadBalancersRequest): Promise<$_model.ListGatewayLoadBalancersResponse>;
2112
2136
  /**
2113
- * Queries the list of consumer quota rules bound to a gateway.
2137
+ * Queries the list of FinOps quota rules bound to a gateway.
2114
2138
  *
2115
2139
  * @remarks
2116
- * Queries the list of consumer quota rules bound to a gateway.
2140
+ * Queries the list of FinOps quota rules bound to a gateway.
2117
2141
  *
2118
2142
  * @param request - ListGatewayQuotaRulesRequest
2119
2143
  * @param headers - map
@@ -2124,10 +2148,10 @@ export default class Client extends OpenApi {
2124
2148
  [key: string]: string;
2125
2149
  }, runtime: $dara.RuntimeOptions): Promise<$_model.ListGatewayQuotaRulesResponse>;
2126
2150
  /**
2127
- * Queries the list of consumer quota rules bound to a gateway.
2151
+ * Queries the list of FinOps quota rules bound to a gateway.
2128
2152
  *
2129
2153
  * @remarks
2130
- * Queries the list of consumer quota rules bound to a gateway.
2154
+ * Queries the list of FinOps quota rules bound to a gateway.
2131
2155
  *
2132
2156
  * @param request - ListGatewayQuotaRulesRequest
2133
2157
  * @returns ListGatewayQuotaRulesResponse
@@ -2680,15 +2704,15 @@ export default class Client extends OpenApi {
2680
2704
  * Resets a quota throttling rule on a gateway.
2681
2705
  *
2682
2706
  * @remarks
2683
- * 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.
2707
+ * 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.
2684
2708
  * >
2685
2709
  * > Recommended call logic:
2686
2710
  * > - 1. Perform a dry run to check for rule conflicts.
2687
- * > - - Set dryRun=true.
2688
- * > - - The response contains a conflict preview with conflictHash.
2689
- * > - 2. Submit the request after confirmation.
2690
- * > - - No conflict: dryRun=false, overwrite=false.
2691
- * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
2711
+ * > - - Set dryRun to true.
2712
+ * > - - The response contains a conflict preview with a conflictHash value.
2713
+ * > - 2. Confirm and submit the request.
2714
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
2715
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
2692
2716
  *
2693
2717
  * @param request - ResetGatewayQuotaRuleRequest
2694
2718
  * @param headers - map
@@ -2702,15 +2726,15 @@ export default class Client extends OpenApi {
2702
2726
  * Resets a quota throttling rule on a gateway.
2703
2727
  *
2704
2728
  * @remarks
2705
- * 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.
2729
+ * 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.
2706
2730
  * >
2707
2731
  * > Recommended call logic:
2708
2732
  * > - 1. Perform a dry run to check for rule conflicts.
2709
- * > - - Set dryRun=true.
2710
- * > - - The response contains a conflict preview with conflictHash.
2711
- * > - 2. Submit the request after confirmation.
2712
- * > - - No conflict: dryRun=false, overwrite=false.
2713
- * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
2733
+ * > - - Set dryRun to true.
2734
+ * > - - The response contains a conflict preview with a conflictHash value.
2735
+ * > - 2. Confirm and submit the request.
2736
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
2737
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
2714
2738
  *
2715
2739
  * @param request - ResetGatewayQuotaRuleRequest
2716
2740
  * @returns ResetGatewayQuotaRuleResponse
@@ -3124,17 +3148,17 @@ export default class Client extends OpenApi {
3124
3148
  */
3125
3149
  updateGatewayName(gatewayId: string, request: $_model.UpdateGatewayNameRequest): Promise<$_model.UpdateGatewayNameResponse>;
3126
3150
  /**
3127
- * Edits a quota rate-limiting rule on a gateway.
3151
+ * Edits a quota throttling rule on a gateway.
3128
3152
  *
3129
3153
  * @remarks
3130
- * 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.
3131
- * > Recommended call logic:
3132
- * > - 1. Perform a dry run to check for rule conflicts.
3154
+ * 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.
3155
+ * > Recommended call sequence:
3156
+ * > - Step 1: Perform a dry run to check for rule conflicts.
3133
3157
  * > - - Set dryRun to true.
3134
- * > - - The response contains a conflict preview with conflictHash.
3135
- * > - 2. Submit the request after confirmation.
3136
- * > - - No conflict: Set dryRun to false and overwrite to false.
3137
- * > - - Conflict exists and overwrite confirmed: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3158
+ * > - - The response returns a conflict preview that contains conflictHash.
3159
+ * > - Step 2: Confirm and submit the request.
3160
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
3161
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3138
3162
  *
3139
3163
  * @param request - UpdateGatewayQuotaRuleRequest
3140
3164
  * @param headers - map
@@ -3145,17 +3169,17 @@ export default class Client extends OpenApi {
3145
3169
  [key: string]: string;
3146
3170
  }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateGatewayQuotaRuleResponse>;
3147
3171
  /**
3148
- * Edits a quota rate-limiting rule on a gateway.
3172
+ * Edits a quota throttling rule on a gateway.
3149
3173
  *
3150
3174
  * @remarks
3151
- * 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.
3152
- * > Recommended call logic:
3153
- * > - 1. Perform a dry run to check for rule conflicts.
3175
+ * 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.
3176
+ * > Recommended call sequence:
3177
+ * > - Step 1: Perform a dry run to check for rule conflicts.
3154
3178
  * > - - Set dryRun to true.
3155
- * > - - The response contains a conflict preview with conflictHash.
3156
- * > - 2. Submit the request after confirmation.
3157
- * > - - No conflict: Set dryRun to false and overwrite to false.
3158
- * > - - Conflict exists and overwrite confirmed: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3179
+ * > - - The response returns a conflict preview that contains conflictHash.
3180
+ * > - Step 2: Confirm and submit the request.
3181
+ * > - - No conflicts: Set dryRun to false and overwrite to false.
3182
+ * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3159
3183
  *
3160
3184
  * @param request - UpdateGatewayQuotaRuleRequest
3161
3185
  * @returns UpdateGatewayQuotaRuleResponse
@@ -3165,7 +3189,7 @@ export default class Client extends OpenApi {
3165
3189
  * Enables or disables a quota throttling rule for a gateway.
3166
3190
  *
3167
3191
  * @remarks
3168
- * 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.
3192
+ * 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.
3169
3193
  *
3170
3194
  * @param request - UpdateGatewayQuotaRuleStatusRequest
3171
3195
  * @param headers - map
@@ -3179,7 +3203,7 @@ export default class Client extends OpenApi {
3179
3203
  * Enables or disables a quota throttling rule for a gateway.
3180
3204
  *
3181
3205
  * @remarks
3182
- * 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.
3206
+ * 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.
3183
3207
  *
3184
3208
  * @param request - UpdateGatewayQuotaRuleStatusRequest
3185
3209
  * @returns UpdateGatewayQuotaRuleStatusResponse