@alicloud/apig20240327 6.0.1 → 6.0.3

package/dist/client.d.ts

@@ -9,7 +9,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, endpoint: string): string;
     /**
-     * Authorize the security group for gateway to access services
+     * Adds a security group that authorizes an instance to access services.
      *
      * @param request - AddGatewaySecurityGroupRuleRequest
      * @param headers - map
@@ -20,7 +20,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.AddGatewaySecurityGroupRuleResponse>;
     /**
-     * Authorize the security group for gateway to access services
+     * Adds a security group that authorizes an instance to access services.
      *
      * @param request - AddGatewaySecurityGroupRuleRequest
      * @returns AddGatewaySecurityGroupRuleResponse
@@ -45,7 +45,7 @@ export default class Client extends OpenApi {
      */
     batchDeleteConsumerAuthorizationRule(request: $_model.BatchDeleteConsumerAuthorizationRuleRequest): Promise<$_model.BatchDeleteConsumerAuthorizationRuleResponse>;
     /**
-     * Resource Group Transfer
+     * Moves a resource from one resource group to another.
      *
      * @param request - ChangeResourceGroupRequest
      * @param headers - map
@@ -56,7 +56,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ChangeResourceGroupResponse>;
     /**
-     * Resource Group Transfer
+     * Moves a resource from one resource group to another.
      *
      * @param request - ChangeResourceGroupRequest
      * @returns ChangeResourceGroupResponse
@@ -159,10 +159,7 @@ export default class Client extends OpenApi {
      */
     createDomain(request: $_model.CreateDomainRequest): Promise<$_model.CreateDomainResponse>;
     /**
-     * CreateEnvironment
-     *
-     * @remarks
-     * Create environment.
+     * Creates an environment.
      *
      * @deprecated OpenAPI CreateEnvironment is deprecated
      *
@@ -175,10 +172,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateEnvironmentResponse>;
     /**
-     * CreateEnvironment
-     *
-     * @remarks
-     * Create environment.
+     * Creates an environment.
      *
      * @deprecated OpenAPI CreateEnvironment is deprecated
      *
@@ -295,7 +289,7 @@ export default class Client extends OpenApi {
      */
     createPluginAttachment(request: $_model.CreatePluginAttachmentRequest): Promise<$_model.CreatePluginAttachmentResponse>;
     /**
-     * Create Policy
+     * Creates a policy.
      *
      * @param request - CreatePolicyRequest
      * @param headers - map
@@ -306,14 +300,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePolicyResponse>;
     /**
-     * Create Policy
+     * Creates a policy.
      *
      * @param request - CreatePolicyRequest
      * @returns CreatePolicyResponse
      */
     createPolicy(request: $_model.CreatePolicyRequest): Promise<$_model.CreatePolicyResponse>;
     /**
-     * Create policy resource mount
+     * Creates a policy attachment.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @param headers - map
@@ -324,7 +318,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePolicyAttachmentResponse>;
     /**
-     * Create policy resource mount
+     * Creates a policy attachment.
      *
      * @param request - CreatePolicyAttachmentRequest
      * @returns CreatePolicyAttachmentResponse
@@ -391,7 +385,7 @@ export default class Client extends OpenApi {
      */
     createServiceVersion(serviceId: string, request: $_model.CreateServiceVersionRequest): Promise<$_model.CreateServiceVersionResponse>;
     /**
-     * 创建服务来源
+     * Creates a service source.
      *
      * @param request - CreateSourceRequest
      * @param headers - map
@@ -402,7 +396,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSourceResponse>;
     /**
-     * 创建服务来源
+     * Creates a service source.
      *
      * @param request - CreateSourceRequest
      * @returns CreateSourceResponse
@@ -439,7 +433,7 @@ export default class Client extends OpenApi {
      */
     deleteConsumerAuthorizationRule(consumerAuthorizationRuleId: string, consumerId: string): Promise<$_model.DeleteConsumerAuthorizationRuleResponse>;
     /**
-     * DeleteDomain
+     * Deletes a domain name.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -449,12 +443,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDomainResponse>;
     /**
-     * DeleteDomain
+     * Deletes a domain name.
      * @returns DeleteDomainResponse
      */
     deleteDomain(domainId: string): Promise<$_model.DeleteDomainResponse>;
     /**
-     * DeleteEnvironment
+     * Deletes an environment.
      *
      * @deprecated OpenAPI DeleteEnvironment is deprecated
      *
@@ -466,14 +460,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteEnvironmentResponse>;
     /**
-     * DeleteEnvironment
+     * Deletes an environment.
      *
      * @deprecated OpenAPI DeleteEnvironment is deprecated
      * @returns DeleteEnvironmentResponse
      */
     deleteEnvironment(environmentId: string): Promise<$_model.DeleteEnvironmentResponse>;
     /**
-     * Delete Gateway
+     * Deletes a Cloud-native API Gateway instance.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -483,12 +477,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteGatewayResponse>;
     /**
-     * Delete Gateway
+     * Deletes a Cloud-native API Gateway instance.
      * @returns DeleteGatewayResponse
      */
     deleteGateway(gatewayId: string): Promise<$_model.DeleteGatewayResponse>;
     /**
-     * Delete the security group rule of a gateway
+     * Deletes a security group rule from a Cloud-native API Gateway instance.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @param headers - map
@@ -499,7 +493,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteGatewaySecurityGroupRuleResponse>;
     /**
-     * Delete the security group rule of a gateway
+     * Deletes a security group rule from a Cloud-native API Gateway instance.
      *
      * @param request - DeleteGatewaySecurityGroupRuleRequest
      * @returns DeleteGatewaySecurityGroupRuleResponse
@@ -521,7 +515,7 @@ export default class Client extends OpenApi {
      */
     deleteHttpApi(httpApiId: string): Promise<$_model.DeleteHttpApiResponse>;
     /**
-     * Delete Operation
+     * Deletes an operation from an HTTP API.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -531,12 +525,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteHttpApiOperationResponse>;
     /**
-     * Delete Operation
+     * Deletes an operation from an HTTP API.
      * @returns DeleteHttpApiOperationResponse
      */
     deleteHttpApiOperation(httpApiId: string, operationId: string): Promise<$_model.DeleteHttpApiOperationResponse>;
     /**
-     * Delete the route of an HttpApi
+     * Deletes a route in an HTTP API.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -546,12 +540,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteHttpApiRouteResponse>;
     /**
-     * Delete the route of an HttpApi
+     * Deletes a route in an HTTP API.
      * @returns DeleteHttpApiRouteResponse
      */
     deleteHttpApiRoute(httpApiId: string, routeId: string): Promise<$_model.DeleteHttpApiRouteResponse>;
     /**
-     * 删除MCP server
+     * Deletes an MCP server.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -561,7 +555,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMcpServerResponse>;
     /**
-     * 删除MCP server
+     * Deletes an MCP server.
      * @returns DeleteMcpServerResponse
      */
     deleteMcpServer(mcpServerId: string): Promise<$_model.DeleteMcpServerResponse>;
