@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/CreateCompressionRuleRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCompressionRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Brotli compression. Value range:
+   * Specifies whether to enable Brotli compression. Valid values:
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `on`: Enables Brotli compression.
+   * 
+   * - `off`: Disables Brotli compression.
    * 
    * @example
    * on
@@ -16,10 +17,11 @@ export class CreateCompressionRuleRequest extends $dara.Model {
   brotli?: string;
   /**
    * @remarks
-   * Gzip compression. Value range:
+   * Specifies whether to enable Gzip compression. Valid values:
+   * 
+   * - `on`: Enables Gzip compression.
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `off`: Disables Gzip compression.
    * 
    * @example
    * on
@@ -27,9 +29,11 @@ export class CreateCompressionRuleRequest extends $dara.Model {
   gzip?: 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:
-   * - To match all incoming requests: Set the value to true
-   * - To 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 when adding a global configuration. There are two use cases:
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, set the value to a custom expression, for example, `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -37,9 +41,11 @@ export class CreateCompressionRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the rule. This parameter is not required when adding a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -47,16 +53,23 @@ export class CreateCompressionRuleRequest 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 required when adding a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The unique identifier of the site. To obtain this value, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 
@@ -66,7 +79,7 @@ export class CreateCompressionRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.
+   * The version of the site\\"s configuration. If versioning is enabled for the site, this parameter specifies the version to modify. Defaults to 0.
    * 
    * @example
    * 0
@@ -74,10 +87,11 @@ export class CreateCompressionRuleRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * Zstd compression. Value range:
+   * Specifies whether to enable Zstd compression. Valid values:
+   * 
+   * - `on`: Enables Zstd compression.
    * 
-   * - on: Enable.
-   * - off: Disable.
+   * - `off`: Disables Zstd compression.
    * 
    * @example
    * on

package/src/models/CreateCompressionRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCompressionRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The unique ID of the configuration.
    * 
    * @example
    * 35281609698****
@@ -13,7 +13,7 @@ export class CreateCompressionRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Request ID.
+   * The unique ID of the request.
    * 
    * @example
    * C370DAF1-C838-4288-A1A0-9A87633D248E

package/src/models/CreateCustomHostnameRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomHostnameRequest extends $dara.Model {
   /**
    * @remarks
-   * 云盾证书ID，使用云盾证书时必填
+   * The ID of the CAS certificate. This parameter is required if `CertType` is set to `cas`.
    * 
    * @example
    * 30000478
@@ -13,7 +13,11 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   casId?: number;
   /**
    * @remarks
-   * 云盾证书所在地域，使用云盾证书时必填
+   * The region of the CAS certificate. This parameter is required if `CertType` is set to `cas`.
+   * 
+   * - For accounts on the China site, set this parameter to `cn-hangzhou`.
+   * 
+   * - For accounts on the International site, set this parameter to `ap-southeast-1`.
    * 
    * @example
    * cn-hangzhou
@@ -21,7 +25,13 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   casRegion?: string;
   /**
    * @remarks
-   * 证书类型，SSL 开启时必填
+   * The certificate type. This parameter is required if `SslFlag` is set to `on`. Valid values:
+   * 
+   * - **free**: A free certificate.
+   * 
+   * - **upload**: A user-uploaded certificate.
+   * 
+   * - **cas**: A CAS certificate.
    * 
    * @example
    * free
@@ -29,7 +39,7 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   certType?: string;
   /**
    * @remarks
-   * 证书公钥，使用上传证书时必填
+   * The content of the certificate. This parameter is required if `CertType` is set to `upload`.
    * 
    * @example
    * -----BEGIN CERTIFICATE-----
@@ -37,7 +47,7 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   certificate?: string;
   /**
    * @remarks
-   * 自定义主机名
+   * The custom hostname.
    * 
    * This parameter is required.
    * 
@@ -47,7 +57,7 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   hostname?: string;
   /**
    * @remarks
-   * 证书私钥，使用上传证书时必填
+   * The private key of the certificate. This parameter is required if `CertType` is set to `upload`.
    * 
    * @example
    * -----BEGIN PRIVATE KEY-----
@@ -55,7 +65,7 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   privateKey?: string;
   /**
    * @remarks
-   * 绑定的源站记录ID
+   * The ID of the record to bind. Call the [ListRecords](https://help.aliyun.com/document_detail/2850265.html) operation to get this ID.
    * 
    * This parameter is required.
    * 
@@ -65,7 +75,7 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   recordId?: number;
   /**
    * @remarks
-   * 关联站点ID
+   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to get this ID.
    * 
    * This parameter is required.
    * 
@@ -75,7 +85,11 @@ export class CreateCustomHostnameRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * SSL开关
+   * Specifies whether to enable SSL. Valid values:
+   * 
+   * - **on**: Enable SSL.
+   * 
+   * - **off**: Disable SSL.
    * 
    * This parameter is required.
    * 

package/src/models/CreateCustomHostnameResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCustomHostnameResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The custom hostname.
+   * 
    * @example
    * custom.site.com
    */
   hostname?: string;
   /**
+   * @remarks
+   * The ID of the custom hostname.
+   * 
    * @example
    * 1234567890123
    */
   hostnameId?: number;
   /**
+   * @remarks
+   * The unique identifier for the request.
+   * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */

package/src/models/CreateCustomResponseCodeRuleRequest.ts

@@ -25,10 +25,11 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   returnCode?: string;
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * Rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request.
+   * - Match all incoming requests: Set the value to true.
+   * 
+   * - 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")
@@ -36,10 +37,11 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * Rule switch. Do not set this parameter when adding a global configuration. Valid values:
+   * 
+   * - on: Enable.
    * 
-   * *   on
-   * *   off
+   * - off: Disable.
    * 
    * @example
    * on
@@ -47,7 +49,7 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * Rule name. Do not set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -55,7 +57,7 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * Rule execution order. A smaller value indicates higher priority.
    * 
    * @example
    * 1
@@ -63,7 +65,7 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * Site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API to get it.
    * 
    * This parameter is required.
    * 
@@ -73,7 +75,7 @@ export class CreateCustomResponseCodeRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * Site configuration version number. For sites with version management enabled, use this parameter to specify the site version where the configuration takes effect. The default is version 0.
    * 
    * @example
    * 0

package/src/models/CreateCustomResponseCodeRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomResponseCodeRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID.
+   * Configuration ID.
    * 
    * @example
    * 3528160969****
@@ -13,7 +13,7 @@ export class CreateCustomResponseCodeRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * C2B2F8CF-3074-5BBC-891A-AAD292E2624F

package/src/models/CreateCustomScenePolicyRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomScenePolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The time when the policy expires.
+   * The policy end time.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
    * 
    * This parameter is required.
    * 
@@ -27,18 +27,27 @@ export class CreateCustomScenePolicyRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,).
+   * The IDs of the sites to associate with the policy. Separate multiple site IDs with commas.
+   * 
+   * > This parameter is deprecated. Use `SiteIds` instead. If `SiteIds` is specified, the value of this parameter is ignored. To prevent ambiguity, specify a value for either `SiteIds` or `Objects`.
    * 
    * @example
