@alicloud/apig20240327 11.3.5 → 11.4.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 (39) hide show
  1. package/dist/client.d.ts +34 -8
  2. package/dist/client.js +53 -8
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/GetDashboardRequest.d.ts +10 -6
  5. package/dist/models/GetDashboardRequest.js.map +1 -1
  6. package/dist/models/GetDashboardResponseBody.d.ts +2 -2
  7. package/dist/models/GetDashboardShrinkRequest.d.ts +10 -6
  8. package/dist/models/GetDashboardShrinkRequest.js.map +1 -1
  9. package/dist/models/GetGatewayQuotaRuleSubjectUsageRequest.d.ts +3 -3
  10. package/dist/models/GetGatewayQuotaRuleSubjectUsageResponseBody.d.ts +9 -9
  11. package/dist/models/GetGatewayResourceQuotaUsageRequest.d.ts +13 -0
  12. package/dist/models/GetGatewayResourceQuotaUsageRequest.js +54 -0
  13. package/dist/models/GetGatewayResourceQuotaUsageRequest.js.map +1 -0
  14. package/dist/models/GetGatewayResourceQuotaUsageResponse.d.ts +19 -0
  15. package/dist/models/GetGatewayResourceQuotaUsageResponse.js +69 -0
  16. package/dist/models/GetGatewayResourceQuotaUsageResponse.js.map +1 -0
  17. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.d.ts +141 -0
  18. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.js +122 -0
  19. package/dist/models/GetGatewayResourceQuotaUsageResponseBody.js.map +1 -0
  20. package/dist/models/UpdateConsumerAuthorizationRuleResponseBody.d.ts +1 -1
  21. package/dist/models/UpdateGatewayQuotaRuleRequest.d.ts +7 -7
  22. package/dist/models/UpdateGatewayQuotaRuleResponseBody.d.ts +13 -13
  23. package/dist/models/model.d.ts +5 -0
  24. package/dist/models/model.js +28 -18
  25. package/dist/models/model.js.map +1 -1
  26. package/package.json +1 -1
  27. package/src/client.ts +55 -8
  28. package/src/models/GetDashboardRequest.ts +10 -6
  29. package/src/models/GetDashboardResponseBody.ts +2 -2
  30. package/src/models/GetDashboardShrinkRequest.ts +10 -6
  31. package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts +3 -3
  32. package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts +9 -9
  33. package/src/models/GetGatewayResourceQuotaUsageRequest.ts +24 -0
  34. package/src/models/GetGatewayResourceQuotaUsageResponse.ts +40 -0
  35. package/src/models/GetGatewayResourceQuotaUsageResponseBody.ts +200 -0
  36. package/src/models/UpdateConsumerAuthorizationRuleResponseBody.ts +1 -1
  37. package/src/models/UpdateGatewayQuotaRuleRequest.ts +7 -7
  38. package/src/models/UpdateGatewayQuotaRuleResponseBody.ts +13 -13
  39. package/src/models/model.ts +5 -0
package/dist/client.d.ts CHANGED
@@ -1417,7 +1417,8 @@ 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
- * 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.
1420
+ * 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.
1421
+ * Before you begin: Before calling this operation, make sure that Simple Log Service log delivery is enabled for the target gateway by calling UpdateGatewayFeature (name=log-config, value={"enable":true}). Otherwise, the error CloudProductInactive.LogDeliveryNotEnabled is returned.
1421
1422
  *
1422
1423
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
1423
1424
  * @param headers - map
