@alicloud/apig20240327 9.3.0 → 10.0.0

package/dist/client.js

@@ -92,15 +92,15 @@ class Client extends openapi_core_1.default {
      * Creates a gateway quota throttling rule.
      *
      * @remarks
-     * This operation adds a consumer-based quota rule to an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
+     * Creates a consumer-based quota rule for an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
      * >
-     * >  Recommended call logic:
-     * > - 1. Perform a dry run to check for rule conflicts.
-     * > - - Set dryRun=true.
-     * > - - The response contains a conflict preview with conflictHash.
-     * > - 2. Submit the request after confirmation.
-     * > - - No conflict: dryRun=false, overwrite=false.
-     * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
+     * >  Recommended call sequence:
+     * > - Step 1: Perform a dry run to check for rule conflicts.
+     * > - - Set dryRun to true.
+     * > - - The response contains a conflict preview with a conflictHash value.
+     * > - Step 2: Submit the request after confirmation.
+     * > - - No conflicts: Set dryRun to false and overwrite to false.
+     * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
      *
      * @param request - AddGatewayQuotaRuleRequest
      * @param headers - map
@@ -167,15 +167,15 @@ class Client extends openapi_core_1.default {
      * Creates a gateway quota throttling rule.
      *
      * @remarks
-     * This operation adds a consumer-based quota rule to an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
+     * Creates a consumer-based quota rule for an AI gateway. This operation takes effect only on AI gateways of version 2.1.19 or later.
      * >
-     * >  Recommended call logic:
-     * > - 1. Perform a dry run to check for rule conflicts.
-     * > - - Set dryRun=true.
-     * > - - The response contains a conflict preview with conflictHash.
-     * > - 2. Submit the request after confirmation.
-     * > - - No conflict: dryRun=false, overwrite=false.
-     * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
+     * >  Recommended call sequence:
+     * > - Step 1: Perform a dry run to check for rule conflicts.
+     * > - - Set dryRun to true.
+     * > - - The response contains a conflict preview with a conflictHash value.
+     * > - Step 2: Submit the request after confirmation.
+     * > - - No conflicts: Set dryRun to false and overwrite to false.
+     * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
      *
      * @param request - AddGatewayQuotaRuleRequest
      * @returns AddGatewayQuotaRuleResponse
@@ -186,7 +186,7 @@ class Client extends openapi_core_1.default {
         return await this.addGatewayQuotaRuleWithOptions(gatewayId, request, headers, runtime);
     }
     /**
-     * Authorizes a security group to allow gateway access to services.
+     * Authorizes a security group that allows a gateway to access services.
      *
      * @param request - AddGatewaySecurityGroupRuleRequest
      * @param headers - map
@@ -223,7 +223,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.AddGatewaySecurityGroupRuleResponse({}));
     }
     /**
-     * Authorizes a security group to allow gateway access to services.
+     * Authorizes a security group that allows a gateway to access services.
      *
      * @param request - AddGatewaySecurityGroupRuleRequest
      * @returns AddGatewaySecurityGroupRuleResponse
@@ -276,7 +276,7 @@ class Client extends openapi_core_1.default {
         return await this.batchDeleteConsumerAuthorizationRuleWithOptions(request, headers, runtime);
     }
     /**
-     * Transfers a resource to a different resource group.
+     * Moves a resource to a different resource group.
      *
      * @param request - ChangeResourceGroupRequest
      * @param headers - map
@@ -316,7 +316,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ChangeResourceGroupResponse({}));
     }
     /**
-     * Transfers a resource to a different resource group.
+     * Moves a resource to a different resource group.
      *
      * @param request - ChangeResourceGroupRequest
      * @returns ChangeResourceGroupResponse
@@ -1274,7 +1274,7 @@ class Client extends openapi_core_1.default {
         return await this.createPolicyWithOptions(request, headers, runtime);
     }
     /**
-     * Creates a policy attachment.
+     * Creates a policy attachment to a resource.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @param headers - map
@@ -1317,7 +1317,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreatePolicyAttachmentResponse({}));
     }
     /**
-     * Creates a policy attachment.
+     * Creates a policy attachment to a resource.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @returns CreatePolicyAttachmentResponse
@@ -1719,7 +1719,7 @@ class Client extends openapi_core_1.default {
      * Deletes a quota throttling rule from a gateway.
      *
      * @remarks
-     * Deletes a consumer-based quota rule from an AI gateway. This operation applies only to AI gateways of version 2.1.19 or later.
+     * 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.
      *
      * @param request - DeleteGatewayQuotaRuleRequest
      * @param headers - map
@@ -1748,7 +1748,7 @@ class Client extends openapi_core_1.default {
      * Deletes a quota throttling rule from a gateway.
      *
      * @remarks
-     * Deletes a consumer-based quota rule from an AI gateway. This operation applies only to AI gateways of version 2.1.19 or later.
+     * 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.
      *
      * @param request - DeleteGatewayQuotaRuleRequest
      * @returns DeleteGatewayQuotaRuleResponse
@@ -1759,7 +1759,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteGatewayQuotaRuleWithOptions(gatewayId, ruleId, request, headers, runtime);
     }
     /**
-     * Deletes a gateway security group rule.
+     * Deletes a security group rule from a gateway.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @param headers - map
@@ -1790,7 +1790,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteGatewaySecurityGroupRuleResponse({}));
     }
     /**
-     * Deletes a gateway security group rule.
+     * Deletes a security group rule from a gateway.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @returns DeleteGatewaySecurityGroupRuleResponse
@@ -1965,6 +1965,43 @@ class Client extends openapi_core_1.default {
         let headers = {};
         return await this.deletePluginAttachmentWithOptions(pluginAttachmentId, headers, runtime);
     }
+    /**
+     * DeletePluginClass
+     *
+     * @param request - DeletePluginClassRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeletePluginClassResponse
+     */
+    async deletePluginClassWithOptions(pluginClassId, request, headers, runtime) {
+        request.validate();
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            headers: headers,
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DeletePluginClass",
+            version: "2024-03-27",
+            protocol: "HTTPS",
+            pathname: `/v1/plugin-classes/${$dara.URL.percentEncode(pluginClassId)}`,
+            method: "DELETE",
+            authType: "AK",
+            style: "ROA",
+            reqBodyType: "json",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeletePluginClassResponse({}));
+    }
+    /**
+     * DeletePluginClass
+     *
+     * @param request - DeletePluginClassRequest
+     * @returns DeletePluginClassResponse
+     */
+    async deletePluginClass(pluginClassId, request) {
+        let runtime = new $dara.RuntimeOptions({});
+        let headers = {};
+        return await this.deletePluginClassWithOptions(pluginClassId, request, headers, runtime);
+    }
     /**
      * Deletes a policy.
      *
@@ -2570,7 +2607,7 @@ class Client extends openapi_core_1.default {
         return await this.getEnvironmentWithOptions(environmentId, request, headers, runtime);
     }
     /**
-     * Queries the basic information about an instance, such as the virtual private cloud (VPC) and vSwitch to which the instance belongs and its ingress.
+     * Retrieves basic information about a gateway, including the associated VPC, vSwitch, and gateway ingress.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2594,7 +2631,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetGatewayResponse({}));
     }
     /**
-     * Queries the basic information about an instance, such as the virtual private cloud (VPC) and vSwitch to which the instance belongs and its ingress.
+     * Retrieves basic information about a gateway, including the associated VPC, vSwitch, and gateway ingress.
      * @returns GetGatewayResponse
      */
     async getGateway(gatewayId) {
@@ -2606,7 +2643,7 @@ class Client extends openapi_core_1.default {
      * Queries the details of a gateway quota rate limiting rule.
      *
      * @remarks
-     * This operation queries a specific consumer quota rule on an AI gateway.
+     * Queries the details of a consumer quota rule on an AI gateway.
      *
      * @param request - GetGatewayQuotaRuleRequest
      * @param headers - map
@@ -2646,7 +2683,7 @@ class Client extends openapi_core_1.default {
      * Queries the details of a gateway quota rate limiting rule.
      *
      * @remarks
-     * This operation queries a specific consumer quota rule on an AI gateway.
+     * Queries the details of a consumer quota rule on an AI gateway.
      *
      * @param request - GetGatewayQuotaRuleRequest
      * @returns GetGatewayQuotaRuleResponse
@@ -2657,7 +2694,7 @@ class Client extends openapi_core_1.default {
         return await this.getGatewayQuotaRuleWithOptions(gatewayId, ruleId, request, headers, runtime);
     }
     /**
-     * Queries the usage details of a subject under a gateway quota rate-limiting rule, including used quota, total quota, whether the limit is exceeded, usage details, and consumption records.
+     * 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.
      *
      * @remarks
      * Retrieves the usage details of a specific consumer under a quota rule. This operation takes effect only for AI gateways with a version later than 2.1.19.
@@ -2694,7 +2731,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetGatewayQuotaRuleSubjectUsageResponse({}));
     }
     /**
-     * Queries the usage details of a subject under a gateway quota rate-limiting rule, including used quota, total quota, whether the limit is exceeded, usage details, and consumption records.
+     * 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.
      *
      * @remarks
      * Retrieves the usage details of a specific consumer under a quota rule. This operation takes effect only for AI gateways with a version later than 2.1.19.
@@ -2879,7 +2916,7 @@ class Client extends openapi_core_1.default {
         return await this.getPluginAttachmentWithOptions(pluginAttachmentId, headers, runtime);
     }
     /**
-     * Retrieves a custom plugin class.
+     * Retrieves a custom plug-in class.
      *
      * @param request - GetPluginClassRequest
      * @param headers - map
@@ -2905,7 +2942,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetPluginClassResponse({}));
     }
     /**
-     * Retrieves a custom plugin class.
+     * Retrieves a custom plug-in class.
      *
      * @param request - GetPluginClassRequest
      * @returns GetPluginClassResponse
@@ -3210,7 +3247,7 @@ class Client extends openapi_core_1.default {
         return await this.getTraceConfigWithOptions(gatewayId, request, headers, runtime);
     }
     /**
-     * Imports an HTTP API. You can import an OpenAPI 2.0 or OpenAPI 3.0.x definition file as a REST API.
+     * Imports an HTTP API. This operation supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
      *
      * @param request - ImportHttpApiRequest
      * @param headers - map
@@ -3280,7 +3317,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ImportHttpApiResponse({}));
     }
     /**
-     * Imports an HTTP API. You can import an OpenAPI 2.0 or OpenAPI 3.0.x definition file as a REST API.
+     * Imports an HTTP API. This operation supports importing OpenAPI 2.0 and OpenAPI 3.0.x definition files as REST-type APIs.
      *
      * @param request - ImportHttpApiRequest
      * @returns ImportHttpApiResponse
@@ -3707,10 +3744,10 @@ class Client extends openapi_core_1.default {
         return await this.listGatewayFeaturesWithOptions(gatewayId, headers, runtime);
     }
     /**
-     * Queries the list of API consumer quota rules bound to a gateway.
+     * Queries the list of consumer quota rules bound to a gateway.
      *
      * @remarks
-     * Queries the list of API consumer quota rules bound to a gateway.
+     * Queries the list of consumer quota rules bound to a gateway.
      *
      * @param request - ListGatewayQuotaRulesRequest
      * @param headers - map
@@ -3753,10 +3790,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListGatewayQuotaRulesResponse({}));
     }
     /**
-     * Queries the list of API consumer quota rules bound to a gateway.
+     * Queries the list of consumer quota rules bound to a gateway.
      *
      * @remarks
-     * Queries the list of API consumer quota rules bound to a gateway.
+     * Queries the list of consumer quota rules bound to a gateway.
      *
      * @param request - ListGatewayQuotaRulesRequest
      * @returns ListGatewayQuotaRulesResponse
@@ -4761,15 +4798,22 @@ class Client extends openapi_core_1.default {
         return await this.listTagResourcesWithOptions(request, headers, runtime);
     }
     /**
-     * Retrieves the zones available for a cloud-native API gateway in a specified region.
+     * Retrieves the zones available for a cloud-native API gateway in a specific region.
      *
+     * @param request - ListZonesRequest
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ListZonesResponse
      */
-    async listZonesWithOptions(headers, runtime) {
+    async listZonesWithOptions(request, headers, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.gatewayEdition)) {
+            query["gatewayEdition"] = request.gatewayEdition;
+        }
         let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
             headers: headers,
+            query: openapi_core_2.OpenApiUtil.query(query),
         });
         let params = new openapi_core_2.$OpenApiUtil.Params({
             action: "ListZones",
@@ -4785,16 +4829,18 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListZonesResponse({}));
     }
     /**
-     * Retrieves the zones available for a cloud-native API gateway in a specified region.
+     * Retrieves the zones available for a cloud-native API gateway in a specific region.
+     *
+     * @param request - ListZonesRequest
      * @returns ListZonesResponse
      */
-    async listZones() {
+    async listZones(request) {
         let runtime = new $dara.RuntimeOptions({});
         let headers = {};
-        return await this.listZonesWithOptions(headers, runtime);
+        return await this.listZonesWithOptions(request, headers, runtime);
     }
     /**
-     * Queries a list of consumer authorization rules.
+     * Queries the list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -4861,7 +4907,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryConsumerAuthorizationRulesResponse({}));
     }
     /**
-     * Queries a list of consumer authorization rules.
+     * Queries the list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @returns QueryConsumerAuthorizationRulesResponse
@@ -4905,18 +4951,18 @@ class Client extends openapi_core_1.default {
         return await this.removeConsumerAuthorizationRuleWithOptions(consumerAuthorizationRuleId, headers, runtime);
     }
     /**
-     * Resets a quota rate limiting rule on a gateway.
+     * Resets a quota throttling rule on a gateway.
      *
      * @remarks
-     * Resets a quota rate limiting rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19. The reset clears the historical usage of consumers on the rule.
+     * Resets a quota throttling rule on a gateway. This operation takes effect only on AI gateways running version 2.1.19 or later. Resetting a rule clears the historical usage of consumers associated with the rule.
      * >
-     * >  Recommended call logic:
+     * >  Recommended call sequence:
      * > - 1. Perform a dry run to check for rule conflicts.
-     * > - - Set dryRun=true.
+     * > - - Set dryRun to true.
      * > - - The response contains a conflict preview with conflictHash.
      * > - 2. Submit the request after confirmation.
-     * > - - No conflict: dryRun=false, overwrite=false.
-     * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
+     * > - - No conflicts: Set dryRun to false and overwrite to false.
+     * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
      *
      * @param request - ResetGatewayQuotaRuleRequest
      * @param headers - map
@@ -4968,18 +5014,18 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ResetGatewayQuotaRuleResponse({}));
     }
     /**
-     * Resets a quota rate limiting rule on a gateway.
+     * Resets a quota throttling rule on a gateway.
      *
      * @remarks
-     * Resets a quota rate limiting rule on a gateway. This operation takes effect only for AI gateways with a version later than 2.1.19. The reset clears the historical usage of consumers on the rule.
+     * Resets a quota throttling rule on a gateway. This operation takes effect only on AI gateways running version 2.1.19 or later. Resetting a rule clears the historical usage of consumers associated with the rule.
      * >
-     * >  Recommended call logic:
+     * >  Recommended call sequence:
      * > - 1. Perform a dry run to check for rule conflicts.
-     * > - - Set dryRun=true.
+     * > - - Set dryRun to true.
      * > - - The response contains a conflict preview with conflictHash.
      * > - 2. Submit the request after confirmation.
-     * > - - No conflict: dryRun=false, overwrite=false.
-     * > - - Conflict exists and overwrite confirmed: dryRun=false, overwrite=true, conflictHash=<value returned in the previous step>
+     * > - - No conflicts: Set dryRun to false and overwrite to false.
+     * > - - Conflicts exist and you confirm the overwrite: Set dryRun to false, overwrite to true, and conflictHash to the value returned in the previous step.
      *
      * @param request - ResetGatewayQuotaRuleRequest
      * @returns ResetGatewayQuotaRuleResponse
@@ -5997,7 +6043,7 @@ class Client extends openapi_core_1.default {
      * Updates an MCP server.
      *
      * @remarks
-     * Only sources of the **Container Service** type are allowed to update the listener Ingress configuration.
+     * Only sources of the **Container Service** type can update the Ingress listener configuration.
      *
      * @param request - UpdateMcpServerRequest
      * @param headers - map
@@ -6064,7 +6110,7 @@ class Client extends openapi_core_1.default {
      * Updates an MCP server.
      *
      * @remarks
-     * Only sources of the **Container Service** type are allowed to update the listener Ingress configuration.
+     * Only sources of the **Container Service** type can update the Ingress listener configuration.
      *
      * @param request - UpdateMcpServerRequest
      * @returns UpdateMcpServerResponse