-   * 7096621098****
+   * 7096621098****,7096621099****
    */
   objects?: string;
+  /**
+   * @remarks
+   * The IDs of the sites to associate with the policy. Separate multiple site IDs with commas.
+   * 
+   * @example
+   * 7096621098****,7096621099****
+   */
   siteIds?: string;
   /**
    * @remarks
-   * The time when the policy takes effect.
+   * The policy start time.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
    * 
    * This parameter is required.
    * 
@@ -48,9 +57,9 @@ export class CreateCustomScenePolicyRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The name of the policy template. Valid value:
+   * The template name. Valid value:
    * 
-   * *   **promotion**: major events.
+   * - **promotion**: a policy for major events.
    * 
    * This parameter is required.
    * 

package/src/models/CreateCustomScenePolicyResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomScenePolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The time when the policy expires.
+   * The policy end time.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
    * 
    * @example
    * 2021-11-07T18:00:00Z
@@ -23,7 +23,9 @@ export class CreateCustomScenePolicyResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The IDs of websites associated.
+   * A list of associated site IDs.
+   * 
+   * > This field is deprecated. Read the value from the `SiteIds` field instead.
    */
   objects?: string[];
   /**
@@ -42,12 +44,19 @@ export class CreateCustomScenePolicyResponseBody extends $dara.Model {
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The associated site IDs, separated by commas.
+   * 
+   * @example
+   * 7096621098****, 7096621099****
+   */
   siteIds?: string;
   /**
    * @remarks
-   * The time when the policy takes effect.
+   * The policy start time.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
    * 
    * @example
    * 2021-11-07T17:00:00Z
@@ -55,7 +64,7 @@ export class CreateCustomScenePolicyResponseBody extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The name of the policy template.
+   * The template name.
    * 
    * @example
    * promotion

package/src/models/CreateEdgeContainerAppVersionRequest.ts

@@ -320,15 +320,20 @@ export class CreateEdgeContainerAppVersionRequestContainers extends $dara.Model
    * The content of the container health probe.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * For details, see the definition of readiness probes in Kubernetes.
    */
   probeContent?: CreateEdgeContainerAppVersionRequestContainersProbeContent;
   /**
    * @remarks
    * The type of the probe. Valid values:
    * 
-   * *   exec: the command type.
-   * *   tcpSocket: the TCP probe type.
-   * *   httpGet: the HTTP access type.
+   * - exec: the command type.
+   * 
+   * - tcpSocket: the TCP probe type.
+   * 
+   * - httpGet: the HTTP access type.
    * 
    * This parameter is required.
    * 
@@ -420,8 +425,7 @@ export class CreateEdgeContainerAppVersionRequest extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * The container group to be deployed for this version, which contains information about images.\\
-   * The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.
+   * The container group to be deployed for this version, which contains information about images.<br> The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.
    * 
    * This parameter is required.
    * 

package/src/models/CreateEdgeContainerAppVersionShrinkRequest.ts

@@ -15,8 +15,7 @@ export class CreateEdgeContainerAppVersionShrinkRequest extends $dara.Model {
   appId?: string;
   /**
    * @remarks
-   * The container group to be deployed for this version, which contains information about images.\\
-   * The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.
+   * The container group to be deployed for this version, which contains information about images.<br> The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.
    * 
    * This parameter is required.
    * 

package/src/models/CreateHttpIncomingRequestHeaderModificationRuleRequest.ts

@@ -15,11 +15,13 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   name?: string;
   /**
    * @remarks
-   * The action. Valid values:
+   * The Operation to perform. Valid values:
    * 
-   * *   add: adds a response header.
-   * *   del: deletes a response header.
-   * *   modify: modifies a response header.
+   * - `add`: Adds a header.
+   * 
+   * - `del`: Deletes a header.
+   * 
+   * - `modify`: Modifies a header.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   operation?: string;
   /**
    * @remarks
-   * The type of the value. Valid values:
+   * The type of the header value. Valid values:
+   * 
+   * - `static`: Static mode.
    * 
-   * *   static
-   * *   dynamic
+   * - `dynamic`: Dynamic mode.
    * 
    * @example
    * static
@@ -40,7 +43,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   type?: string;
   /**
    * @remarks
-   * The value of the request header.
+   * The value to set for the request header. This parameter is not required if the `Operation` is `del`.
    * 
    * @example
    * headvalue
@@ -76,17 +79,18 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
 export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * An array of objects, where each object defines a modification to a request header.
    * 
    * This parameter is required.
    */
   requestHeaderModification?: CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification[];
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * The conditional expression that the Rule uses to match incoming requests. This parameter is not required for a Global configuration. There are two use cases:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, use a custom expression. For example: `(http.host eq "video.example.com")`
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -94,10 +98,11 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * Specifies whether the Rule is enabled. This parameter is not required for a Global configuration. Valid values:
+   * 
+   * - `on`: The Rule is enabled.
    * 
-   * *   on
-   * *   off
+   * - `off`: The Rule is disabled.
    * 
    * @example
    * on
@@ -105,7 +110,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * The name of the Rule. This parameter is not required for a Global configuration.
    * 
    * @example
    * rule_example
@@ -113,7 +118,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The execution order of the Rule. A lower value indicates a higher priority.
    * 
    * @example
    * 1
@@ -121,7 +126,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   sequence?: number;
   /**
    * @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. You can obtain this value by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -131,7 +136,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The Version of the Site configuration. For Sites with configuration versioning enabled, this parameter specifies the Version to which the Rule applies. The default value is 0.
    * 
    * @example
    * 0