@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/GetHttpsApplicationConfigurationResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Alt-Svc feature switch. Default is disabled. Possible values:
+   * Specifies whether to enable the Alt-Svc feature, which is disabled by default. Valid values:
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -16,10 +17,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   altSvc?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the clear parameter. Default is disabled. Possible values:
+   * Specifies whether to include the `clear` parameter in the Alt-Svc header, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -27,7 +29,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   altSvcClear?: string;
   /**
    * @remarks
-   * Alt-Svc validity period in seconds. The default is 86400 seconds.
+   * The Alt-Svc max-age, in seconds. Default: `86400`.
    * 
    * @example
    * 86400
@@ -35,10 +37,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   altSvcMa?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the persist parameter. Default is disabled. Possible values:
+   * Specifies whether to include the `persist` parameter in the Alt-Svc header, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -46,7 +49,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   altSvcPersist?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 352816096987136
@@ -54,10 +57,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Possible values:
+   * The configuration type. You can query for a global or rule configuration based on this parameter. Valid values:
    * 
-   * - global: Query global configuration.
-   * - rule: Query rule configuration.
+   * - `global`: a global configuration.
+   * 
+   * - `rule`: a rule configuration.
    * 
    * @example
    * global
@@ -65,10 +69,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Whether to enable HSTS. Default is disabled. Possible values:
+   * Specifies whether to enable HSTS, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -76,9 +81,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   hsts?: string;
   /**
    * @remarks
-   * Whether to include subdomains in HSTS, default is off. Value range:
-   * - on: enabled. 
-   * - off: disabled.
+   * Specifies whether to include subdomains in the HSTS policy, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -86,7 +93,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   hstsIncludeSubdomains?: string;
   /**
    * @remarks
-   * HSTS expiration time in seconds.
+   * The value of the `max-age` directive for HSTS, in seconds.
    * 
    * @example
    * 3600
@@ -94,10 +101,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   hstsMaxAge?: string;
   /**
    * @remarks
-   * Whether to enable HSTS preload, default is off. Value range:
+   * Specifies whether to enable HSTS preload, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: enabled.
-   * - off: disabled.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -105,10 +113,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   hstsPreload?: string;
   /**
    * @remarks
-   * Whether to enable forced HTTPS. Default is disabled. Possible values:
+   * Specifies whether to enable force HTTPS, which is disabled by default. Valid values:
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -116,23 +125,55 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   httpsForce?: string;
   /**
    * @remarks
-   * Status code for forced HTTPS redirection. Possible values:
+   * The status code for the force HTTPS redirect. Valid values:
+   * 
+   * - `301`
    * 
-   * - 301
-   * - 302
-   * - 307
-   * - 308
+   * - `302`
+   * 
+   * - `307`
+   * 
+   * - `308`
    * 
    * @example
    * 301
    */
   httpsForceCode?: string;
+  /**
+   * @remarks
+   * Specifies whether to deny TLS handshakes that lack an SNI, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
+   * 
+   * @example
+   * on
+   */
   httpsNoSniDeny?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable SNI verification, which is disabled by default. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
+   * 
+   * @example
+   * on
+   */
   httpsSniVerify?: string;
+  /**
+   * @remarks
+   * The SNI allowlist. Separate multiple values with a space.
+   * 
+   * @example
+   * abc edf
+   */
   httpsSniWhitelist?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * A3790430-3A06-535F-A424-0998BD9A6C9F
@@ -140,9 +181,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter does not need to be set 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 used to match user requests. This parameter is not required for a global configuration. There are two scenarios:
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -150,9 +193,11 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -160,7 +205,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter does not need to be set when adding a global configuration.
+   * The rule name. This parameter is not required for a global configuration.
    * 
    * @example
    * rule_example
@@ -168,7 +213,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -176,7 +221,7 @@ export class GetHttpsApplicationConfigurationResponseBody extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site for which the configuration takes effect. The default is version 0.
+   * The version number of the site configuration. For sites with configuration versioning enabled, this parameter specifies the applicable site version. The default is version `0`.
    * 
    * @example
    * 1