@@ -1431,12 +1432,37 @@ export default class Client extends OpenApi {
1431
1432
  * 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
1433
  *
1433
1434
  * @remarks
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
+ * 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.
1436
+ * Before you begin: Before calling this operation, make sure that Simple Log Service log delivery is enabled for the target gateway by calling UpdateGatewayFeature (name=log-config, value={"enable":true}). Otherwise, the error CloudProductInactive.LogDeliveryNotEnabled is returned.
1435
1437
  *
1436
1438
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
1437
1439
  * @returns GetGatewayQuotaRuleSubjectUsageResponse
1438
1440
  */
1439
1441
  getGatewayQuotaRuleSubjectUsage(gatewayId: string, ruleId: string, subjectId: string, request: $_model.GetGatewayQuotaRuleSubjectUsageRequest): Promise<$_model.GetGatewayQuotaRuleSubjectUsageResponse>;
1442
+ /**
1443
+ * 查询网关资源配额与用量
1444
+ *
1445
+ * @remarks
1446
+ * 查询指定 API 网关或 AI 网关的九项资源配额用量、有效上限及统计范围。接口只读,成功响应包含全部九项;自定义插件配额暂不展示数值。该结果是各来源独立读取的当前观测,不保证新增资源一定成功。
1447
+ *
1448
+ * @param request - GetGatewayResourceQuotaUsageRequest
1449
+ * @param headers - map
1450
+ * @param runtime - runtime options for this request RuntimeOptions
1451
+ * @returns GetGatewayResourceQuotaUsageResponse
1452
+ */
1453
+ getGatewayResourceQuotaUsageWithOptions(gatewayId: string, request: $_model.GetGatewayResourceQuotaUsageRequest, headers: {
1454
+ [key: string]: string;
1455
+ }, runtime: $dara.RuntimeOptions): Promise<$_model.GetGatewayResourceQuotaUsageResponse>;
1456
+ /**
1457
+ * 查询网关资源配额与用量
1458
+ *
1459
+ * @remarks
1460
+ * 查询指定 API 网关或 AI 网关的九项资源配额用量、有效上限及统计范围。接口只读,成功响应包含全部九项;自定义插件配额暂不展示数值。该结果是各来源独立读取的当前观测,不保证新增资源一定成功。
1461
+ *
1462
+ * @param request - GetGatewayResourceQuotaUsageRequest
1463
+ * @returns GetGatewayResourceQuotaUsageResponse
1464
+ */
1465
+ getGatewayResourceQuotaUsage(gatewayId: string, request: $_model.GetGatewayResourceQuotaUsageRequest): Promise<$_model.GetGatewayResourceQuotaUsageResponse>;
1440
1466
  /**
1441
1467
  * Retrieves the information of an HTTP API.
1442
1468
  *
@@ -3151,12 +3177,12 @@ export default class Client extends OpenApi {
3151
3177
  * Edits a quota throttling rule on a gateway.
3152
3178
  *
3153
3179
  * @remarks
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.
3180
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways running version 2.1.21 or later. Editing a rule preserves the historical usage of consumer subjects bound to the rule.
3155
3181
  * > Recommended call sequence:
3156
3182
  * > - Step 1: Perform a dry run to check for rule conflicts.
3157
3183
  * > - - Set dryRun to true.
3158
- * > - - The response returns a conflict preview that contains conflictHash.
3159
- * > - Step 2: Confirm and submit the request.
3184
+ * > - - The response contains a conflict preview with a conflictHash value.
3185
+ * > - Step 2: Confirm and submit the changes.
3160
3186
  * > - - No conflicts: Set dryRun to false and overwrite to false.
3161
3187
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3162
3188
  *
@@ -3172,12 +3198,12 @@ export default class Client extends OpenApi {
3172
3198
  * Edits a quota throttling rule on a gateway.
3173
3199
  *
3174
3200
  * @remarks
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.
3201
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways running version 2.1.21 or later. Editing a rule preserves the historical usage of consumer subjects bound to the rule.
3176
3202
  * > Recommended call sequence:
3177
3203
  * > - Step 1: Perform a dry run to check for rule conflicts.
3178
3204
  * > - - Set dryRun to true.
3179
- * > - - The response returns a conflict preview that contains conflictHash.
3180
- * > - Step 2: Confirm and submit the request.
3205
+ * > - - The response contains a conflict preview with a conflictHash value.
3206
+ * > - Step 2: Confirm and submit the changes.
3181
3207
  * > - - No conflicts: Set dryRun to false and overwrite to false.
3182
3208
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
3183
3209
  *
package/dist/client.js CHANGED
@@ -3744,7 +3744,8 @@ class Client extends openapi_core_1.default {
3744
3744
  * 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.
3745
3745
  *
3746
3746
  * @remarks
3747
- * 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.
3747
+ * 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.
3748
+ * Before you begin: Before calling this operation, make sure that Simple Log Service log delivery is enabled for the target gateway by calling UpdateGatewayFeature (name=log-config, value={"enable":true}). Otherwise, the error CloudProductInactive.LogDeliveryNotEnabled is returned.
3748
3749
  *
3749
3750
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
3750
3751
  * @param headers - map
@@ -3790,7 +3791,8 @@ class Client extends openapi_core_1.default {
3790
3791
  * 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.
3791
3792
  *
3792
3793
  * @remarks
3793
- * 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.
3794
+ * 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.
3795
+ * Before you begin: Before calling this operation, make sure that Simple Log Service log delivery is enabled for the target gateway by calling UpdateGatewayFeature (name=log-config, value={"enable":true}). Otherwise, the error CloudProductInactive.LogDeliveryNotEnabled is returned.
3794
3796
  *
3795
3797
  * @param request - GetGatewayQuotaRuleSubjectUsageRequest
3796
3798
  * @returns GetGatewayQuotaRuleSubjectUsageResponse
@@ -3800,6 +3802,49 @@ class Client extends openapi_core_1.default {
3800
3802
  let headers = {};
3801
3803
  return await this.getGatewayQuotaRuleSubjectUsageWithOptions(gatewayId, ruleId, subjectId, request, headers, runtime);
3802
3804
  }
3805
+ /**
3806
+ * 查询网关资源配额与用量
3807
+ *
3808
+ * @remarks
3809
+ * 查询指定 API 网关或 AI 网关的九项资源配额用量、有效上限及统计范围。接口只读,成功响应包含全部九项;自定义插件配额暂不展示数值。该结果是各来源独立读取的当前观测,不保证新增资源一定成功。
3810
+ *
3811
+ * @param request - GetGatewayResourceQuotaUsageRequest
3812
+ * @param headers - map
3813
+ * @param runtime - runtime options for this request RuntimeOptions
3814
+ * @returns GetGatewayResourceQuotaUsageResponse
3815
+ */
3816
+ async getGatewayResourceQuotaUsageWithOptions(gatewayId, request, headers, runtime) {
3817
+ request.validate();
3818
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
3819
+ headers: headers,
3820
+ });
3821
+ let params = new openapi_core_2.$OpenApiUtil.Params({
3822
+ action: "GetGatewayResourceQuotaUsage",
3823
+ version: "2024-03-27",
3824
+ protocol: "HTTPS",
3825
+ pathname: `/v1/gateways/${$dara.URL.percentEncode(gatewayId)}/resource-quota-usage`,
3826
+ method: "GET",
3827
+ authType: "AK",
3828
+ style: "ROA",
3829
+ reqBodyType: "json",
3830
+ bodyType: "json",
3831
+ });
3832
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetGatewayResourceQuotaUsageResponse({}));
3833
+ }
3834
+ /**
3835
+ * 查询网关资源配额与用量
3836
+ *
3837
+ * @remarks
3838
+ * 查询指定 API 网关或 AI 网关的九项资源配额用量、有效上限及统计范围。接口只读,成功响应包含全部九项;自定义插件配额暂不展示数值。该结果是各来源独立读取的当前观测,不保证新增资源一定成功。
3839
+ *
3840
+ * @param request - GetGatewayResourceQuotaUsageRequest
3841
+ * @returns GetGatewayResourceQuotaUsageResponse
3842
+ */
3843
+ async getGatewayResourceQuotaUsage(gatewayId, request) {
3844
+ let runtime = new $dara.RuntimeOptions({});
3845
+ let headers = {};
3846
+ return await this.getGatewayResourceQuotaUsageWithOptions(gatewayId, request, headers, runtime);
3847
+ }
3803
3848
  /**
3804
3849
  * Retrieves the information of an HTTP API.
3805
3850
  *
@@ -8482,12 +8527,12 @@ class Client extends openapi_core_1.default {
8482
8527
  * Edits a quota throttling rule on a gateway.
8483
8528
  *
8484
8529
  * @remarks
8485
- * 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.
8530
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways running version 2.1.21 or later. Editing a rule preserves the historical usage of consumer subjects bound to the rule.
8486
8531
  * > Recommended call sequence:
8487
8532
  * > - Step 1: Perform a dry run to check for rule conflicts.
8488
8533
  * > - - Set dryRun to true.
8489
- * > - - The response returns a conflict preview that contains conflictHash.
8490
- * > - Step 2: Confirm and submit the request.
8534
+ * > - - The response contains a conflict preview with a conflictHash value.
8535
+ * > - Step 2: Confirm and submit the changes.
8491
8536
  * > - - No conflicts: Set dryRun to false and overwrite to false.
8492
8537
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
8493
8538
  *
@@ -8544,12 +8589,12 @@ class Client extends openapi_core_1.default {
8544
8589
  * Edits a quota throttling rule on a gateway.
8545
8590
  *
8546
8591
  * @remarks
8547
- * 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.
8592
+ * Edits a quota rule on a gateway. This operation takes effect only on AI gateways running version 2.1.21 or later. Editing a rule preserves the historical usage of consumer subjects bound to the rule.
8548
8593
  * > Recommended call sequence:
8549
8594
  * > - Step 1: Perform a dry run to check for rule conflicts.
8550
8595
  * > - - Set dryRun to true.
8551
- * > - - The response returns a conflict preview that contains conflictHash.
8552
- * > - Step 2: Confirm and submit the request.
8596
+ * > - - The response contains a conflict preview with a conflictHash value.
8597
+ * > - Step 2: Confirm and submit the changes.
8553
8598
  * > - - No conflicts: Set dryRun to false and overwrite to false.
8554
8599
  * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
8555
8600
  *