@alicloud/apig20240327 9.3.0 → 10.0.0

package/dist/client.d.ts

@@ -12,15 +12,15 @@ export default class Client extends OpenApi {
      * 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
@@ -34,22 +34,22 @@ export default class Client extends OpenApi {
      * 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
      */
     addGatewayQuotaRule(gatewayId: string, request: $_model.AddGatewayQuotaRuleRequest): Promise<$_model.AddGatewayQuotaRuleResponse>;
     /**
-     * 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
@@ -60,7 +60,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -85,7 +85,7 @@ export default class Client extends OpenApi {
      */
     batchDeleteConsumerAuthorizationRule(request: $_model.BatchDeleteConsumerAuthorizationRuleRequest): Promise<$_model.BatchDeleteConsumerAuthorizationRuleResponse>;
     /**
-     * Transfers a resource to a different resource group.
+     * Moves a resource to a different resource group.
      *
      * @param request - ChangeResourceGroupRequest
      * @param headers - map
@@ -96,7 +96,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeResourceGroupResponse>;
     /**
-     * Transfers a resource to a different resource group.
+     * Moves a resource to a different resource group.
      *
      * @param request - ChangeResourceGroupRequest
      * @returns ChangeResourceGroupResponse
@@ -377,7 +377,7 @@ export default class Client extends OpenApi {
      */
     createPolicy(request: $_model.CreatePolicyRequest): Promise<$_model.CreatePolicyResponse>;
     /**
-     * Creates a policy attachment.
+     * Creates a policy attachment to a resource.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @param headers - map
@@ -388,7 +388,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePolicyAttachmentResponse>;
     /**
-     * Creates a policy attachment.
+     * Creates a policy attachment to a resource.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @returns CreatePolicyAttachmentResponse
@@ -555,7 +555,7 @@ export default class Client extends OpenApi {
      * 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
@@ -569,14 +569,14 @@ export default class Client extends OpenApi {
      * 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
      */
     deleteGatewayQuotaRule(gatewayId: string, ruleId: string, request: $_model.DeleteGatewayQuotaRuleRequest): Promise<$_model.DeleteGatewayQuotaRuleResponse>;
     /**
-     * Deletes a gateway security group rule.
+     * Deletes a security group rule from a gateway.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @param headers - map
@@ -587,7 +587,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteGatewaySecurityGroupRuleResponse>;
     /**
-     * Deletes a gateway security group rule.
+     * Deletes a security group rule from a gateway.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @returns DeleteGatewaySecurityGroupRuleResponse
@@ -668,6 +668,24 @@ export default class Client extends OpenApi {
      * @returns DeletePluginAttachmentResponse
      */
     deletePluginAttachment(pluginAttachmentId: string): Promise<$_model.DeletePluginAttachmentResponse>;
+    /**
+     * DeletePluginClass
+     *
+     * @param request - DeletePluginClassRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeletePluginClassResponse
+     */
+    deletePluginClassWithOptions(pluginClassId: string, request: $_model.DeletePluginClassRequest, headers: {
+        [key: string]: string;
+    }, runtime: $dara.RuntimeOptions): Promise<$_model.DeletePluginClassResponse>;
+    /**
+     * DeletePluginClass
+     *
+     * @param request - DeletePluginClassRequest
+     * @returns DeletePluginClassResponse
+     */
+    deletePluginClass(pluginClassId: string, request: $_model.DeletePluginClassRequest): Promise<$_model.DeletePluginClassResponse>;
     /**
      * Deletes a policy.
      *
@@ -922,7 +940,7 @@ export default class Client extends OpenApi {
      */
     getEnvironment(environmentId: string, request: $_model.GetEnvironmentRequest): Promise<$_model.GetEnvironmentResponse>;
     /**
-     * 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
@@ -932,7 +950,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
      */
     getGateway(gatewayId: string): Promise<$_model.GetGatewayResponse>;
@@ -940,7 +958,7 @@ export default class Client extends OpenApi {
      * 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
@@ -954,14 +972,14 @@ export default class Client extends OpenApi {
      * 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
      */
     getGatewayQuotaRule(gatewayId: string, ruleId: string, request: $_model.GetGatewayQuotaRuleRequest): Promise<$_model.GetGatewayQuotaRuleResponse>;
     /**
-     * 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.
@@ -975,7 +993,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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.
@@ -1066,7 +1084,7 @@ export default class Client extends OpenApi {
      */
     getPluginAttachment(pluginAttachmentId: string): Promise<$_model.GetPluginAttachmentResponse>;
     /**
-     * Retrieves a custom plugin class.
+     * Retrieves a custom plug-in class.
      *
      * @param request - GetPluginClassRequest
      * @param headers - map
@@ -1077,7 +1095,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetPluginClassResponse>;
     /**
-     * Retrieves a custom plugin class.
+     * Retrieves a custom plug-in class.
      *
      * @param request - GetPluginClassRequest
      * @returns GetPluginClassResponse
@@ -1222,7 +1240,7 @@ export default class Client extends OpenApi {
      */
     getTraceConfig(gatewayId: string, request: $_model.GetTraceConfigRequest): Promise<$_model.GetTraceConfigResponse>;
     /**
-     * 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
@@ -1233,7 +1251,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -1391,10 +1409,10 @@ export default class Client extends OpenApi {
      */
     listGatewayFeatures(gatewayId: string): Promise<$_model.ListGatewayFeaturesResponse>;
     /**
-     * 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
@@ -1405,10 +1423,10 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -1709,22 +1727,25 @@ export default class Client extends OpenApi {
      */
     listTagResources(request: $_model.ListTagResourcesRequest): Promise<$_model.ListTagResourcesResponse>;
     /**
-     * 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
      */
-    listZonesWithOptions(headers: {
+    listZonesWithOptions(request: $_model.ListZonesRequest, headers: {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
      */
-    listZones(): Promise<$_model.ListZonesResponse>;
+    listZones(request: $_model.ListZonesRequest): Promise<$_model.ListZonesResponse>;
     /**
-     * Queries a list of consumer authorization rules.
+     * Queries the list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @param headers - map
@@ -1735,7 +1756,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.QueryConsumerAuthorizationRulesResponse>;
     /**
-     * Queries a list of consumer authorization rules.
+     * Queries the list of consumer authorization rules.
      *
      * @param request - QueryConsumerAuthorizationRulesRequest
      * @returns QueryConsumerAuthorizationRulesResponse
@@ -1757,18 +1778,18 @@ export default class Client extends OpenApi {
      */
     removeConsumerAuthorizationRule(consumerAuthorizationRuleId: string): Promise<$_model.RemoveConsumerAuthorizationRuleResponse>;
     /**
-     * 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
@@ -1779,18 +1800,18 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_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
@@ -2173,7 +2194,7 @@ export default class Client extends OpenApi {
      * 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
@@ -2187,7 +2208,7 @@ export default class Client extends OpenApi {
      * 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