@@ -581,7 +575,7 @@ export default class Client extends OpenApi {
      */
     deletePluginAttachment(pluginAttachmentId: string): Promise<$_model.DeletePluginAttachmentResponse>;
     /**
-     * Delete Policy
+     * Deletes a policy.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -591,12 +585,12 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeletePolicyResponse>;
     /**
-     * Delete Policy
+     * Deletes a policy.
      * @returns DeletePolicyResponse
      */
     deletePolicy(policyId: string): Promise<$_model.DeletePolicyResponse>;
     /**
-     * Delete policy resource attachment
+     * Deletes a policy attachment.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -606,7 +600,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeletePolicyAttachmentResponse>;
     /**
-     * Delete policy resource attachment
+     * Deletes a policy attachment.
      * @returns DeletePolicyAttachmentResponse
      */
     deletePolicyAttachment(policyAttachmentId: string): Promise<$_model.DeletePolicyAttachmentResponse>;
@@ -656,7 +650,7 @@ export default class Client extends OpenApi {
      */
     deleteServiceVersion(serviceId: string, name: string): Promise<$_model.DeleteServiceVersionResponse>;
     /**
-     * 删除服务来源
+     * Deletes a service source.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -666,7 +660,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSourceResponse>;
     /**
-     * 删除服务来源
+     * Deletes a service source.
      * @returns DeleteSourceResponse
      */
     deleteSource(sourceId: string): Promise<$_model.DeleteSourceResponse>;
@@ -704,7 +698,7 @@ export default class Client extends OpenApi {
      */
     deployMcpServer(mcpServerId: string): Promise<$_model.DeployMcpServerResponse>;
     /**
-     * Export HTTP API
+     * Exports an HTTP API.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -714,7 +708,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ExportHttpApiResponse>;
     /**
-     * Export HTTP API
+     * Exports an HTTP API.
      * @returns ExportHttpApiResponse
      */
     exportHttpApi(httpApiId: string): Promise<$_model.ExportHttpApiResponse>;
@@ -785,7 +779,7 @@ export default class Client extends OpenApi {
      */
     getDomain(domainId: string, request: $_model.GetDomainRequest): Promise<$_model.GetDomainResponse>;
     /**
-     * GetEnvironment
+     * Queries an environment.
      *
      * @deprecated OpenAPI GetEnvironment is deprecated
      *
@@ -798,7 +792,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetEnvironmentResponse>;
     /**
-     * GetEnvironment
+     * Queries an environment.
      *
      * @deprecated OpenAPI GetEnvironment is deprecated
      *
@@ -918,7 +912,7 @@ export default class Client extends OpenApi {
      */
     getPolicy(policyId: string): Promise<$_model.GetPolicyResponse>;
     /**
-     * Query Policy Resource Attachment
+     * Queries a policy attachment.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -928,7 +922,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetPolicyAttachmentResponse>;
     /**
-     * Query Policy Resource Attachment
+     * Queries a policy attachment.
      * @returns GetPolicyAttachmentResponse
      */
     getPolicyAttachment(policyAttachmentId: string): Promise<$_model.GetPolicyAttachmentResponse>;
@@ -981,7 +975,7 @@ export default class Client extends OpenApi {
      */
     getSecretValue(name: string): Promise<$_model.GetSecretValueResponse>;
     /**
-     * Queries the details of a service.
+     * Queries a service.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -991,7 +985,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetServiceResponse>;
     /**
-     * Queries the details of a service.
+     * Queries a service.
      * @returns GetServiceResponse
      */
     getService(serviceId: string): Promise<$_model.GetServiceResponse>;
@@ -1011,7 +1005,7 @@ export default class Client extends OpenApi {
      */
     getSource(sourceId: string): Promise<$_model.GetSourceResponse>;
     /**
-     * Retrieve Tracing Configuration
+     * Queries the tracing configurations of a Cloud-native API Gateway instance.
      *
      * @param request - GetTraceConfigRequest
      * @param headers - map
@@ -1022,7 +1016,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.GetTraceConfigResponse>;
     /**
-     * Retrieve Tracing Configuration
+     * Queries the tracing configurations of a Cloud-native API Gateway instance.
      *
      * @param request - GetTraceConfigRequest
      * @returns GetTraceConfigResponse
@@ -1324,7 +1318,7 @@ export default class Client extends OpenApi {
      */
     listPolicies(request: $_model.ListPoliciesRequest): Promise<$_model.ListPoliciesResponse>;
     /**
-     * ListPolicyClasses
+     * Queries policy templates.
      *
      * @param request - ListPolicyClassesRequest
      * @param headers - map
@@ -1335,7 +1329,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListPolicyClassesResponse>;
     /**
-     * ListPolicyClasses
+     * Queries policy templates.
      *
      * @param request - ListPolicyClassesRequest
      * @returns ListPolicyClassesResponse
@@ -1396,7 +1390,7 @@ export default class Client extends OpenApi {
      */
     listServices(request: $_model.ListServicesRequest): Promise<$_model.ListServicesResponse>;
     /**
-     * ListSslCerts
+     * Queries SSL certificates.
      *
      * @param request - ListSslCertsRequest
      * @param headers - map
@@ -1407,7 +1401,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.ListSslCertsResponse>;
     /**
-     * ListSslCerts
+     * Queries SSL certificates.
      *
      * @param request - ListSslCertsRequest
      * @returns ListSslCertsResponse
@@ -1462,7 +1456,7 @@ export default class Client extends OpenApi {
      */
     removeConsumerAuthorizationRule(consumerAuthorizationRuleId: string): Promise<$_model.RemoveConsumerAuthorizationRuleResponse>;
     /**
-     * Gateway Restart
+     * Restarts an instance.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1472,7 +1466,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.RestartGatewayResponse>;
     /**
-     * Gateway Restart
+     * Restarts an instance.
      * @returns RestartGatewayResponse
      */
     restartGateway(gatewayId: string): Promise<$_model.RestartGatewayResponse>;
@@ -1599,6 +1593,9 @@ export default class Client extends OpenApi {
     /**
      * Updates a domain name.
      *
+     * @remarks
+     * You can update the listening Ingress only for sources whose types are **ACK**.
+     *
      * @param request - UpdateDomainRequest
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1610,12 +1607,15 @@ export default class Client extends OpenApi {
     /**
      * Updates a domain name.
      *
+     * @remarks
+     * You can update the listening Ingress only for sources whose types are **ACK**.
+     *
      * @param request - UpdateDomainRequest
      * @returns UpdateDomainResponse
      */
     updateDomain(domainId: string, request: $_model.UpdateDomainRequest): Promise<$_model.UpdateDomainResponse>;
     /**
-     * UpdateEnvironment
+     * Modifies an environment.
      *
      * @deprecated OpenAPI UpdateEnvironment is deprecated
      *
@@ -1628,7 +1628,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateEnvironmentResponse>;
     /**
-     * UpdateEnvironment
+     * Modifies an environment.
      *
      * @deprecated OpenAPI UpdateEnvironment is deprecated
      *
@@ -1637,7 +1637,7 @@ export default class Client extends OpenApi {
      */
     updateEnvironment(environmentId: string, request: $_model.UpdateEnvironmentRequest): Promise<$_model.UpdateEnvironmentResponse>;
     /**
-     * Get the feature configuration of the gateway
+     * Updates the configuration of an instance feature parameter.
      *
      * @param request - UpdateGatewayFeatureRequest
      * @param headers - map
@@ -1648,14 +1648,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateGatewayFeatureResponse>;
     /**
-     * Get the feature configuration of the gateway
+     * Updates the configuration of an instance feature parameter.
      *
      * @param request - UpdateGatewayFeatureRequest
      * @returns UpdateGatewayFeatureResponse
      */
     updateGatewayFeature(gatewayId: string, name: string, request: $_model.UpdateGatewayFeatureRequest): Promise<$_model.UpdateGatewayFeatureResponse>;
     /**
-     * Change the name of a gateway instance
+     * Changes the name of a Cloud-native API Gateway instance.
      *
      * @param request - UpdateGatewayNameRequest
      * @param headers - map
@@ -1666,7 +1666,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateGatewayNameResponse>;
     /**
-     * Change the name of a gateway instance
+     * Changes the name of a Cloud-native API Gateway instance.
      *
      * @param request - UpdateGatewayNameRequest
      * @returns UpdateGatewayNameResponse
@@ -1691,7 +1691,7 @@ export default class Client extends OpenApi {
      */
     updateHttpApi(httpApiId: string, request: $_model.UpdateHttpApiRequest): Promise<$_model.UpdateHttpApiResponse>;
     /**
-     * Update Operation
+     * Updates an operation of an HTTP API.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @param headers - map
@@ -1702,7 +1702,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateHttpApiOperationResponse>;
     /**
-     * Update Operation
+     * Updates an operation of an HTTP API.
      *
      * @param request - UpdateHttpApiOperationRequest
      * @returns UpdateHttpApiOperationResponse
@@ -1769,7 +1769,7 @@ export default class Client extends OpenApi {
      */
     updatePluginAttachment(pluginAttachmentId: string, request: $_model.UpdatePluginAttachmentRequest): Promise<$_model.UpdatePluginAttachmentResponse>;
     /**
-     * Update Policy
+     * Updates a policy.
      *
      * @param request - UpdatePolicyRequest
      * @param headers - map
@@ -1780,7 +1780,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdatePolicyResponse>;
     /**
-     * Update Policy
+     * Updates a policy.
      *
      * @param request - UpdatePolicyRequest
      * @returns UpdatePolicyResponse
@@ -1805,7 +1805,7 @@ export default class Client extends OpenApi {
      */
     updateSecret(secretId: string, request: $_model.UpdateSecretRequest): Promise<$_model.UpdateSecretResponse>;
     /**
-     * 更新服务
+     * Updates a service. You can call this operation to update the health check, DNS domain name, and fixed address configurations of a service.
      *
      * @param request - UpdateServiceRequest
      * @param headers - map
@@ -1816,7 +1816,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateServiceResponse>;
     /**
-     * 更新服务
+     * Updates a service. You can call this operation to update the health check, DNS domain name, and fixed address configurations of a service.
      *
      * @param request - UpdateServiceRequest
      * @returns UpdateServiceResponse
@@ -1841,7 +1841,7 @@ export default class Client extends OpenApi {
      */
     updateServiceVersion(serviceId: string, name: string, request: $_model.UpdateServiceVersionRequest): Promise<$_model.UpdateServiceVersionResponse>;
     /**
-     * Upgrade the gateway version
+     * Updates the version of a Cloud-native API Gateway instance.
      *
      * @param request - UpgradeGatewayRequest
      * @param headers - map
@@ -1852,7 +1852,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $dara.RuntimeOptions): Promise<$_model.UpgradeGatewayResponse>;
     /**
-     * Upgrade the gateway version
+     * Updates the version of a Cloud-native API Gateway instance.
      *
      * @param request - UpgradeGatewayRequest
      * @returns UpgradeGatewayResponse