@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/ListCustomHostnamesRequest.ts

@@ -25,7 +25,7 @@ export class ListCustomHostnamesRequest extends $dara.Model {
   nameMatchType?: string;
   /**
    * @remarks
-   * The page number, starting from 1. Default value: 1.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -33,10 +33,10 @@ export class ListCustomHostnamesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: 100. Maximum value: 500.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
-   * 100
+   * 500
    */
   pageSize?: number;
   /**

package/src/models/ListCustomHostnamesResponseBody.ts

@@ -13,7 +13,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certApplyCode?: number;
   /**
    * @remarks
-   * The error description for the free certificate application.
+   * The error message for the free certificate application.
    * 
    * @example
    * canceled
@@ -46,11 +46,11 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   /**
    * @remarks
    * The certificate status. Valid values:
-   * - **OK**: Normal.
-   * - **Applying**: Being applied.
-   * - **ApplyFailed**: Application failed.
-   * - **Expiring**: About to expire.
-   * - **Expired**: Expired.
+   * - **OK**: normal.
+   * - **Applying**: being applied.
+   * - **ApplyFailed**: application failed.
+   * - **Expiring**: about to expire.
+   * - **Expired**: expired.
    * 
    * @example
    * OK
@@ -58,7 +58,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certStatus?: string;
   /**
    * @remarks
-   * The TXT name for certificate verification.
+   * The TXT record name for certificate verification.
    * 
    * @example
    * _acme-challenge.custom.site.com
@@ -66,7 +66,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certTxtKey?: string;
   /**
    * @remarks
-   * The TXT content for certificate verification.
+   * The TXT record content for certificate verification.
    * 
    * @example
    * lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM
@@ -86,10 +86,11 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   /**
    * @remarks
    * The reason why the SaaS domain name is occupied. Valid values:
-   * - **existing_custom_hostname**: Conflicts with an existing SaaS domain name.
-   * - **existing_record**: Conflicts with an existing site record.
-   * - **existing_load_balancer**: Conflicts with an existing load balancing instance.
-   * - **existing_origin_pool**: Conflicts with an existing origin IPAM pool.
+   * - **existing_custom_hostname**: conflicts with an existing SaaS domain name.
+   * - **existing_site**: conflicts with an existing site.
+   * - **existing_record**: conflicts with an existing site record.
+   * - **existing_load_balancer**: conflicts with an existing load balancing instance.
+   * - **existing_origin_pool**: conflicts with an existing origin IPAM pool.
    * 
    * @example
    * existing_custom_hostname
@@ -97,7 +98,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   conflictWith?: string;
   /**
    * @remarks
-   * The time when the SaaS domain name was created, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
+   * The creation time of the SaaS domain name, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2026-04-19T11:15:20Z
@@ -122,11 +123,11 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   /**
    * @remarks
    * The reason why the SaaS domain name was taken offline. Valid values:
-   * - **expiration_ arrears**: The subscription plan has expired or the account has an overdue payment.
-   * - **internally_disabled**: Disabled by the system.
-   * - **missing_icp**: The domain name does not have an ICP filing.
-   * - **content_violation**: Content violation.
-   * - **proactively_disabled**: You proactively disabled the domain name or the usage cap you configured was reached.
+   * - **expiration_arrears**: the subscription plan expired or the account has an overdue payment.
+   * - **internally_disabled**: disabled by the system.
+   * - **missing_icp**: the domain name does not have an ICP filing.
+   * - **content_violation**: content violation.
+   * - **proactively_disabled**: proactively disabled by you or disabled because the usage cap you configured was reached.
    * 
    * @example
    * missing_icp
@@ -189,7 +190,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the SaaS domain name was last updated, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
+   * The update time of the SaaS domain name, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2026-04-19T11:15:20Z
@@ -197,7 +198,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The TXT content for domain name verification.
+   * The TXT record content for domain name verification.
    * 
    * @example
    * verify_16ab7f4d389d4dff6655f995c6a997bd
@@ -205,7 +206,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   verifyCode?: string;
   /**
    * @remarks
-   * The TXT name for domain name verification.
+   * The TXT record name for domain name verification.
    * 
    * @example
    * _esa_custom_hostname.custom.site.com
@@ -279,12 +280,12 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
 export class ListCustomHostnamesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of SaaS domain names.
+   * The list of SaaS domain names returned.
    */
   hostnames?: ListCustomHostnamesResponseBodyHostnames[];
   /**
    * @remarks
-   * The page number.
+   * The current page number. This value is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -300,7 +301,7 @@ export class ListCustomHostnamesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The request ID, which is a unique identifier generated by Alibaba Cloud for this request.
+   * The request ID, which is a unique identifier generated by Alibaba Cloud for the request.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/ListCustomResponseCodeRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID.
+   * Configuration ID.
    * 
    * @example
    * 436490043994112
@@ -13,11 +13,10 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Use this parameter to query global or rule configurations. Valid values:
+   * Configuration type. You can use this parameter to query global or rule configurations. Valid values:
    * 
-   * - global: Queries global configurations.
-   * 
-   * - rule: Queries rule configurations.
+   * - global: queries global configurations.
+   * - rule: queries rule configurations.
    * 
    * @example
    * global
@@ -25,7 +24,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. The default value is 1 if you do not specify this parameter.
+   * Page number. Default value: 1.
    * 
    * @example
    * 1
@@ -33,7 +32,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. The maximum value is 500. The default value is 500 if you do not specify this parameter.
+   * Number of entries per page. Maximum value: 500. Default value: 500.
    * 
    * @example
    * 20
@@ -41,7 +40,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The rule name.
+   * Rule name.
    * 
    * @example
    * rule_example
@@ -49,7 +48,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The site ID. For more information, see [ListSites](https://help.aliyun.com/document_detail/2850189.html).
+   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 
@@ -59,7 +58,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with configuration version control enabled, specify the site version for which the configuration takes effect using this parameter. The default value is version 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0

package/src/models/ListCustomResponseCodeRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID.
+   * Configuration ID.
    * 
    * @example
    * 395386449776640
@@ -14,10 +14,8 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   /**
    * @remarks
    * The configuration type. Valid values:
-   * 
-   * - global: Global configuration.
-   * 
-   * - rule: Rule configuration.
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * global
@@ -41,11 +39,9 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   returnCode?: string;
   /**
    * @remarks
-   * The rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:
-   * 
-   * - 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").
+   * The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two usage scenarios are supported:
+   * - 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\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -53,11 +49,9 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   rule?: string;
   /**
    * @remarks
-   * The rule switch. Do not set this parameter when adding a global configuration. Valid values:
-   * 
-   * - on: Enabled.
-   * 
-   * - off: Disabled.
+   * The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:
+   * - on: enables the rule.
+   * - off: disables the rule.
    * 
    * @example
    * on
@@ -65,7 +59,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. Do not set this parameter when adding a global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -73,7 +67,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   ruleName?: string;
   /**
    * @remarks
-   * The rule execution order. A smaller value indicates higher priority.
+   * The execution order of the rule. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -81,7 +75,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   sequence?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with configuration version control enabled, this parameter specifies the site version for which the configuration takes effect. The default value is version 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0
@@ -127,12 +121,12 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
 export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * You can modify the response code configuration list.
+   * The list of custom response code configurations.
    */
   configs?: ListCustomResponseCodeRulesResponseBodyConfigs[];
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * Page number. Default value: **1**.
    * 
    * @example
    * 1
@@ -140,7 +134,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size. Default value: 500. Valid values: 1 to 500.
+   * Page size. Default value: 500. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -148,7 +142,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
@@ -156,7 +150,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * Total number of entries.
    * 
    * @example
    * 10
@@ -164,7 +158,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages.
+   * Total number of pages.
    * 
    * @example
    * 1

package/src/models/ListEdgeContainerAppImageSecretsRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListEdgeContainerAppImageSecretsRequest extends $dara.Model {
   /**
    * @remarks
-   * Application ID, which can be obtained using the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) interface.
+   * The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.
+   * >Notice: The AppId format is the prefix app- followed by a numeric suffix, with a total length of 20 to 64 characters (example: app-8806886***83794688). Call ListEdgeContainerApps to obtain an existing AppId, or call CreateEdgeContainerApp to create an application first.</notice>.
    * 
    * This parameter is required.
    * 

package/src/models/ListEdgeContainerAppImageSecretsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListEdgeContainerAppImageSecretsResponseBodyImageSecretList extends $dara.Model {
   /**
    * @remarks
-   * Name of the image secret.
+   * The name of the image secret.
    * 
    * @example
    * reg-123****
@@ -13,7 +13,7 @@ export class ListEdgeContainerAppImageSecretsResponseBodyImageSecretList extends
   name?: string;
   /**
    * @remarks
-   * Registry address.
+   * The image repository address.
    * 
    * @example
    * registry-vpc.cn-hangzhou.aliyuncs.com
@@ -21,7 +21,7 @@ export class ListEdgeContainerAppImageSecretsResponseBodyImageSecretList extends
   registry?: string;
   /**
    * @remarks
-   * Username for the image repository
+   * The username of the image repository.
    * 
    * @example
    * admin
@@ -55,12 +55,12 @@ export class ListEdgeContainerAppImageSecretsResponseBodyImageSecretList extends
 export class ListEdgeContainerAppImageSecretsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * List of image secrets.
+   * The list of image secrets.
    */
   imageSecretList?: ListEdgeContainerAppImageSecretsResponseBodyImageSecretList[];
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 3558df77-8a7a-4060-a900-2d7949403836

package/src/models/ListEdgeRoutineRecordsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListEdgeRoutineRecordsRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number for a paged query. The value must be greater than or equal to 1. Default value: **1**.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListEdgeRoutineRecordsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **500**.
+   * The number of records per page for a paged query. Valid values: 1 to 500. Default value: **500**.
    * 
    * @example
    * 20
@@ -21,15 +21,11 @@ export class ListEdgeRoutineRecordsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The match mode to filter the record names.
-   * 
+   * The matching mode used to filter by record name. Valid values:
    * - **fuzzy**: fuzzy match.
-   * 
-   * - **prefix**: match by prefix.
-   * 
-   * - **suffix**: match by suffix.
-   * 
-   * - **exact** (default): exact match .
+   * - **prefix**: prefix match.
+   * - **suffix**: suffix match.
+   * - **exact**: exact match (default).
    * 
    * @example
    * fuzzy
@@ -37,7 +33,7 @@ export class ListEdgeRoutineRecordsRequest extends $dara.Model {
   recordMatchType?: string;
   /**
    * @remarks
-   * The record name.
+   * Filters by the specified record name.
    * 
    * @example
    * a.example.com
@@ -45,7 +41,7 @@ export class ListEdgeRoutineRecordsRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The website ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the ID.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/ListEdgeRoutineRecordsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
   /**
    * @remarks
-   * The time when the record was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The creation time of the record. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -13,7 +13,7 @@ export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The CNAME. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.
+   * The CNAME of the record. When the site uses CNAME access, this is the CNAME value that needs to be configured for the record.
    * 
    * @example
    * a.example.com.cnamezone.com
@@ -29,7 +29,7 @@ export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * @example
    * 5407498413****
@@ -37,7 +37,7 @@ export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The name of the site to which the record belongs.
    * 
    * @example
    * example.com
@@ -45,7 +45,7 @@ export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The time when the record was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The update time of the record. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-22T08:32:02Z
@@ -85,7 +85,7 @@ export class ListEdgeRoutineRecordsResponseBodyRecords extends $dara.Model {
 export class ListEdgeRoutineRecordsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The total number of pages returned.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -93,7 +93,7 @@ export class ListEdgeRoutineRecordsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of records displayed per page.
    * 
    * @example
    * 10
@@ -114,7 +114,7 @@ export class ListEdgeRoutineRecordsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of records returned.
+   * The total number of records.
    * 
    * @example
    * 121

package/src/models/ListHttpIncomingRequestHeaderModificationRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to obtain the configuration ID.
    * 
    * @example
    * 424371770570752
@@ -13,10 +13,10 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
   configId?: number;
   /**
    * @remarks
-   * The configuration type to query. Valid values:
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
    * 
-   * *   global: global configurations.
-   * *   rule: rule configurations.
+   * - global: queries global configurations.
+   * - rule: queries rule configurations.
    * 
    * @example
    * rule
@@ -24,7 +24,7 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
   configType?: string;
   /**
    * @remarks
-   * The page number. Default value: 1.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -32,7 +32,7 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -48,7 +48,7 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
   ruleName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -58,7 +58,7 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
   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 number of the site configuration. 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.
    * 
    * @example
    * 0