@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/QueryConsumerAuthorizationRulesResponseBody.ts

@@ -1,6 +1,7 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
 import { HttpApiApiInfo } from "./HttpApiApiInfo";
+import { ConsumerGroupInfo } from "./ConsumerGroupInfo";
 import { ConsumerInfo } from "./ConsumerInfo";
 import { EnvironmentInfo } from "./EnvironmentInfo";
 import { GatewayInfo } from "./GatewayInfo";
@@ -11,12 +12,12 @@ import { HttpRoute } from "./HttpRoute";
 export class QueryConsumerAuthorizationRulesResponseBodyDataItemsResourceInfo extends $dara.Model {
   /**
    * @remarks
-   * 接口信息。
+   * The operation information.
    */
   operationInfo?: HttpApiOperationInfo;
   /**
    * @remarks
-   * 路由规则。
+   * The routing rule.
    */
   route?: HttpRoute;
   static names(): { [key: string]: string } {
@@ -51,20 +52,26 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItemsResourceInfo ex
 export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * API信息详情。
+   * The API information.
    */
   apiInfo?: HttpApiApiInfo;
   /**
    * @remarks
-   * 消费者授权规则ID。
+   * The consumer authorization rule ID.
    * 
    * @example
    * car-csgeka5lhtggrjcprok0
    */
   consumerAuthorizationRuleId?: string;
+  /**
+   * @example
+   * csg-8c13d2b4f8a1
+   */
+  consumerGroupId?: string;
+  consumerGroupInfo?: ConsumerGroupInfo;
   /**
    * @remarks
-   * 消费者ID。
+   * The consumer ID.
    * 
    * @example
    * cs-csheiftlhtgmp0j0hp4g
@@ -72,12 +79,12 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   consumerId?: string;
   /**
    * @remarks
-   * 消费者信息详情。
+   * The consumer information.
    */
   consumerInfo?: ConsumerInfo;
   /**
    * @remarks
-   * 创建时间戳。单位: 毫秒。
+   * The creation timestamp. Unit: milliseconds.
    * 
    * @example
    * 1719386834548
@@ -85,7 +92,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   createTimestamp?: number;
   /**
    * @remarks
-   * API在当前环境的发布状态
+   * The publish status of the API in the current environment.
    * 
    * @example
    * {}
@@ -93,12 +100,14 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   deployStatus?: string;
   /**
    * @remarks
-   * 环境信息。
+   * The environment context.
    */
   environmentInfo?: EnvironmentInfo;
   /**
    * @remarks
-   * 失效模式。LongTerm、ShortTerm，二选一。
+   * The expiration mode. Valid values:
+   * - LongTerm
+   * - ShortTerm
    * 
    * @example
    * ShortTerm
@@ -106,7 +115,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   expireMode?: string;
   /**
    * @remarks
-   * 失效状态。
+   * The expiration status.
    * 
    * @example
    * InEffect
@@ -114,7 +123,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   expireStatus?: string;
   /**
    * @remarks
-   * 到期时间。
+   * The expiration time.
    * 
    * @example
    * 172086834548
@@ -122,12 +131,17 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   expireTimestamp?: number;
   /**
    * @remarks
-   * 网关信息。
+   * The gateway information.
    */
   gatewayInfo?: GatewayInfo;
+  /**
+   * @example
+   * ConsumerGroup
+   */
+  principalType?: string;
   /**
    * @remarks
-   * 资源ID。
+   * The resource ID.
    * 
    * @example
    * 2351944
@@ -135,12 +149,12 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   resourceId?: string;
   /**
    * @remarks
-   * 资源信息详情。
+   * The resource information.
    */
   resourceInfo?: QueryConsumerAuthorizationRulesResponseBodyDataItemsResourceInfo;
   /**
    * @remarks
-   * 资源类型。
+   * The resource type.
    * 
    * @example
    * HttpApiRoute
@@ -148,7 +162,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
   resourceType?: string;
   /**
    * @remarks
-   * 更新时间戳。单位: 毫秒。
+   * The update timestamp. Unit: milliseconds.
    * 
    * @example
    * 1719386834548
@@ -158,6 +172,8 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
     return {
       apiInfo: 'apiInfo',
       consumerAuthorizationRuleId: 'consumerAuthorizationRuleId',
+      consumerGroupId: 'consumerGroupId',
+      consumerGroupInfo: 'consumerGroupInfo',
       consumerId: 'consumerId',
       consumerInfo: 'consumerInfo',
       createTimestamp: 'createTimestamp',
@@ -167,6 +183,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
       expireStatus: 'expireStatus',
       expireTimestamp: 'expireTimestamp',
       gatewayInfo: 'gatewayInfo',
+      principalType: 'principalType',
       resourceId: 'resourceId',
       resourceInfo: 'resourceInfo',
       resourceType: 'resourceType',
@@ -178,6 +195,8 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
     return {
       apiInfo: HttpApiApiInfo,
       consumerAuthorizationRuleId: 'string',
+      consumerGroupId: 'string',
+      consumerGroupInfo: ConsumerGroupInfo,
       consumerId: 'string',
       consumerInfo: ConsumerInfo,
       createTimestamp: 'number',
@@ -187,6 +206,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
       expireStatus: 'string',
       expireTimestamp: 'number',
       gatewayInfo: GatewayInfo,
+      principalType: 'string',
       resourceId: 'string',
       resourceInfo: QueryConsumerAuthorizationRulesResponseBodyDataItemsResourceInfo,
       resourceType: 'string',
@@ -198,6 +218,9 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
     if(this.apiInfo && typeof (this.apiInfo as any).validate === 'function') {
       (this.apiInfo as any).validate();
     }
+    if(this.consumerGroupInfo && typeof (this.consumerGroupInfo as any).validate === 'function') {
+      (this.consumerGroupInfo as any).validate();
+    }
     if(this.consumerInfo && typeof (this.consumerInfo as any).validate === 'function') {
       (this.consumerInfo as any).validate();
     }
@@ -221,7 +244,7 @@ export class QueryConsumerAuthorizationRulesResponseBodyDataItems extends $dara.
 export class QueryConsumerAuthorizationRulesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * 消费者规则列表。
+   * The list of consumer rules.
    */
   items?: QueryConsumerAuthorizationRulesResponseBodyDataItems[];
   /**

package/src/models/RemoveConsumerAuthorizationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RemoveConsumerAuthorizationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code returned.
+   * The response code.
    * 
    * @example
    * Ok
@@ -13,7 +13,7 @@ export class RemoveConsumerAuthorizationRuleResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/ResetGatewayQuotaRuleRequest.ts

@@ -4,41 +4,69 @@ import * as $dara from '@darabonba/typescript';
 
 export class ResetGatewayQuotaRuleRequest extends $dara.Model {
   /**
+   * @remarks
+   * The conflict snapshot hash, used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response data of a previous dryRun=true call.
+   * 
+   * This parameter is not required in the following cases: no conflict exists, the request is a dry run (dryRun=true), or overwrite=false (overwrite not confirmed).
+   * 
+   * When dryRun=false and overwrite=true, if this parameter is not provided or the value has expired and no longer matches, the backend returns accepted=false with a new conflict preview. You must perform a dry run again to confirm the new conflict.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
    */
   conflictHash?: string;
   /**
+   * @remarks
+   * Specifies whether to perform only a dry run without delivering the actual 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
    * false
    */
   dryRun?: boolean;
   /**
+   * @remarks
+   * Specifies whether to allow overwriting on conflict. If overwriting is allowed, the conflicting entity (consumer) is unbound from the old rule and bound to the new rule.
+   * 
    * @example
    * false
    */
   overwrite?: boolean;
   /**
+   * @remarks
+   * The period multiplier, indicating how many periods elapse before the quota resets. Returned when the rule uses a custom period. Minimum value: 1. Maximum value: 60.
+   * 
    * @example
    * 1
    */
   periodMultiplier?: number;
   /**
+   * @remarks
+   * The period type. Valid values: day, week, or month.
+   * 
    * @example
    * week
    */
   periodType?: string;
   /**
+   * @remarks
+   * The total available quota per period after the reset.
+   * 
    * @example
    * 1000
    */
   quotaLimit?: number;
   /**
+   * @remarks
+   * The time zone corresponding to the calendar period (UTC+x format).
+   * 
    * @example
    * UTC+8
    */
   timezone?: string;
   /**
+   * @remarks
+   * The period type after the reset. Currently only calendar periods are supported, which means windowAlignment="calendar".
+   * 
    * @example
    * calendar
    */

package/src/models/ResetGatewayQuotaRuleResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
   /**
+   * @remarks
+   * The period type of the existing conflicting rule on the consumer. Valid values: day (daily period), week (weekly period), or month (monthly period).
+   * 
    * @example
    * week
    */
   conflictPeriodType?: string;
   /**
+   * @remarks
+   * The type of the existing conflicting rule on the consumer. Valid values: calendar (the conflicting rule uses a calendar period) and epoch (the conflicting rule uses a custom period).
+   * 
    * @example
    * calendar
    */
   conflictType?: string;
   /**
+   * @remarks
+   * The consumer ID.
+   * 
    * @example
    * cs-d82n1g6m1hkm3xxxxxxx
    */
   consumerId?: string;
   /**
+   * @remarks
+   * The consumer name.
+   * 
    * @example
    * consumer-a
    */
@@ -52,12 +64,22 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $
 
 export class ResetGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
   /**
+   * @remarks
+   * The conflict hash.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
    */
   conflictHash?: string;
+  /**
+   * @remarks
+   * The list of conflicting entities (consumers).
+   */
   items?: ResetGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
   /**
+   * @remarks
+   * The total number of conflicts.
+   * 
    * @example
    * 20
    */
@@ -92,17 +114,30 @@ export class ResetGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.
 
 export class ResetGatewayQuotaRuleResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the write request semantics are 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?: ResetGatewayQuotaRuleResponseBodyDataConflictPreview;
   /**
+   * @remarks
+   * Indicates whether this is a dry run.
+   * 
    * @example
    * false
    */
   dryRun?: boolean;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * qr-d8j7fpmm1hks65xxxx
    */
@@ -139,21 +174,33 @@ export class ResetGatewayQuotaRuleResponseBodyData extends $dara.Model {
 
 export class ResetGatewayQuotaRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code or error code.
+   * 
    * @example
    * 200, 404, 500
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {\\"key\\": \\"value\\"}
    */
   data?: ResetGatewayQuotaRuleResponseBodyData;
   /**
+   * @remarks
+   * The message content.
+   * 
    * @example
    * 你好，世界！
    */
   message?: string;
   /**
+   * @remarks
+   * The unique identifier of the request.
+   * 
    * @example
    * 1234567890
    */

package/src/models/RestartGatewayResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RestartGatewayResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -13,7 +13,7 @@ export class RestartGatewayResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message returned.
+   * The response message.
    * 
    * @example
    * success

package/src/models/Service.ts

@@ -25,7 +25,7 @@ export class ServicePorts extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * The protocol. Valid values: `TCP` or `UDP`.
+   * The protocol. Valid values: TCP and UDP.
    * 
    * @example
    * TCP
@@ -59,12 +59,18 @@ export class ServicePorts extends $dara.Model {
 export class ServiceVersionsLabels extends $dara.Model {
   /**
    * @remarks
-   * The key of the label.
+   * The label key.
+   * 
+   * @example
+   * version
    */
   key?: string;
   /**
    * @remarks
-   * The value of the label.
+   * The label value.
+   * 
+   * @example
+   * v1
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -93,12 +99,15 @@ export class ServiceVersionsLabels extends $dara.Model {
 export class ServiceVersions extends $dara.Model {
   /**
    * @remarks
-   * The labels of the version.
+   * The list of version labels.
    */
   labels?: ServiceVersionsLabels[];
   /**
    * @remarks
    * The version name.
+   * 
+   * @example
+   * v1
    */
   name?: string;
   static names(): { [key: string]: string } {
@@ -130,7 +139,7 @@ export class ServiceVersions extends $dara.Model {
 export class Service extends $dara.Model {
   /**
    * @remarks
-   * A list of service addresses, such as IP addresses or domain names.
+   * The address information, including IP addresses or domain name lists.
    */
   addresses?: string[];
   /**
@@ -145,7 +154,7 @@ export class Service extends $dara.Model {
   aiServiceConfig?: AiServiceConfig;
   /**
    * @remarks
-   * The creation timestamp.
+   * The creation time.
    * 
    * @example
    * 1725617840096
@@ -153,7 +162,7 @@ export class Service extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * The execution type for the cloud workflow.
+   * The CloudFlow execution mode.
    * 
    * @example
    * StartExecution
@@ -169,7 +178,7 @@ export class Service extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The name of the service group.
+   * The service group name.
    * 
    * @example
    * publich
@@ -182,7 +191,7 @@ export class Service extends $dara.Model {
   healthCheck?: ServiceHealthCheck;
   /**
    * @remarks
-   * The health status. Valid values: `Healthy` or `Unhealthy`.
+   * The health check status. Valid values: Healthy and Unhealthy.
    * 
    * @example
    * Healthy
@@ -190,9 +199,14 @@ export class Service extends $dara.Model {
   healthStatus?: string;
   /**
    * @remarks
-   * A list of labels for the service.
+   * The label information of the service.
    */
   labelDetails?: LabelDetail[];
+  /**
+   * @example
+   * mp-xxxx
+   */
+  modelProviderId?: string;
   /**
    * @remarks
    * The service name.
@@ -211,12 +225,12 @@ export class Service extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * A list of outlier endpoints.
+   * The circuit-broken endpoints.
    */
   outlierEndpoints?: string[];
   /**
    * @remarks
-   * A list of port configurations.
+   * The list of port information.
    */
   ports?: ServicePorts[];
   /**
@@ -245,7 +259,7 @@ export class Service extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The unique service ID.
+   * The unique ID of the service.
    * 
    * @example
    * svc-cr6pk4tlhtgm***
@@ -261,12 +275,12 @@ export class Service extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * A list of unhealthy endpoints.
+   * The unhealthy endpoints.
    */
   unhealthyEndpoints?: string[];
   /**
    * @remarks
-   * The update timestamp.
+   * The update time.
    * 
    * @example
    * 1725868548440
@@ -274,7 +288,7 @@ export class Service extends $dara.Model {
   updateTimestamp?: number;
   /**
    * @remarks
-   * A list of service versions.
+   * The list of service versions.
    */
   versions?: ServiceVersions[];
   static names(): { [key: string]: string } {
@@ -289,6 +303,7 @@ export class Service extends $dara.Model {
       healthCheck: 'healthCheck',
       healthStatus: 'healthStatus',
       labelDetails: 'labelDetails',
+      modelProviderId: 'modelProviderId',
       name: 'name',
       namespace: 'namespace',
       outlierEndpoints: 'outlierEndpoints',
@@ -316,6 +331,7 @@ export class Service extends $dara.Model {
       healthCheck: ServiceHealthCheck,
       healthStatus: 'string',
       labelDetails: { 'type': 'array', 'itemType': LabelDetail },
+      modelProviderId: 'string',
       name: 'string',
       namespace: 'string',
       outlierEndpoints: { 'type': 'array', 'itemType': 'string' },

package/src/models/ServiceHealthCheck.ts

@@ -4,20 +4,68 @@ import * as $dara from '@darabonba/typescript';
 
 export class ServiceHealthCheck extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to enable the health check.
+   * 
    * @example
    * true
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The healthy threshold for the health check.
+   * 
+   * @example
+   * 2
+   */
   healthyThreshold?: number;
+  /**
+   * @remarks
+   * The health check domain name. This parameter is optional when the health check protocol is HTTP.
+   * 
+   * @example
+   * example.com
+   */
   httpHost?: string;
+  /**
+   * @remarks
+   * The health check path. This parameter is required when the health check protocol is HTTP.
+   * 
+   * @example
+   * /health
+   */
   httpPath?: string;
+  /**
+   * @remarks
+   * The health check interval.
+   * 
+   * @example
+   * 10
+   */
   interval?: number;
   /**
+   * @remarks
+   * The health check protocol. Valid values: TCP, HTTP, and GRPC.
+   * 
    * @example
    * TCP
    */
   protocol?: string;
+  /**
+   * @remarks
+   * The health check response timeout period.
+   * 
+   * @example
+   * 5
+   */
   timeout?: number;
+  /**
+   * @remarks
+   * The unhealthy threshold for the health check.
+   * 
+   * @example
+   * 3
+   */
   unhealthyThreshold?: number;
   static names(): { [key: string]: string } {
     return {