@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/GetGatewayQuotaRuleRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetGatewayQuotaRuleRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number of the consumer list.
+   * 
    * @example
    * 1
    * 
@@ -11,12 +14,19 @@ export class GetGatewayQuotaRuleRequest extends $dara.Model {
    */
   consumerPageNumber?: string;
   /**
+   * @remarks
+   * The page size of the consumer list.
+   * 
    * @example
    * 10
    * 
    * @deprecated
    */
   consumerPageSize?: string;
+  /**
+   * @remarks
+   * Specifies whether to return the consumer list.
+   */
   withConsumers?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetGatewayQuotaRuleResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetGatewayQuotaRuleResponseBodyDataConsumers extends $dara.Model {
+  /**
+   * @remarks
+   * The principal (consumer) ID.
+   * 
+   * @example
+   * c-aaa
+   */
   id?: string;
+  /**
+   * @remarks
+   * The principal (consumer) name.
+   * 
+   * @example
+   * consumer-a
+   */
   name?: string;
   static names(): { [key: string]: string } {
     return {
@@ -30,52 +44,86 @@ export class GetGatewayQuotaRuleResponseBodyDataConsumers extends $dara.Model {
 
 export class GetGatewayQuotaRuleResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The base timestamp of the period.
+   * 
    * @example
    * 1745846400000
    */
   baseTimestamp?: number;
   /**
+   * @remarks
+   * The number of consumers associated with the rule.
+   * 
    * @example
    * 20
    */
   consumerCount?: number;
+  /**
+   * @remarks
+   * The list of principals (consumers) bound to this rule.
+   */
   consumers?: GetGatewayQuotaRuleResponseBodyDataConsumers[];
   /**
+   * @remarks
+   * The quota period type.
+   * 
    * @example
    * day
    */
   periodType?: string;
   /**
+   * @remarks
+   * The quota dimension.
+   * 
    * @example
    * token
    */
   quotaDimension?: string;
   /**
+   * @remarks
+   * The quota limit.
+   * 
    * @example
    * 1000
    */
   quotaLimit?: number;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * qr-d8j7fpmm1hks65xxxxxx
    */
   ruleId?: string;
   /**
+   * @remarks
+   * The rule name.
+   * 
    * @example
    * daily-token-limit
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The rule status.
+   * 
    * @example
    * enabled
    */
   ruleStatus?: string;
   /**
+   * @remarks
+   * The time zone corresponding to the calendar period, in UTC+x format.
+   * 
    * @example
    * GMT+8
    */
   timezone?: string;
   /**
+   * @remarks
+   * The reset period type. Currently, only calendar period is supported, which means windowAlignment="calendar".
+   * 
    * @example
    * calendar
    */
@@ -126,21 +174,33 @@ export class GetGatewayQuotaRuleResponseBodyData extends $dara.Model {
 
 export class GetGatewayQuotaRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {"ruleId":1001}
    */
   data?: GetGatewayQuotaRuleResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * 1234567890
    */

package/src/models/GetGatewayQuotaRuleSubjectUsageRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetGatewayQuotaRuleSubjectUsageRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number of the detailed consumption (request) records of the consumer within the cycle.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of detailed consumption (request) records per page for the consumer within the cycle. Maximum value: 10.
+   * 
    * @example
    * 10
    */

package/src/models/GetGatewayQuotaRuleSubjectUsageResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends $dara.Model {
   /**
+   * @remarks
+   * The cached token consumption.
+   * 
    * @example
    * 10
    */
   cachedAmount?: number;
   /**
+   * @remarks
+   * The input token consumption.
+   * 
    * @example
    * 120
    */
   inputAmount?: number;
   /**
+   * @remarks
+   * The model name.
+   * 
    * @example
    * qwen-plus
    */
   model?: string;
   /**
+   * @remarks
+   * The output token consumption.
+   * 
    * @example
    * 80
    */
   outputAmount?: number;
   /**
+   * @remarks
+   * The consumption (request) time.
+   * 
    * @example
    * 2026-06-05 13:16:31
    */
   startTime?: string;
   /**
+   * @remarks
+   * The total consumption.
+   * 
    * @example
    * 210
    */
@@ -66,21 +84,33 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems extends
 
 export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetails extends $dara.Model {
   /**
+   * @remarks
+   * The list of usage details.
+   * 
    * @example
    * [{"model":"qwen-plus",\\"usedAmount\\":210}]
    */
   items?: GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetailsItems[];
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The current page size.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 100
    */
@@ -117,36 +147,57 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetails extends $dar
 
 export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The total cached token consumption.
+   * 
    * @example
    * 20
    */
   cachedAmount?: number;
   /**
+   * @remarks
+   * The paginated consumption details.
+   * 
    * @example
    * {"totalSize":100}
    */
   details?: GetGatewayQuotaRuleSubjectUsageResponseBodyDataDetails;
   /**
+   * @remarks
+   * The total input token consumption.
+   * 
    * @example
    * 300
    */
   inputAmount?: number;
   /**
+   * @remarks
+   * The total output token consumption.
+   * 
    * @example
    * 180
    */
   outputAmount?: number;
   /**
+   * @remarks
+   * Indicates whether the quota limit is exceeded.
+   * 
    * @example
    * false
    */
   overLimit?: boolean;
   /**
+   * @remarks
+   * The total quota of the subject.
+   * 
    * @example
    * 1000
    */
   totalQuota?: number;
   /**
+   * @remarks
+   * The total used amount of the subject.
+   * 
    * @example
    * 500
    */
@@ -189,21 +240,33 @@ export class GetGatewayQuotaRuleSubjectUsageResponseBodyData extends $dara.Model
 
 export class GetGatewayQuotaRuleSubjectUsageResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The response data.
+   * 
    * @example
    * {"usedAmount":500}
    */
   data?: GetGatewayQuotaRuleSubjectUsageResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Id of the request
+   * 
    * @example
    * 1234567890
    */

package/src/models/GetHttpApiResponseBody.ts

@@ -6,7 +6,7 @@ import { HttpApiApiInfo } from "./HttpApiApiInfo";
 export class GetHttpApiResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -19,7 +19,7 @@ export class GetHttpApiResponseBody extends $dara.Model {
   data?: HttpApiApiInfo;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -27,7 +27,7 @@ export class GetHttpApiResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 8FA9BB94-915B-5299-A694-49FCC7F5DD00