@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/UpdateGatewayQuotaRuleRequest.ts

@@ -4,16 +4,29 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
   /**
+   * @remarks
+   * The list of principal (consumer) IDs to bind.
+   * 
    * @example
    * cs-001,cs-002
    */
   addIds?: string[];
   /**
+   * @remarks
+   * The conflict snapshot hash, used to prevent concurrent dirty overwrites when confirming an overwrite. Obtain this value from the response of a prior dryRun=true call.
+   * 
+   * This parameter is not required in the following cases: no conflicts exist, the call is a dry run (dryRun=true), or overwrite is set to false.
+   * 
+   * When dryRun is set to false and overwrite is set to true, if this parameter is missing or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. Perform the dry run again to confirm the new conflicts.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541f50xxxxxx
    */
   conflictHash?: string;
   /**
+   * @remarks
+   * The list of consumer group IDs. This parameter is not supported.
+   * 
    * @example
    * group1,group2
    * 
@@ -21,22 +34,38 @@ export class UpdateGatewayQuotaRuleRequest extends $dara.Model {
    */
   consumerGroupIds?: string[];
   /**
+   * @remarks
+   * Specifies whether to perform a dry run only without persisting or applying the configuration. A dry run checks whether conflicting rules exist on the bound consumers. For example, a consumer that already has a calendar-day quota cannot have another calendar-day quota rule added.
+   * 
    * @example
    * true
    */
   dryRun?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to allow overwriting when a conflict exists. If overwriting is allowed, the conflicting principals (consumers) are unbound from the old rule and bound to the new rule.
+   */
   overwrite?: boolean;
   /**
+   * @remarks
+   * The updated total available quota.
+   * 
    * @example
    * 1000
    */
   quotaLimit?: number;
   /**
+   * @remarks
+   * The list of principal (consumer) IDs to unbind.
+   * 
    * @example
    * cs003,cs-004
    */
   removeIds?: string[];
   /**
+   * @remarks
+   * The updated rule name.
+   * 
    * @example
    * team-rule
    */

package/src/models/UpdateGatewayQuotaRuleResponseBody.ts

@@ -3,14 +3,34 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
+  /**
+   * @remarks
+   * The period type of the existing conflicting rule on the consumer. Valid values: day: daily period. week: weekly period. month: monthly period.
+   * 
+   * @example
+   * week
+   */
   conflictPeriodType?: string;
+  /**
+   * @remarks
+   * The type of the existing conflicting rule on the consumer. Valid values: calendar: The conflicting rule is a calendar-period rule. epoch: The conflicting rule is a custom-period rule.
+   * 
+   * @example
+   * calendar
+   */
   conflictType?: string;
   /**
+   * @remarks
+   * The consumer ID.
+   * 
    * @example
    * cs-d82n1g6m1hkm375xxxxx
    */
   consumerId?: string;
   /**
+   * @remarks
+   * The consumer name.
+   * 
    * @example
    * consumer-a
    */
@@ -44,12 +64,22 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends
 
 export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
   /**
+   * @remarks
+   * The hash of the conflict snapshot.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541f50xxxxxx
    */
   conflictHash?: string;
+  /**
+   * @remarks
+   * The list of conflicting principals (consumers).
+   */
   items?: UpdateGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
   /**
+   * @remarks
+   * The total number of conflicts.
+   * 
    * @example
    * 2
    */
@@ -83,14 +113,31 @@ export class UpdateGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara
 }
 
 export class UpdateGatewayQuotaRuleResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the write request is accepted by the system. A value of false typically indicates a retryable scenario, such as an unconfirmed conflict overwrite.
+   * 
+   * @example
+   * true
+   */
   accepted?: boolean;
+  /**
+   * @remarks
+   * The conflict preview.
+   */
   conflictPreview?: UpdateGatewayQuotaRuleResponseBodyDataConflictPreview;
   /**
+   * @remarks
+   * Indicates whether this is a dry run.
+   * 
    * @example
    * true
    */
   dryRun?: boolean;
   /**
+   * @remarks
+   * The ID of the rule.
+   * 
    * @example
    * qr-xxxxxx
    */