package/src/models/GetImageTransformRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetImageTransformRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID. It can be obtained by calling the [ListImageTransforms](https://help.aliyun.com/document_detail/2869056.html) interface.
+   * The config ID. You can obtain the config ID by calling the [ListImageTransforms](https://help.aliyun.com/document_detail/2869056.html) operation.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetImageTransformRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. You can obtain the site ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/GetImageTransformResponseBody.ts

@@ -15,7 +15,7 @@ export class GetImageTransformResponseBody extends $dara.Model {
   autoWebp?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The config ID.
    * 
    * @example
    * 352816096987136
@@ -23,9 +23,11 @@ export class GetImageTransformResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type. Possible values:
-   * - global: Global configuration;
-   * - rule: Rule-based configuration;
+   * The configuration type. Valid values:
+   * 
+   * - global: The global configuration.
+   * 
+   * - rule: A rule configuration.
    * 
    * @example
    * global
@@ -33,8 +35,10 @@ export class GetImageTransformResponseBody extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Whether to enable image transformation. Possible values:
+   * Indicates whether image transformation is enabled. Valid values:
+   * 
    * - on: Enabled.
+   * 
    * - off: Disabled.
    * 
    * @example
@@ -43,7 +47,7 @@ export class GetImageTransformResponseBody extends $dara.Model {
   enable?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
@@ -51,9 +55,11 @@ export class GetImageTransformResponseBody extends $dara.Model {
   requestId?: 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 of the rule, used to match user requests. This parameter is relevant only for a rule configuration.
+   * 
+   * - 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\\")
@@ -61,8 +67,10 @@ export class GetImageTransformResponseBody extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
+   * The status of the rule. This parameter is relevant only for a rule configuration. Valid values:
+   * 
    * - on: Enabled.
+   * 
    * - off: Disabled.
    * 
    * @example
@@ -71,7 +79,7 @@ export class GetImageTransformResponseBody extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter does not need to be set when adding global configuration.
+   * The rule name. This parameter is relevant only for a rule configuration.
    * 
    * @example
    * test
@@ -79,7 +87,7 @@ export class GetImageTransformResponseBody extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The execution sequence of the rule. A smaller value indicates a higher execution priority.
    * 
    * @example
    * 2
@@ -87,7 +95,7 @@ export class GetImageTransformResponseBody extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the site, defaulting to version 0.
+   * The version number of the site configuration. For a site that has configuration versioning enabled, this value indicates the version to which the configuration applies. The default value is 0.
    * 
    * @example
    * 0

package/src/models/GetIpv6request.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetIPv6Request extends $dara.Model {
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The ID of the site. To obtain this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/GetIpv6responseBody.ts

@@ -5,19 +5,31 @@ import * as $dara from '@darabonba/typescript';
 export class GetIPv6ResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether IPv6 is enabled. Valid values:
+   * Specifies whether IPv6 is enabled. Valid values:
    * 
-   * *   **on**
-   * *   **off**
+   * - **on**: Enabled.
+   * 
+   * - **off**: Disabled.
    * 
    * @example
    * on
    */
   enable?: string;
+  /**
+   * @remarks
+   * The region where IPv6 is enabled. The default value is `x.x`. Valid values:
+   * 
+   * - `x.x`: Global.
+   * 
+   * - `cn.cn`: Chinese mainland.
+   * 
+   * @example
+   * x.x
+   */
   region?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 156A6B-677B1A-4297B7-9187B7-2B44792

package/src/models/GetKeylessServerRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetKeylessServerRequest extends $dara.Model {
   /**
    * @remarks
-   * Keyless server ID。
+   * The keyless server ID.
    * 
    * This parameter is required.
    * 
@@ -15,6 +15,8 @@ export class GetKeylessServerRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
+   * The site ID. To obtain this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetKeylessServerResponseBody.ts

@@ -4,69 +4,105 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetKeylessServerResponseBody 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. Must be provided as a pair with the client private key.
+   * 
    * @example
    * -----BEGIN CERTIFICATE-----****
    */
   clientCertificate?: string;
   /**
+   * @remarks
+   * The client private key. Must be provided as a pair with the client certificate.
+   * 
    * @example
    * -----BEGIN RSA PRIVATE KEY-----****
    */
   clientPrivateKey?: string;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2024-03-11T01:23:21Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The hostname of the keyless server.
+   * 
    * @example
    * example.com
    */
   host?: string;
   /**
    * @remarks
-   * Keyless server ID。
+   * The keyless server ID.
    * 
    * @example
    * baba39055622c008b90285a8838e****
    */
   id?: string;
   /**
+   * @remarks
+   * The keyless server name.
+   * 
    * @example
    * example
    */
   name?: string;
   /**
+   * @remarks
+   * The port of the keyless server. Valid values: **1** to **65535**.
+   * 
    * @example
    * 443
    */
   port?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3558df77-8a7a-4060-a900-2d794940****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The site ID.
+   * 
    * @example
    * 123456****
    */
   siteId?: number;
   /**
+   * @remarks
+   * The site name.
+   * 
    * @example
    * example.com
    */
   siteName?: string;
   /**
+   * @remarks
+   * The update time.
+   * 
    * @example
    * 2025-03-13T02:13:28Z
    */
   updateTime?: string;
   /**
+   * @remarks
+   * Indicates whether to verify the server certificate of the keyless server. The default value is false.
+   * 
    * @example
    * true
    */

package/src/models/GetKvAccountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetKvAccountResponseBodyNamespaceList extends $dara.Model {
   /**
    * @remarks
-   * The available capacity of the namespace. Unit: bytes.
+   * The available capacity of the namespace, in bytes.
    * 
    * @example
    * 1073741824
@@ -21,7 +21,7 @@ export class GetKvAccountResponseBodyNamespaceList extends $dara.Model {
   capacityString?: string;
   /**
    * @remarks
-   * The used capacity of the namespace. Unit: bytes.
+   * The used capacity of the namespace, in bytes.
    * 
    * @example
    * 100048576
@@ -63,10 +63,13 @@ export class GetKvAccountResponseBodyNamespaceList extends $dara.Model {
    * @remarks
    * The status of the namespace. Valid values:
    * 
-   * *   **online**: normal.
-   * *   **delete**: pending deletion.
-   * *   **deleting**: being deleted.
-   * *   **deleted**: deleted.
+   * - **online**: Normal.
+   * 
+   * - **delete**: Pending deletion.
+   * 
+   * - **deleting**: Being deleted.
+   * 
+   * - **deleted**: Deleted.
    * 
    * @example
    * online
@@ -110,7 +113,7 @@ export class GetKvAccountResponseBodyNamespaceList extends $dara.Model {
 export class GetKvAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The available capacity of all namespaces in the account. Unit: bytes.
+   * The total available capacity of all namespaces for the account, in bytes.
    * 
    * @example
    * 1073741824
@@ -118,7 +121,7 @@ export class GetKvAccountResponseBody extends $dara.Model {
   capacity?: number;
   /**
    * @remarks
-   * The available capacity of all namespaces in the account.
+   * The total available capacity of all namespaces for the account.
    * 
    * @example
    * 1 GB
@@ -126,7 +129,7 @@ export class GetKvAccountResponseBody extends $dara.Model {
   capacityString?: string;
   /**
    * @remarks
-   * The used capacity of all namespaces in the account. Unit: bytes.
+   * The total used capacity of all namespaces for the account, in bytes.
    * 
    * @example
    * 10048576
@@ -134,7 +137,7 @@ export class GetKvAccountResponseBody extends $dara.Model {
   capacityUsed?: number;
   /**
    * @remarks
-   * The used capacity of all namespaces in the account.
+   * The total used capacity of all namespaces for the account.
    * 
    * @example
    * 100 MB
@@ -142,12 +145,12 @@ export class GetKvAccountResponseBody extends $dara.Model {
   capacityUsedString?: string;
   /**
    * @remarks
-   * The namespaces in the account.
+   * The list of namespaces for the account.
    */
   namespaceList?: GetKvAccountResponseBodyNamespaceList[];
   /**
    * @remarks
-   * The maximum number of namespaces that can be created in the account.
+   * The quota on the number of KV storage spaces that you can request for the account.
    * 
    * @example
    * 10
@@ -155,7 +158,7 @@ export class GetKvAccountResponseBody extends $dara.Model {
   namespaceQuota?: number;
   /**
    * @remarks
-   * The number of created namespaces that store key-value data in the account.
+   * The number of namespaces created for the account.
    * 
    * @example
    * 1
@@ -171,10 +174,11 @@ export class GetKvAccountResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether Edge KV is activated for the Alibaba Cloud account.
+   * The status of the account.
+   * 
+   * - **online**: The account is active.
    * 
-   * *   **online**
-   * *   **offline**
+   * - **offline**: The account is shut down.
    * 
    * @example
    * online

package/src/models/GetKvNamespaceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetKvNamespaceRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the namespace that you specify when you call the [CreateKvNamespace](https://help.aliyun.com/document_detail/2850317.html) operation.
+   * The name of the namespace. You specify this name when calling the [CreateKvNamespace](https://help.aliyun.com/document_detail/2850317.html) operation.
    * 
    * This parameter is required.
    *