@alicloud/apig20240327 9.2.0 → 9.3.0

package/src/models/ListSecretsResponseBody.ts

@@ -6,7 +6,7 @@ import { KMSConfig } from "./Kmsconfig";
 export class ListSecretsResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * Unix timestamp when the secret was created
+   * The creation timestamp.
    * 
    * @example
    * 1725617840096
@@ -14,7 +14,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   createTimestamp?: number;
   /**
    * @remarks
-   * Gateway type associated with the secret
+   * The gateway type.
    * 
    * @example
    * API
@@ -22,12 +22,12 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * KMS configuration object
+   * The KMS configuration information.
    */
   kmsConfig?: KMSConfig;
   /**
    * @remarks
-   * Name of the secret
+   * The key name.
    * 
    * @example
    * my_secret
@@ -35,7 +35,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Number of resources referencing this secret
+   * The resource count of resources that reference the current key.
    * 
    * @example
    * 3
@@ -43,7 +43,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   referenceCount?: number;
   /**
    * @remarks
-   * Source of the ID
+   * The key ID.
    * 
    * @example
    * sec-d5e6shmm1hkoxxxxxxxx
@@ -51,7 +51,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   secretId?: string;
   /**
    * @remarks
-   * Source of the secret
+   * The key source.
    * 
    * @example
    * KMS
@@ -59,7 +59,10 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   secretSource?: string;
   /**
    * @remarks
-   * Current status of the secret
+   * The key status. Valid values:
+   * - ENABLE: Enabled.
+   * - DISABLE: Disabled.
+   * - DELETED: Deleted.
    * 
    * @example
    * ENABLE
@@ -67,7 +70,7 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Unix timestamp when the secret was last updated
+   * The update timestamp. Unit: milliseconds.
    * 
    * @example
    * 1721116090326
@@ -116,12 +119,12 @@ export class ListSecretsResponseBodyDataItems extends $dara.Model {
 export class ListSecretsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * Array of secret details
+   * The list of key details.
    */
   items?: ListSecretsResponseBodyDataItems[];
   /**
    * @remarks
-   * Page number
+   * The page number.
    * 
    * @example
    * 1
@@ -129,7 +132,7 @@ export class ListSecretsResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page
+   * The page size.
    * 
    * @example
    * 10
@@ -137,7 +140,7 @@ export class ListSecretsResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Total number of records matching the query
+   * The total number of entries.
    * 
    * @example
    * 10
@@ -176,7 +179,7 @@ export class ListSecretsResponseBodyData extends $dara.Model {
 export class ListSecretsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Code of the request
+   * The response status code.
    * 
    * @example
    * Ok
@@ -184,12 +187,12 @@ export class ListSecretsResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Data
+   * The list of key information.
    */
   data?: ListSecretsResponseBodyData;
   /**
    * @remarks
-   * message
+   * The response message.
    * 
    * @example
    * success

package/src/models/ListServicesRequest.ts

@@ -46,11 +46,11 @@ export class ListServicesRequest extends $dara.Model {
   /**
    * @remarks
    * The source type of the service. Valid values:
-   * - MSE_NACOS: The service is from MSE Nacos.
-   * - K8S: The service is from a Kubernetes cluster in Container Service.
-   * - FC3: The service is from Function Compute.
-   * - VIP: The service is from a fixed address.
-   * - DNS: The service is from a domain name.
+   * - MSE_NACOS: services from MSE Nacos.
+   * - K8S: services from a Kubernetes cluster in Container Service.
+   * - FC3: services from Function Compute.
+   * - VIP: services with a fixed address.
+   * - DNS: services with a domain name.
    * 
    * @example
    * MSE_NACOS

package/src/models/ListSslCertsResponseBody.ts

@@ -6,7 +6,7 @@ import { SslCertMetaInfo } from "./SslCertMetaInfo";
 export class ListSslCertsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of certificate information.
+   * The list of certificates.
    */
   items?: SslCertMetaInfo[];
   /**

package/src/models/ListTagResourcesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The label key.
+   * 
    * @example
    * env
    */
   key?: string;
   /**
+   * @remarks
+   * The label value.
+   * 
    * @example
    * prod
    */
