@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/ListGatewayQuotaRulesResponseBody.ts

@@ -0,0 +1,196 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListGatewayQuotaRulesResponseBodyDataItems extends $dara.Model {
+  /**
+   * @example
+   * week
+   */
+  periodType?: string;
+  /**
+   * @example
+   * token
+   */
+  quotaDimension?: string;
+  /**
+   * @example
+   * 1000
+   */
+  quotaLimit?: number;
+  /**
+   * @example
+   * qr-xxxxx
+   */
+  ruleId?: string;
+  /**
+   * @example
+   * daily-token-limit
+   */
+  ruleName?: string;
+  /**
+   * @example
+   * enabled
+   */
+  ruleStatus?: string;
+  /**
+   * @example
+   * GMT+8
+   */
+  timezone?: string;
+  /**
+   * @example
+   * calendar
+   */
+  windowAlignment?: string;
+  static names(): { [key: string]: string } {
+    return {
+      periodType: 'periodType',
+      quotaDimension: 'quotaDimension',
+      quotaLimit: 'quotaLimit',
+      ruleId: 'ruleId',
+      ruleName: 'ruleName',
+      ruleStatus: 'ruleStatus',
+      timezone: 'timezone',
+      windowAlignment: 'windowAlignment',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      periodType: 'string',
+      quotaDimension: 'string',
+      quotaLimit: 'number',
+      ruleId: 'string',
+      ruleName: 'string',
+      ruleStatus: 'string',
+      timezone: 'string',
+      windowAlignment: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListGatewayQuotaRulesResponseBodyData extends $dara.Model {
+  /**
+   * @example
+   * [{"ruleId":"rule-001"}]
+   */
+  items?: ListGatewayQuotaRulesResponseBodyDataItems[];
+  /**
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @example
+   * 100
+   */
+  totalSize?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'items',
+      pageNumber: 'pageNumber',
+      pageSize: 'pageSize',
+      totalSize: 'totalSize',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': ListGatewayQuotaRulesResponseBodyDataItems },
+      pageNumber: 'number',
+      pageSize: 'number',
+      totalSize: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListGatewayQuotaRulesResponseBody extends $dara.Model {
+  /**
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @example
+   * {"totalSize":100}
+   */
+  data?: ListGatewayQuotaRulesResponseBodyData;
+  /**
+   * @example
+   * 100
+   */
+  maxResults?: number;
+  /**
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @example
+   * 762b1fa4e2434fd3959b1f66481979cf
+   */
+  nextToken?: string;
+  /**
+   * @example
+   * 1234567890
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      maxResults: 'maxResults',
+      message: 'message',
+      nextToken: 'nextToken',
+      requestId: 'requestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: ListGatewayQuotaRulesResponseBodyData,
+      maxResults: 'number',
+      message: 'string',
+      nextToken: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListHttpApiRoutesRequest.ts

@@ -10,7 +10,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   backendServiceName?: string;
   /**
    * @remarks
-   * The string that is used to filter routes based on consumer authentication rules. Only authorized APIs are returned.
+   * Filters the results, returning only routes authorized by the specified consumer authorization rule.
    * 
    * @example
    * cas-xxx
@@ -18,17 +18,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   consumerAuthorizationRuleId?: string;
   /**
    * @remarks
-   * The deployment state of the route.
-   * 
-   * Enumerated values:
-   * 
-   * *   Deploying: The route is being deployed.
-   * *   DeployedWithChanges: The route is deployed and modified.
-   * *   Undeploying: The route is being undeployed.
-   * *   NotDeployed: The route is not deployed.
-   * *   Deployed: The route is deployed.
-   * *   UndeployFailed: The route failed to be undeployed.
-   * *   DeployFailed: The route failed to be deployed.
+   * The deployment status of the route.
    * 
    * @example
    * NotDeployed
@@ -36,7 +26,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   deployStatuses?: string;
   /**
    * @remarks
-   * Specifies to filter routes by domain ID.
+   * Filters routes by the specified domain ID.
    * 
    * @example
    * d-xxx
@@ -52,7 +42,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * Whether to filter for deployment scenario
+   * Set to `true` if the query is for a deployment scenario.
    * 
    * @example
    * true
@@ -60,7 +50,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   forDeploy?: boolean;
   /**
    * @remarks
-   * The ID of the Cloud-native API Gateway instance.
+   * The cloud-native API gateway ID.
    * 
    * @example
    * gw-cpv4sqdl****
@@ -68,7 +58,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The route name.
+   * The route name. This parameter requires an exact match.
    * 
    * @example
    * itemcenter-gateway
@@ -76,7 +66,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The route name keyword for a fuzzy search.
+   * Filters the results by route name using a fuzzy search.
    * 
    * @example
    * item
@@ -84,7 +74,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * The page number of the page to return. Pages start from page 1. Default value: 1.
+   * The page number, starting from 1. Defaults to 1 if unspecified.
    * 
    * @example
    * 1
@@ -92,7 +82,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values: 1 to 100. Default value: 10.
+   * The page size. Valid values are 1 to 100. Defaults to 10 if unspecified.
    * 
    * @example
    * 10
@@ -100,7 +90,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The route path keyword for a fuzzy search.
+   * Filters the results by route path using a fuzzy search.
    * 
    * @example
    * /v1
@@ -108,7 +98,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   pathLike?: string;
   /**
    * @remarks
-   * The consumer authorization information in the response.
+   * Set to `true` to include the consumer authorization policy in the response.
    * 
    * @example
    * true
@@ -116,7 +106,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   withAuthPolicyInfo?: boolean;
   /**
    * @remarks
-   * The authentication rules of the specified consumer in each route returned.
+   * The consumer ID. If specified, the response includes the consumer\\"s associated authorization rules for each route.
    * 
    * @example
    * cs-xxx
@@ -124,7 +114,7 @@ export class ListHttpApiRoutesRequest extends $dara.Model {
   withConsumerInfoById?: string;
   /**
    * @remarks
-   * The mounting information of the specified plug-in in each route returned.
+   * The plugin ID. If specified, the response includes the attachment information for this plugin for each route.
    * 
    * @example
    * pl-xxx

package/src/models/ListHttpApiRoutesResponseBody.ts

@@ -6,12 +6,12 @@ import { HttpRoute } from "./HttpRoute";
 export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The routes.
+   * An array of route objects.
    */
   items?: HttpRoute[];
   /**
    * @remarks
-   * The page number of the returned page.
+   * The current page number.
    * 
    * @example
    * 1
@@ -19,7 +19,7 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 20
@@ -27,7 +27,7 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of available entries.
    * 
    * @example
    * 9
@@ -66,7 +66,7 @@ export class ListHttpApiRoutesResponseBodyData extends $dara.Model {
 export class ListHttpApiRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -74,12 +74,12 @@ export class ListHttpApiRoutesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: ListHttpApiRoutesResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/ListHttpApisResponseBody.ts

@@ -69,7 +69,7 @@ export class ListHttpApisResponseBody extends $dara.Model {
    * The status code.
    * 
    * @example
-   * 200
+   * Ok
    */
   code?: string;
   /**

package/src/models/ListMcpServersResponseBody.ts

@@ -69,7 +69,7 @@ export class ListMcpServersResponseBodyDataItemsNacosMcpSyncInfo extends $dara.M
    * The synchronized MCP server ID.
    * 
    * @example
-   * nacos-mcp-001
+   * 同步的MCP Server ID
    */
   importMcpServerId?: string;
   /**
@@ -151,7 +151,7 @@ export class ListMcpServersResponseBodyDataItems extends $dara.Model {
    * The description.
    * 
    * @example
-   * My MCP Server
+   * 这是xxx的xx项目测试环境
    */
   description?: string;
   /**
@@ -198,7 +198,7 @@ export class ListMcpServersResponseBodyDataItems extends $dara.Model {
    * The HTTP-to-MCP configurations.
    * 
    * @example
-   * mcp spec content
+   * HTTP转MCP Config base64值
    */
   mcpServerConfig?: string;
   /**
@@ -259,7 +259,7 @@ export class ListMcpServersResponseBodyDataItems extends $dara.Model {
    * The type of the MCP server. Valid values: RealMCP and AssemblyMCP.
    * 
    * @example
-   * RealMCP
+   * 可选值：RealMCP、AssemblyMCP
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/ListPluginAttachmentsResponseBody.ts

@@ -10,10 +10,15 @@ export class ListPluginAttachmentsResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
    * The types of resource attachments.
+   * 
    * - HttpApi
+   * 
    * - Operation
+   * 
    * - GatewayRoute
+   * 
    * - GatewayDomain
+   * 
    * - Gateway
    * 
    * @example

package/src/models/ListPluginClassesRequest.ts

@@ -6,6 +6,9 @@ export class ListPluginClassesRequest extends $dara.Model {
   /**
    * @remarks
    * The alias keyword for a fuzzy search.
+   * 
+   * @example
+   * OAuth2 认证
    */
   aliasLike?: string;
   /**

package/src/models/ListPluginClassesResponseBody.ts

@@ -6,11 +6,17 @@ export class ListPluginClassesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
    * The alias of the plugin.
+   * 
+   * @example
+   * OAuth2 认证
    */
   alias?: string;
   /**
    * @remarks
    * The description of the plugin.
+   * 
+   * @example
+   * 基于 OAuth2 实现身份认证和鉴权。
    */
   description?: string;
   /**

package/src/models/ListPluginsResponseBody.ts

@@ -88,7 +88,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
    * The alias.
    * 
    * @example
-   * key-based rate limit
+   * 基于 Key 限流
    */
   alias?: string;
   /**
@@ -144,7 +144,7 @@ export class ListPluginsResponseBodyDataItemsPluginClassInfo extends $dara.Model
    * The description of the version.
    * 
    * @example
-   * version description
+   * 版本描述
    */
   versionDescription?: string;
   static names(): { [key: string]: string } {

package/src/models/ListPoliciesRequest.ts

@@ -13,14 +13,20 @@ export class ListPoliciesRequest extends $dara.Model {
   attachResourceId?: string;
   /**
    * @remarks
-   * The types of attachment points supported by the policy. Valid values: 
+   * The types of attachment points supported by the policy. Valid values:
    * 
    * - HttpApi
+   * 
    * - Operation
+   * 
    * - GatewayRoute
+   * 
    * - GatewayService
+   * 
    * - GatewayServicePort
+   * 
    * - Domain
+   * 
    * - Gateway
    * 
    * @example

package/src/models/ListSecretsRequest.ts

@@ -8,7 +8,7 @@ export class ListSecretsRequest extends $dara.Model {
    * Gateway type for filtering secrets of specific gateway type
    * 
    * @example
-   * API
+   * AI
    */
   gatewayType?: string;
   /**
@@ -16,7 +16,7 @@ export class ListSecretsRequest extends $dara.Model {
    * Secret name for fuzzy matching, supports filtering secrets by name
    * 
    * @example
-   * test-secret
+   * my_secret
    */
   nameLike?: string;
   /**

package/src/models/ListSecretsResponseBody.ts

@@ -9,7 +9,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
    * Unix timestamp when the secret was created
    * 
    * @example
-   * 1234567890
+   * 1725617840096
    */
   createTimestamp?: number;
   /**
@@ -30,7 +30,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
    * Name of the secret
    * 
    * @example
-   * test-secret
+   * my_secret
    */
   name?: string;
   /**
@@ -38,7 +38,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
    * Number of resources referencing this secret
    * 
    * @example
-   * 5
+   * 3
    */
   referenceCount?: number;
   /**
@@ -46,7 +46,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
    * Source of the ID
    * 
    * @example
-   * xxxxxx
+   * sec-d5e6shmm1hkoxxxxxxxx
    */
   secretId?: string;
   /**
@@ -70,7 +70,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
    * Unix timestamp when the secret was last updated
    * 
    * @example
-   * 1234567890
+   * 1721116090326
    */
   updateTimestamp?: number;
   static names(): { [key: string]: string } {
@@ -140,7 +140,7 @@ export class ListSecretsResponseBodyData extends $dara.Model {
    * Total number of records matching the query
    * 
    * @example
-   * 104
+   * 10
    */
   totalSize?: number;
   static names(): { [key: string]: string } {
@@ -179,7 +179,7 @@ export class ListSecretsResponseBody extends $dara.Model {
    * Code of the request
    * 
    * @example
-   * 200
+   * Ok
    */
   code?: string;
   /**
@@ -200,7 +200,7 @@ export class ListSecretsResponseBody extends $dara.Model {
    * Id of the request
    * 
    * @example
-   * 2F270C0B-7D6A-5DA7-93E2-******
+   * 3A3D1392-0F71-5A10-9AE8-89C434696966
    */
   requestId?: string;
   static names(): { [key: string]: string } {

package/src/models/PolicyClassInfo.ts

@@ -8,7 +8,7 @@ export class PolicyClassInfo extends $dara.Model {
    * The template alias.
    * 
    * @example
-   * Rate Limit
+   * 并发控制
    */
   alias?: string;
   /**
@@ -45,7 +45,7 @@ export class PolicyClassInfo extends $dara.Model {
    * The template description.
    * 
    * @example
-   * Limits the number of requests per unit of time
+   * 通过控制并发线程数以保证系统的稳定性。适用于应用内部或下游依赖出现不稳定的场景，例如慢SQL、下游应用响应时间变长等。
    */
   description?: string;
   /**

package/src/models/PolicyInfo.ts

@@ -12,6 +12,9 @@ export class PolicyInfo extends $dara.Model {
   /**
    * @remarks
    * The policy class alias.
+   * 
+   * @example
+   * 流量控制
    */
   classAlias?: string;
   /**
@@ -38,6 +41,9 @@ export class PolicyInfo extends $dara.Model {
    * *   JWTAuth: implements global JWT authentication. Supported: Gateway.
    * *   OIDCAuth: implements global OIDC authentication. Supported: Gateway.
    * *   ExternalZAuth: implements custom authentication. Supported: Gateway.
+   * 
+   * @example
+   * RateLimit
    */
   className?: string;
   /**
@@ -104,6 +110,9 @@ export class PolicyInfo extends $dara.Model {
   /**
    * @remarks
    * The policy type.
+   * 
+   * @example
+   * 策略类型
    */
   type?: string;
   static names(): { [key: string]: string } {