@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListImageTransformsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListImageTransformsRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID. Can be obtained by calling the [ListImageTransforms](https://help.aliyun.com/document_detail/2869056.html) interface.
+   * The configuration ID. Obtain this ID when you create an image transform or from a previous call to this operation.
    * 
    * @example
    * 352816096987136
@@ -13,11 +13,13 @@ export class ListImageTransformsRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Possible values:
-   * - global: Query global configuration;
-   * - rule: Query rule configuration;
+   * The configuration type. You can use this parameter to query for a global configuration or rule configurations. Valid values:
    * 
-   * This parameter is optional. If not provided, it will not distinguish between global and rule configurations.
+   * - `global`: Retrieves the global configuration.
+   * 
+   * - `rule`: Retrieves rule configurations.
+   * 
+   * This parameter is optional. If not specified, both global and rule configurations are returned.
    * 
    * @example
    * global
@@ -25,7 +27,7 @@ export class ListImageTransformsRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number. The default value is 1 if not provided.
+   * The page number to return. Default: 1.
    * 
    * @example
    * 1
@@ -33,7 +35,7 @@ export class ListImageTransformsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page. The maximum value is 500, and the default value is 500 if not provided.
+   * The number of entries to return per page. Maximum: 500. Default: 500.
    * 
    * @example
    * 20
@@ -41,7 +43,7 @@ export class ListImageTransformsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required for a global configuration.
    * 
    * @example
    * test1
@@ -49,7 +51,7 @@ export class ListImageTransformsRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID. Can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 
@@ -59,7 +61,7 @@ export class ListImageTransformsRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Site version number. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.
+   * The site version. If version management is enabled for the site, use this parameter to specify the version to which the configuration applies. Default: 0.
    * 
    * @example
    * 1

package/src/models/ListImageTransformsResponseBody.ts

@@ -15,7 +15,7 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   autoWebp?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The ID of the configuration.
    * 
    * @example
    * 395386449776640
@@ -23,9 +23,11 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type. Possible values:
-   * - global: Global configuration;
-   * - rule: Rule configuration;
+   * The type of the configuration. Valid values:
+   * 
+   * - `global`: A global configuration.
+   * 
+   * - `rule`: A rule-based configuration.
    * 
    * @example
    * global
@@ -33,9 +35,10 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Switch. Possible values:
+   * Indicates whether the configuration is enabled. Valid values:
    * 
    * - **on**: Enabled.
+   * 
    * - **off**: Disabled.
    * 
    * @example
@@ -44,9 +47,11 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:
-   * - Match all incoming requests: Set the value to true
-   * - Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
+   * The conditional expression that defines the rule used to match user requests. This parameter is not applicable to global configurations.
+   * 
+   * - A value of `true` matches all incoming requests.
+   * 
+   * - A custom expression, such as `(http.host eq "video.example.com")`, matches specific requests.
    * 
    * @example
    * (http.request.uri.path.file_name eq \\"jpg\\")
@@ -54,9 +59,11 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Indicates whether the rule is enabled. This parameter is not applicable to global configurations. Valid values:
+   * 
+   * - **on**: Enabled.
+   * 
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -64,7 +71,7 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The name of the rule. This parameter is not applicable to global configurations.
    * 
    * @example
    * test
@@ -72,7 +79,7 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The execution order of the rule. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -80,7 +87,7 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * Site configuration version number. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.
+   * The version of the site configuration. For a site with version management enabled, this parameter specifies the site version to which the configuration applies. The default is 0.
    * 
    * @example
    * 1
@@ -128,12 +135,12 @@ export class ListImageTransformsResponseBodyConfigs extends $dara.Model {
 export class ListImageTransformsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration list.
+   * A list of configurations.
    */
   configs?: ListImageTransformsResponseBodyConfigs[];
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -141,7 +148,7 @@ export class ListImageTransformsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size. Range: **1~500**, default is **500**.
+   * The number of entries per page, ranging from **1 to 500**. The default is **500**.
    * 
    * @example
    * 10
@@ -149,7 +156,7 @@ export class ListImageTransformsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
@@ -157,7 +164,7 @@ export class ListImageTransformsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total number of records.
+   * The total number of entries.
    * 
    * @example
    * 16
@@ -165,7 +172,7 @@ export class ListImageTransformsResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * Total number of pages.
+   * The total number of pages.
    * 
    * @example
    * 2

package/src/models/ListKeylessServersRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListKeylessServersRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
    * @remarks
+   * The site ID. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListKeylessServersResponseBody.ts

@@ -4,54 +4,81 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListKeylessServersResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The CA certificate used to verify the server certificate of the keyless server. This parameter applies only when `Verify` is set to `true`.
+   * 
    * @example
    * -----BEGIN CERTIFICATE-----****
    */
   caCertificate?: string;
   /**
+   * @remarks
+   * The client certificate. This parameter must be provided with `ClientPrivateKey`.
+   * 
    * @example
    * -----BEGIN CERTIFICATE-----****
    */
   clientCertificate?: string;
   /**
+   * @remarks
+   * The client private key. This parameter must be provided with `ClientCertificate`.
+   * 
    * @example
    * -----BEGIN RSA PRIVATE KEY-----****
    */
   clientPrivateKey?: string;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2024-06-24 07:48:51
    */
   createTime?: string;
   /**
+   * @remarks
+   * The keyless server host name.
+   * 
    * @example
    * example.com
    */
   host?: string;
   /**
    * @remarks
-   * Keyless server ID。
+   * The keyless server ID.
    * 
    * @example
    * babab9db65ee5efcca9f3d41d4b5****
    */
   id?: string;
   /**
+   * @remarks
+   * The keyless server name.
+   * 
    * @example
    * example
    */
   name?: string;
   /**
+   * @remarks
+   * The keyless server port. Valid values: 1 to 65535.
+   * 
    * @example
    * 443
    */
   port?: number;
   /**
+   * @remarks
+   * The update time.
+   * 
    * @example
    * 2024-07-20 06:18:42
    */
   updateTime?: string;
   /**
+   * @remarks
+   * Specifies whether to verify the server certificate of the keyless server. Defaults to false.
+   * 
    * @example
    * true
    */
@@ -97,32 +124,54 @@ export class ListKeylessServersResponseBodyResult extends $dara.Model {
 
 export class ListKeylessServersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
    */
   requestId?: string;
+  /**
+   * @remarks
+   * A list of keyless server configurations.
+   */
   result?: ListKeylessServersResponseBodyResult[];
   /**
+   * @remarks
+   * The site ID.
+   * 
    * @example
    * 54362329990032
    */
   siteId?: number;
   /**
+   * @remarks
+   * The site name.
+   * 
    * @example
    * example.com
    */
   siteName?: string;
   /**
+   * @remarks
+   * The total count.
+   * 
    * @example
    * 90
    */

package/src/models/ListKvsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListKvsRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the namespace that you specify when you call the [CreatevNamespace](https://help.aliyun.com/document_detail/2850317.html) operation.
+   * The name that you specified when you called [CreatevNamespace](https://help.aliyun.com/document_detail/2850317.html).
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ListKvsRequest extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * The page number. The product of PageNumber and PageSize cannot exceed 50,000.
+   * The page number to return. The value of PageNumber \\* PageSize cannot exceed 50,000.
    * 
    * @example
    * 10
@@ -23,7 +23,7 @@ export class ListKvsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: 50. Maximum value: 100.
+   * The number of entries to return on each page. Default: **50**. Maximum: **100**.
    * 
    * @example
    * 50
@@ -31,7 +31,7 @@ export class ListKvsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The prefix to query.
+   * The prefix of the keys to return.
    * 
    * @example
    * prefix-

package/src/models/ListKvsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListKvsResponseBodyKeys extends $dara.Model {
   /**
    * @remarks
-   * The key name.
+   * The name of the key.
    * 
    * @example
    * Key1
@@ -45,12 +45,12 @@ export class ListKvsResponseBodyKeys extends $dara.Model {
 export class ListKvsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The key-value pairs.
+   * The list of key-value pairs returned by this traversal.
    */
   keys?: ListKvsResponseBodyKeys[];
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 100
@@ -58,7 +58,7 @@ export class ListKvsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of records on each page.
    * 
    * @example
    * 50
@@ -74,7 +74,7 @@ export class ListKvsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of records.
    * 
    * @example
    * 1024

package/src/models/ListListsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListListsRequestQueryArgs extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to sort the returned data in descending order.
+   * If true, sorts the results in descending order.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   desc?: boolean;
   /**
    * @remarks
-   * The list description for fuzzy search.
+   * Filters by a partial match on the list description.
    * 
    * @example
    * a custom list
@@ -21,7 +21,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   descriptionLike?: string;
   /**
    * @remarks
-   * The list ID for fuzzy search.
+   * Filters by a partial match on the list ID.
    * 
    * @example
    * 40000001
@@ -29,7 +29,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   idLike?: string;
   /**
    * @remarks
-   * The list content for fuzzy search.
+   * Filters by a partial match on a list item.
    * 
    * @example
    * 10.1.1.1
@@ -37,7 +37,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   itemLike?: string;
   /**
    * @remarks
-   * The type of the custom list.
+   * Filters by the list kind.
    * 
    * @example
    * ip
@@ -45,7 +45,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   kind?: string;
   /**
    * @remarks
-   * The list name and content for fuzzy search.
+   * Filters by a partial match on both the list name and list items.
    * 
    * @example
    * 10.1.1.1
@@ -53,7 +53,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   nameItemLike?: string;
   /**
    * @remarks
-   * The list name for fuzzy search.
+   * Filters by a partial match on the list name.
    * 
    * @example
    * example
@@ -61,7 +61,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * The column by which you want to sort the returned data.
+   * Specifies the sort field.
    * 
    * @example
    * id
@@ -105,7 +105,7 @@ export class ListListsRequestQueryArgs extends $dara.Model {
 export class ListListsRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number.
+   * Specifies the page number for paginated results.
    * 
    * @example
    * 1
@@ -113,7 +113,7 @@ export class ListListsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * Specifies the number of results to return per page.
    * 
    * @example
    * 20
@@ -121,7 +121,7 @@ export class ListListsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The query arguments in the JSON format, which contain filter conditions.
+   * A JSON object containing query parameters to filter the results.
    * 
    * @example
    * ListLists

package/src/models/ListListsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListListsResponseBodyLists extends $dara.Model {
   /**
    * @remarks
-   * The list description.
+   * The description of the list.
    * 
    * @example
    * a custom list
@@ -13,7 +13,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom list.[](~~2850217~~)
+   * The ID of the custom list. To get this ID, call the [ListLists](https://help.aliyun.com/document_detail/2850217.html) operation.
    * 
    * @example
    * 40000001
@@ -21,7 +21,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The list type.
+   * The kind of the list.
    * 
    * @example
    * ip
@@ -29,7 +29,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
   kind?: string;
   /**
    * @remarks
-   * The length of the list information array, which indicates how many items the list contains.
+   * The number of items in the list.
    * 
    * @example
    * 100
@@ -37,7 +37,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
   length?: number;
   /**
    * @remarks
-   * The list name.
+   * The name of the list.
    * 
    * @example
    * example
@@ -45,7 +45,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The time when the list was last modified.
+   * The time when the list was last updated.
    * 
    * @example
    * 2024-01-01T00:00:00Z
@@ -83,15 +83,22 @@ export class ListListsResponseBodyLists extends $dara.Model {
 }
 
 export class ListListsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The total number of items across all lists.
+   * 
+   * @example
+   * 5000
+   */
   itemsUsage?: number;
   /**
    * @remarks
-   * The array that contains list information, including list data after paging.
+   * A paginated array of lists.
    */
   lists?: ListListsResponseBodyLists[];
   /**
    * @remarks
-   * The page number returned.
+   * The current page number.
    * 
    * @example
    * 1
@@ -99,7 +106,7 @@ export class ListListsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The page size.
    * 
    * @example
    * 20
@@ -115,7 +122,7 @@ export class ListListsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of filtered lists.
+   * The total number of filtered records.
    * 
    * @example
    * 5
@@ -123,7 +130,7 @@ export class ListListsResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The number of created lists.
+   * The number of lists used by the account.
    * 
    * @example
    * 10

package/src/models/ListListsShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListListsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number.
+   * Specifies the page number for paginated results.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListListsShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * Specifies the number of results to return per page.
    * 
    * @example
    * 20
@@ -21,7 +21,7 @@ export class ListListsShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The query arguments in the JSON format, which contain filter conditions.
+   * A JSON object containing query parameters to filter the results.
    * 
    * @example
    * ListLists