@@ -127,21 +174,33 @@ export class UpdateGatewayQuotaRuleResponseBodyData extends $dara.Model {
 
 export class UpdateGatewayQuotaRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code or error code.
+   * 
    * @example
    * 200, 404, 500
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {\\"key\\": \\"value\\"}
    */
   data?: UpdateGatewayQuotaRuleResponseBodyData;
   /**
+   * @remarks
+   * The message content.
+   * 
    * @example
    * 你好，世界！
    */
   message?: string;
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * 1234567890
    */

package/src/models/UpdateGatewayQuotaRuleStatusRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateGatewayQuotaRuleStatusRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to clear historical quota usage when enabling or disabling the rule.
+   * 
    * @example
    * false
    */
   clearHistory?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable or disable the rule.
+   * 
    * @example
    * false
    */

package/src/models/UpdateGatewayQuotaRuleStatusResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateGatewayQuotaRuleStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code or error code.
+   * 
    * @example
    * 200, 404, 500
    */
   code?: string;
   /**
+   * @remarks
+   * The message content.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * 1234567890
    */

package/src/models/UpdateHttpApiOperationRequest.ts

@@ -6,7 +6,7 @@ import { HttpApiOperation } from "./HttpApiOperation";
 export class UpdateHttpApiOperationRequest extends $dara.Model {
   /**
    * @remarks
-   * The API operation definition.
+   * The operation definition.
    */
   operation?: HttpApiOperation;
   static names(): { [key: string]: string } {

package/src/models/UpdateHttpApiRequest.ts

@@ -8,7 +8,7 @@ import { HttpApiVersionConfig } from "./HttpApiVersionConfig";
 export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
   /**
    * @remarks
-   * The authentication configuration.
+   * The environment ID.
    * 
    * @example
    * env-cr6ql0tlhtgmc****
@@ -16,7 +16,7 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The response parameters.
+   * The Ingress Class to listen on.
    * 
    * @example
    * mse
@@ -24,7 +24,7 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
   ingressClass?: string;
   /**
    * @remarks
-   * The returned message.
+   * Specifies whether to update the address in the Ingress Status.
    * 
    * @example
    * false
@@ -32,7 +32,7 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
   overrideIngressIp?: boolean;
   /**
    * @remarks
-   * json
+   * The source ID.
    * 
    * @example
    * src-crdddallhtgtr****
@@ -40,7 +40,7 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
   sourceId?: string;
   /**
    * @remarks
-   * The request ID.
+   * The namespace to listen on.
    * 
    * @example
    * default
@@ -78,22 +78,22 @@ export class UpdateHttpApiRequestIngressConfig extends $dara.Model {
 export class UpdateHttpApiRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of agent protocols
+   * The list of Agent protocols.
    */
   agentProtocols?: string[];
   /**
    * @remarks
-   * The status code.
+   * The list of AI protocols.
    */
   aiProtocols?: string[];
   /**
    * @remarks
-   * The authentication configuration
+   * The permission authentication configuration.
    */
   authConfig?: AuthConfig;
   /**
    * @remarks
-   * The list of API deployment configurations.
+   * The base path of the API. The value must start with a forward slash (/).
    * 
    * This parameter is required.
    * 
@@ -103,12 +103,12 @@ export class UpdateHttpApiRequest extends $dara.Model {
   basePath?: string;
   /**
    * @remarks
-   * The deployment configurations
+   * The list of API deployment configurations.
    */
   deployConfigs?: HttpApiDeployConfig[];
   /**
    * @remarks
-   * The environment ID.
+   * The API description.
    * 
    * @example
    * 更新API描述
@@ -116,7 +116,7 @@ export class UpdateHttpApiRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Whether authentication is enabled
+   * Specifies whether to enable permission authentication.
    * 
    * @example
    * true
@@ -124,7 +124,7 @@ export class UpdateHttpApiRequest extends $dara.Model {
   enableAuth?: boolean;
   /**
    * @remarks
-   * The first byte timeout in nanoseconds
+   * The first byte timeout period.
    * 
    * @example
    * 30s
@@ -132,12 +132,12 @@ export class UpdateHttpApiRequest extends $dara.Model {
   firstByteTimeout?: number;
   /**
    * @remarks
-   * Specifies whether to enable authentication.
+   * The configuration of the HTTP Ingress API.
    */
   ingressConfig?: UpdateHttpApiRequestIngressConfig;
   /**
    * @remarks
-   * Whether to only change configuration without redeployment
+   * Specifies whether to only modify the configuration. A value of true indicates that only the configuration is modified without triggering redeployment.
    * 
    * @example
    * true
@@ -145,12 +145,12 @@ export class UpdateHttpApiRequest extends $dara.Model {
   onlyChangeConfig?: boolean;
   /**
    * @remarks
-   * The listened namespace.
+   * The list of API access protocols.
    */
   protocols?: string[];
   /**
    * @remarks
-   * Whether to remove base path when forwarding
+   * Specifies whether to remove the base path during forwarding.
    * 
    * @example
    * true
@@ -158,7 +158,7 @@ export class UpdateHttpApiRequest extends $dara.Model {
   removeBasePathOnForward?: boolean;
   /**
    * @remarks
-   * A deployment configuration.
+   * The API versioning configuration.
    */
   versionConfig?: HttpApiVersionConfig;
   static names(): { [key: string]: string } {

package/src/models/UpdateHttpApiResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpApiResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -13,7 +13,7 @@ export class UpdateHttpApiResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -21,7 +21,7 @@ export class UpdateHttpApiResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 393E2630-DBE7-5221-AB35-9E740675491A

package/src/models/UpdateHttpApiRouteRequest.ts

@@ -7,7 +7,7 @@ import { HttpApiPolicyConfigs } from "./HttpApiPolicyConfigs";
 export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model {
   /**
    * @remarks
-   * The service port. This parameter is not required for dynamic ports.
+   * The service port. Do not specify this parameter for dynamic ports.
    * 
    * @example
    * 8080
@@ -16,9 +16,7 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
   /**
    * @remarks
    * The service protocol. Valid values:
-   * 
    * - HTTP
-   * 
    * - HTTPS
    * 
    * @example
@@ -43,7 +41,7 @@ export class UpdateHttpApiRouteRequestBackendConfigServices extends $dara.Model
   version?: string;
   /**
    * @remarks
-   * The percentage of traffic.
+   * The percentage value of the traffic ratio.
    * 
    * @example
    * 49
@@ -89,7 +87,7 @@ export class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model {
   scene?: string;
   /**
    * @remarks
-   * A list of backend services.
+   * The list of backend services.
    */
   services?: UpdateHttpApiRouteRequestBackendConfigServices[];
   static names(): { [key: string]: string } {
@@ -119,8 +117,29 @@ export class UpdateHttpApiRouteRequestBackendConfig extends $dara.Model {
 }
 
 export class UpdateHttpApiRouteRequestMcpRouteConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The exposed URI path.
+   * 
+   * @example
+   * /mcp/chat
+   */
   exposedUriPath?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable MCP statistics.
+   * 
+   * @example
+   * true
+   */
   mcpStatisticsEnable?: boolean;
+  /**
+   * @remarks
+   * The MCP protocol.
+   * 
+   * @example
+   * SSE
+   */
   protocol?: string;
   static names(): { [key: string]: string } {
     return {
@@ -150,12 +169,12 @@ export class UpdateHttpApiRouteRequestMcpRouteConfig extends $dara.Model {
 export class UpdateHttpApiRouteRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration of the backend service for the route.
+   * The backend service configuration of the route.
    */
   backendConfig?: UpdateHttpApiRouteRequestBackendConfig;
   /**
    * @remarks
-   * The description of the route.
+   * The route description.
    * 
    * @example
    * 商品中心服务路由
@@ -163,7 +182,7 @@ export class UpdateHttpApiRouteRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * A list of domain name IDs.
+   * The list of domain name IDs.
    */
   domainIds?: string[];
   /**
@@ -176,10 +195,18 @@ export class UpdateHttpApiRouteRequest extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The route matching rule.
+   * The route match rule.
    */
   match?: HttpRouteMatch;
+  /**
+   * @remarks
+   * The MCP route configuration.
+   */
   mcpRouteConfig?: UpdateHttpApiRouteRequestMcpRouteConfig;
+  /**
+   * @remarks
+   * The route-level policy configurations.
+   */
   policyConfigs?: HttpApiPolicyConfigs[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateHttpApiRouteResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpApiRouteResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code of the response.
+   * The response status code.
    * 
    * @example
    * Ok