@@ -38,21 +44,33 @@ export class ListTagResourcesRequestTag extends $dara.Model {
 
 export class ListTagResourcesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The token that determines the start point of the next query.
+   * 
    * @example
    * caeb235b-xxx
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The resource ID. You can specify up to 50 subkeys.
+   * 
    * @example
    * ["gw-xxx","gw-yyy"]
    */
   resourceId?: string[];
   /**
+   * @remarks
+   * The resource type.
+   * 
    * @example
    * Gateway
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The list of labels to add. You can specify up to 20 subkeys.
+   * 
    * @example
    * [{"key":"env","value":"prod"}]
    */

package/src/models/ListTagResourcesResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesResponseBodyTagResources extends $dara.Model {
   /**
+   * @remarks
+   * The resource ID.
+   * 
    * @example
    * gw-xxx
    */
   resourceId?: string;
   /**
+   * @remarks
+   * The resource type.
+   * 
    * @example
    * gateway
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The label key.
+   * 
    * @example
    * env
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The label value.
+   * 
    * @example
    * prod
    */
@@ -52,15 +64,25 @@ export class ListTagResourcesResponseBodyTagResources extends $dara.Model {
 
 export class ListTagResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The token that determines the start point of the next query. An empty value of NextToken indicates that no more results exist.
+   * 
    * @example
    * caeb235b-xxx
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 59F86F37-787A-52DB-9475-DB5A255517F0
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The list of resources.
+   */
   tagResources?: ListTagResourcesResponseBodyTagResources[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListTagResourcesShrinkRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListTagResourcesShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The token that determines the start point of the next query.
+   * 
    * @example
    * caeb235b-xxx
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The resource ID. You can specify up to 50 subkeys.
+   * 
    * @example
    * ["gw-xxx","gw-yyy"]
    */
   resourceIdShrink?: string;
   /**
+   * @remarks
+   * The resource type.
+   * 
    * @example
    * Gateway
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The list of labels to add. You can specify up to 20 subkeys.
+   * 
    * @example
    * [{"key":"env","value":"prod"}]
    */

package/src/models/ListZonesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListZonesResponseBodyDataItems extends $dara.Model {
   /**
    * @remarks
-   * Whether QAT (Quality Assurance Testing) is supported in this zone
+   * Indicates whether QuickAssist Technology (QAT) is supported.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class ListZonesResponseBodyDataItems extends $dara.Model {
   supportQat?: string;
   /**
    * @remarks
-   * The zone identifier
+   * The zone ID.
    * 
    * @example
    * cn-shenzhen-c
@@ -45,7 +45,7 @@ export class ListZonesResponseBodyDataItems extends $dara.Model {
 export class ListZonesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of queried zones.
+   * The list of zones.
    */
   items?: ListZonesResponseBodyDataItems[];
   static names(): { [key: string]: string } {
@@ -75,7 +75,7 @@ export class ListZonesResponseBodyData extends $dara.Model {
 export class ListZonesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Response status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -83,12 +83,12 @@ export class ListZonesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The data returned.
+   * The response data.
    */
   data?: ListZonesResponseBodyData;
   /**
    * @remarks
-   * Response message.
+   * The response message.
    * 
    * @example
    * success
@@ -96,7 +96,7 @@ export class ListZonesResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * E8079207-B651-592A-A565-23E9EE5673B0

package/src/models/PluginClassInfo.ts

@@ -3,22 +3,141 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PluginClassInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The plugin class alias.
+   * 
+   * @example
+   * AI安全护栏
+   */
   alias?: string;
+  /**
+   * @remarks
+   * The configuration example (JSON string).
+   * 
+   * @example
+   * {"checkRequest":true}
+   */
   configExample?: string;
+  /**
+   * @remarks
+   * The plugin class description.
+   * 
+   * @example
+   * AI请求内容安全检测插件
+   */
   description?: string;
+  /**
+   * @remarks
+   * The execution priority.
+   * 
+   * @example
+   * 100
+   */
   executePriority?: number;
+  /**
+   * @remarks
+   * The execution stage.
+   * 
+   * @example
+   * AUTHN
+   */
   executeStage?: string;
+  /**
+   * @remarks
+   * The Wasm image name.
+   * 
+   * @example
+   * higress-registry.tencentcloudcr.com/ai-security-guard
+   */
   imageName?: string;
+  /**
+   * @remarks
+   * Indicates whether the plugin is a built-in plugin.
+   * 
+   * @example
+   * false
+   */
   innerPlugin?: boolean;
+  /**
+   * @remarks
+   * The plugin running mode.
+   * 
+   * @example
+   * Wasm
+   */
   mode?: string;
+  /**
+   * @remarks
+   * The plugin class name.
+   * 
+   * @example
+   * ai-security-guard
+   */
   name?: string;
+  /**
+   * @remarks
+   * The plugin class ID.
+   * 
+   * @example
+   * cls-xxx
+   */
   pluginClassId?: string;
+  /**
+   * @remarks
+   * The plugin source.
+   * 
+   * @example
+   * HigressOfficial
+   */
   source?: string;
+  /**
+   * @remarks
+   * The minimum supported gateway DPI engine version.
+   * 
+   * @example
+   * 2.1.11
+   */
   supportedMinGatewayVersion?: string;
+  /**
+   * @remarks
+   * The plugin type category.
+   * 
+   * @example
+   * AI
+   */
   type?: string;
+  /**
+   * @remarks
+   * The plugin version number.
+   * 
+   * @example
+   * 1.0.0
+   */
   version?: string;
+  /**
+   * @remarks
+   * The version description.
+   * 
+   * @example
+   * 初始版本
+   */
   versionDescription?: string;
+  /**
+   * @remarks
+   * The Wasm programming language.
+   * 
+   * @example
+   * Rust
+   */
   wasmLanguage?: string;
+  /**
+   * @remarks
+   * The Wasm file download URL.
+   * 
+   * @example
+   * https://...
+   */
   wasmUrl?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/PolicyDetailInfo.ts

@@ -3,11 +3,53 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PolicyDetailInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The policy class ID.
+   * 
+   * @example
+   * cls-xxx
+   */
   classId?: string;
+  /**
+   * @remarks
+   * The policy type name.
+   * 
+   * @example
+   * RateLimit
+   */
   className?: string;
+  /**
+   * @remarks
+   * The policy configuration content (JSON string).
+   * 
+   * @example
+   * {"rate":100,"burst":50}
+   */
   config?: string;
+  /**
+   * @remarks
+   * The policy description.
+   * 
+   * @example
+   * 每秒限流100次
+   */
   description?: string;
+  /**
+   * @remarks
+   * The policy name.
+   * 
+   * @example
+   * my-rate-limit
+   */
   name?: string;
+  /**
+   * @remarks
+   * The policy ID.
+   * 
+   * @example
+   * plc-xxx
+   */
   policyId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/QueryConsumerAuthorizationRulesRequest.ts

@@ -11,6 +11,11 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
    * api-xx
    */
   apiNameLike?: string;
+  /**
+   * @example
+   * csg-8c13d2b4f8a1
+   */
+  consumerGroupId?: string;
   /**
    * @remarks
    * The consumer ID.
@@ -67,6 +72,11 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
    * ha-cn-li942gy8p01
    */
   parentResourceId?: string;
+  /**
+   * @example
+   * ConsumerGroup
+   */
+  principalType?: string;
   /**
    * @remarks
    * The resource ID.
@@ -94,6 +104,7 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       apiNameLike: 'apiNameLike',
+      consumerGroupId: 'consumerGroupId',
       consumerId: 'consumerId',
       consumerNameLike: 'consumerNameLike',
       environmentId: 'environmentId',
@@ -101,6 +112,7 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
       pageNumber: 'pageNumber',
       pageSize: 'pageSize',
       parentResourceId: 'parentResourceId',
+      principalType: 'principalType',
       resourceId: 'resourceId',
       resourceType: 'resourceType',
       resourceTypes: 'resourceTypes',
@@ -110,6 +122,7 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       apiNameLike: 'string',
+      consumerGroupId: 'string',
       consumerId: 'string',
       consumerNameLike: 'string',
       environmentId: 'string',
@@ -117,6 +130,7 @@ export class QueryConsumerAuthorizationRulesRequest extends $dara.Model {
       pageNumber: 'number',
       pageSize: 'number',
       parentResourceId: 'string',
+      principalType: 'string',
       resourceId: 'string',
       resourceType: 'string',
       resourceTypes: 'string',