@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/AddGatewayQuotaRuleRequest.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddGatewayQuotaRuleRequest extends $dara.Model {
   /**
+   * @remarks
+   * The conflict snapshot hash used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response of a previous dryRun=true call.
+   * 
+   * You do not need to specify this parameter in the following cases: no conflict exists, the request is a dry run (dryRun=true), or overwrite=false.
+   * 
+   * When dryRun=false and overwrite=true, if this parameter is not specified or the value has expired, the backend returns accepted=false with a new conflict preview. Perform a dry run again to confirm the new conflict.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
    */
   conflictHash?: string;
   /**
+   * @remarks
+   * The list of consumer group IDs. This parameter is not supported.
+   * 
    * @example
    * group1,group2
    * 
@@ -16,27 +26,41 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
    */
   consumerGroupIds?: string[];
   /**
+   * @remarks
+   * The list of consumer IDs to bind to the rule.
+   * 
    * @example
    * 1001,1002,1003
    */
   consumerIds?: string[];
   /**
+   * @remarks
+   * Specifies whether to perform only a dry run 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 daily calendar quota cannot have another daily calendar quota rule added.
+   * 
    * @example
    * false
    */
   dryRun?: boolean;
   /**
+   * @remarks
+   * Specifies whether to allow overwriting on conflict. If overwriting is allowed, the conflicting principals (consumers) are unbound from the old rule and bound to the new rule.
+   * 
    * @example
    * false
    */
   overwrite?: boolean;
   /**
+   * @remarks
+   * The period multiplier.
+   * 
    * @example
    * 10
    */
   periodMultiplier?: number;
   /**
    * @remarks
+   * The period type. Valid values: day (calendar day), week (calendar week), and month (calendar month).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -45,6 +69,8 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
   periodType?: string;
   /**
    * @remarks
+   * The quota dimension or throttling type. Currently, only token is supported.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -53,6 +79,8 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
   quotaDimension?: string;
   /**
    * @remarks
+   * The total available quota per period.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -61,6 +89,8 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
   quotaLimit?: number;
   /**
    * @remarks
+   * The name of the rule.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -68,11 +98,17 @@ export class AddGatewayQuotaRuleRequest extends $dara.Model {
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The time zone for the calendar period, in UTC+x format.
+   * 
    * @example
    * UTC+8
    */
   timezone?: string;
   /**
+   * @remarks
+   * The reset period alignment type. Currently, only calendar alignment is supported, which means windowAlignment="calendar".
+   * 
    * @example
    * calendar
    */

package/src/models/AddGatewayQuotaRuleResponseBody.ts

@@ -3,14 +3,39 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
+  /**
+   * @remarks
+   * The period type of the existing conflicting rule on the consumer. Valid values:
+   * - day: The period of the existing conflicting rule is day.
+   * - week: The period of the existing conflicting rule is week.
+   * - month: The period of the existing conflicting rule is month.
+   * 
+   * @example
+   * week
+   */
   conflictPeriodType?: string;
+  /**
+   * @remarks
+   * The type of the existing conflicting rule on the consumer. Valid values:
+   * - calendar: The existing conflicting rule uses a calendar period.
+   * - epoch: The existing conflicting rule uses a custom period.
+   * 
+   * @example
+   * calendar
+   */
   conflictType?: string;
   /**
+   * @remarks
+   * The consumer ID.
+   * 
    * @example
    * cs-xxxxxx
    */
   consumerId?: string;
   /**
+   * @remarks
+   * The consumer name.
+   * 
    * @example
    * consumer-a
    */
@@ -44,12 +69,22 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $da
 
 export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
   /**
+   * @remarks
+   * The conflict hash.
+   * 
    * @example
    * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
    */
   conflictHash?: string;
+  /**
+   * @remarks
+   * The list of conflicting principals (consumers).
+   */
   items?: AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
   /**
+   * @remarks
+   * The total number of conflicts.
+   * 
    * @example
    * 2
    */
@@ -84,17 +119,30 @@ export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Mo
 
 export class AddGatewayQuotaRuleResponseBodyData 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?: AddGatewayQuotaRuleResponseBodyDataConflictPreview;
   /**
+   * @remarks
+   * Indicates whether the request is a dry run.
+   * 
    * @example
    * false
    */
   dryRun?: boolean;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * qr-xxxxx
    */
@@ -131,21 +179,33 @@ export class AddGatewayQuotaRuleResponseBodyData extends $dara.Model {
 
 export class AddGatewayQuotaRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code or error code.
+   * 
    * @example
    * 200, 404, 500
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {\\"key\\": \\"value\\"}
    */
   data?: AddGatewayQuotaRuleResponseBodyData;
   /**
+   * @remarks
+   * The message content.
+   * 
    * @example
    * 你好，世界！
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 1234567890
    */

package/src/models/AddGatewaySecurityGroupRuleRequest.ts

@@ -13,7 +13,7 @@ export class AddGatewaySecurityGroupRuleRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The port range.
+   * The port ranges.
    */
   portRanges?: string[];
   /**

package/src/models/Attachment.ts

@@ -5,36 +5,33 @@ import * as $dara from '@darabonba/typescript';
 export class Attachment extends $dara.Model {
   /**
    * @remarks
-   * The attachment point ID.
+   * attachResourceId
+   * 
+   * @example
+   * gw-xxx
    */
   attachResourceId?: string;
   /**
    * @remarks
-   * A list of attached resource IDs.
+   * The list of mounted resource IDs.
    */
   attachResourceIds?: string[];
   /**
    * @remarks
-   * A list of parent resource IDs.
+   * The list of parent IDs of the mounted resource.
    */
   attachResourceParentIds?: string[];
   /**
    * @remarks
-   * The supported attachment point types for the policy.
-   * 
-   * - `HttpApi`: An HTTP API.
-   * 
-   * - `Operation`: An operation of an HTTP API.
-   * 
-   * - `GatewayRoute`: A gateway route.
-   * 
-   * - `GatewayService`: A gateway service.
-   * 
-   * - `GatewayServicePort`: A gateway service port.
-   * 
-   * - `Domain`: A gateway domain.
+   * The type of mount point supported by the policy. Valid values:
    * 
-   * - `Gateway`: A gateway.
+   * - HttpApi: HttpApi.
+   * - Operation: Operation of HttpApi.
+   * - GatewayRoute: gateway route.
+   * - GatewayService: gateway service.
+   * - GatewayServicePort: gateway service port.
+   * - Domain: gateway domain name.
+   * - Gateway: gateway.
    * 
    * @example
    * HttpApi
@@ -42,7 +39,7 @@ export class Attachment extends $dara.Model {
   attachResourceType?: string;
   /**
    * @remarks
-   * The ID of the environment for the attached resource. An asterisk (`*`) indicates that the policy attachment is not environment-specific.
+   * The environment to which the mounted resource belongs. If the environment ID is *, the mounted resource of the policy is not associated with any environment.
    * 
    * @example
    * env-cq7l5s5lhtgi6qasrdc0
@@ -50,7 +47,7 @@ export class Attachment extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The ID of the gateway for the attached resource.
+   * The gateway to which the mounted resource belongs.
    * 
    * @example
    * gw-cpr4f9dlhtgq5ksfgmb0
@@ -58,7 +55,7 @@ export class Attachment extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The policy attachment ID.
+   * The policy mount ID.
    * 
    * @example
    * pr-cq7l5s5lhtgi6qasrdc0

package/src/models/BatchDeleteConsumerAuthorizationRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BatchDeleteConsumerAuthorizationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of API consumer authorization rule IDs.
+   * The list of consumer authorization rule IDs.
    * 
    * @example
    * car-cus2d1em1hkg7732kuk0

package/src/models/ChangeResourceGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChangeResourceGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * Target resource group ID.
+   * The ID of the destination resource group.
    * 
    * @example
    * rg-aekzdrfx2xdnaja
@@ -13,7 +13,7 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Resource ID
+   * The resource ID.
    * 
    * @example
    * gw-ct4i14um1hkn0tpqfae0
@@ -21,7 +21,7 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   resourceId?: string;
   /**
    * @remarks
-   * Resource type
+   * The resource type.
    * 
    * @example
    * gateway
@@ -29,7 +29,7 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   resourceType?: string;
   /**
    * @remarks
-   * Service name, fixed value apig
+   * The service name. Set this parameter to apig.
    * 
    * @example
    * apig

package/src/models/ChangeResourceGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ChangeResourceGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 59F86F37-787A-52DB-9475-DB5A255517F0

package/src/models/ConsumerGroupInfo.ts

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ConsumerGroupInfo extends $dara.Model {
+  /**
+   * @example
+   * csg-8c13d2b4f8a1
+   */
+  consumerGroupId?: string;
+  /**
+   * @example
+   * API
+   */
+  gatewayType?: string;
+  /**
+   * @example
+   * api-consumer-group
+   */
+  name?: string;
+  static names(): { [key: string]: string } {
+    return {
+      consumerGroupId: 'consumerGroupId',
+      gatewayType: 'gatewayType',
+      name: 'name',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      consumerGroupId: 'string',
+      gatewayType: 'string',
+      name: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAiModelProviderRequest.ts

@@ -0,0 +1,51 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateAiModelProviderRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  displayName?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  gatewayId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   */
+  provider?: string;
+  serviceIds?: string[];
+  static names(): { [key: string]: string } {
+    return {
+      displayName: 'displayName',
+      gatewayId: 'gatewayId',
+      provider: 'provider',
+      serviceIds: 'serviceIds',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      displayName: 'string',
+      gatewayId: 'string',
+      provider: 'string',
+      serviceIds: { 'type': 'array', 'itemType': 'string' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.serviceIds)) {
+      $dara.Model.validateArray(this.serviceIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateAiModelProviderResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateAiModelProviderResponseBody } from "./CreateAiModelProviderResponseBody";
+
+
+export class CreateAiModelProviderResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateAiModelProviderResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateAiModelProviderResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+