@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListSiteRoutesResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * The bypass mode. Valid values:
+   * Whether bypass mode is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on: Enabled.
+   * 
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -24,22 +25,35 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type to query. Valid values:
+   * The configuration type. Valid values:
+   * 
+   * - global: Global configuration.
    * 
-   * *   global: global configurations.
-   * *   rule: queries rule configurations.
+   * - rule: Rule-based configuration.
    * 
    * @example
    * global
    */
   configType?: string;
+  /**
+   * @remarks
+   * Whether CDN fallback is enabled. Valid values:
+   * 
+   * - on: Enabled.
+   * 
+   * - off: Disabled.
+   * 
+   * @example
+   * on
+   */
   fallback?: string;
   /**
    * @remarks
-   * The configuration mode. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * The configuration mode. Valid values:
+   * 
+   * - simple: Simple mode.
    * 
-   * *   simple: Simple Mode
-   * *   custom: Custom Mode
+   * - custom: Custom mode.
    * 
    * @example
    * simple
@@ -47,10 +61,11 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * The route switch. Valid values:
+   * Whether the route is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on: Enabled.
+   * 
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -66,7 +81,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The function name.
+   * The routine name.
    * 
    * @example
    * test-routine1
@@ -82,7 +97,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The order in which the rule is executed.
+   * The rule execution sequence.
    * 
    * @example
    * 1
@@ -90,12 +105,19 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The version number of the website.
+   * The site version.
    * 
    * @example
    * 1
    */
   siteVersion?: number;
+  /**
+   * @remarks
+   * The ER timeout.
+   * 
+   * @example
+   * 60
+   */
   timeout?: string;
   static names(): { [key: string]: string } {
     return {
@@ -143,12 +165,12 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
 export class ListSiteRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned configurations.
+   * The list of returned configs.
    */
   configs?: ListSiteRoutesResponseBodyConfigs[];
   /**
    * @remarks
-   * The page number of the returned page.
+   * The current page number.
    * 
    * @example
    * 1
@@ -156,7 +178,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries to return on each page.
    * 
    * @example
    * 10
@@ -172,7 +194,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 16
@@ -180,7 +202,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 10

package/src/models/ListSitesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSitesRequestTagFilter extends $dara.Model {
   /**
    * @remarks
-   * The tag key. This parameter specifies a filter condition for the query.
+   * The tag key, used to filter query results.
    * 
    * @example
    * tag1
@@ -13,7 +13,7 @@ export class ListSitesRequestTagFilter extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value. This parameter specifies a filter condition for the query.
+   * The tag value, used to filter query results.
    * 
    * @example
    * aaa
@@ -45,10 +45,11 @@ export class ListSitesRequestTagFilter extends $dara.Model {
 export class ListSitesRequest extends $dara.Model {
   /**
    * @remarks
-   * The DNS setup. Valid values:
+   * The access type. Valid values:
    * 
-   * *   **NS**
-   * *   **CNAME**
+   * - **NS**: NS access.
+   * 
+   * - **CNAME**: CNAME access.
    * 
    * @example
    * NS
@@ -56,11 +57,13 @@ export class ListSitesRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The service location. Valid values:
+   * The acceleration region. Valid values:
+   * 
+   * - **domestic**: Chinese mainland only.
+   * 
+   * - **global**: Global.
    * 
-   * *   **domestic**: the Chinese mainland
-   * *   **global**: global
-   * *   **overseas**: outside the Chinese mainland
+   * - **overseas**: Global (excluding the Chinese mainland).
    * 
    * @example
    * global
@@ -68,7 +71,7 @@ export class ListSitesRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Specifies whether to query only websites on Enterprise plans. Valid values: **true and false**.
+   * Specifies whether to return only sites that use the Enterprise Edition.
    * 
    * @example
    * false
@@ -76,9 +79,11 @@ export class ListSitesRequest extends $dara.Model {
   onlyEnterprise?: boolean;
   /**
    * @remarks
-   * Sorting field. By default, it sorts by creation time, supporting the following options:
-   * - gmtCreate: website creation time
-   * - visitTime: website visit time
+   * The field to sort the results by. By default, results are sorted by creation time (gmtCreate). Supported values:
+   * 
+   * - `gmtCreate`: site creation time
+   * 
+   * - `visitTime`: site access time
    * 
    * @example
    * visitTime
@@ -86,7 +91,7 @@ export class ListSitesRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. The default value is **1**.
    * 
    * @example
    * 1
@@ -94,7 +99,7 @@ export class ListSitesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **500**.
+   * The number of entries to return on each page. The default value is **500**.
    * 
    * @example
    * 20
@@ -102,12 +107,15 @@ export class ListSitesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The plan type. Valid values:
+   * The subscription plan type. Valid values:
+   * 
+   * - **basicplan**: Basic Edition.
    * 
-   * *   **basicplan**: Entrance
-   * *   **standardplan**: Pro
-   * *   **advancedplan**: Premium
-   * *   **enterpriseplan**: Enterprise
+   * - **standardplan**: Standard Edition.
+   * 
+   * - **advancedplan**: Advanced Edition.
+   * 
+   * - **enterpriseplan**: Enterprise Edition.
    * 
    * @example
    * basicplan
@@ -115,7 +123,7 @@ export class ListSitesRequest extends $dara.Model {
   planSubscribeType?: string;
   /**
    * @remarks
-   * The ID of the resource group. This parameter specifies a filter condition for the query.
+   * The resource group ID, used to filter query results.
    * 
    * @example
    * rg-aekzd3styujvyei
@@ -123,7 +131,7 @@ export class ListSitesRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The website name. This parameter specifies a filter condition for the query.
+   * The site name, used to filter query results.
    * 
    * @example
    * example.com
@@ -131,12 +139,15 @@ export class ListSitesRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The match mode to search for the website name. Default value: exact. Valid values:
+   * The match mode for the `SiteName` parameter. The default value is `exact`. Valid values:
+   * 
+   * - **prefix**: prefix match.
+   * 
+   * - **suffix**: suffix match.
+   * 
+   * - **exact**: exact match.
    * 
-   * *   **prefix**: match by prefix.
-   * *   **suffix**: match by suffix.
-   * *   **exact**: exact match.
-   * *   **fuzzy**: fuzzy match.
+   * - **fuzzy**: fuzzy match.
    * 
    * @example
    * fuzzy
@@ -144,7 +155,7 @@ export class ListSitesRequest extends $dara.Model {
   siteSearchType?: string;
   /**
    * @remarks
-   * The website status. This parameter specifies a filter condition for the query.
+   * The site status, used to filter query results.
    * 
    * @example
    * pending
@@ -152,7 +163,7 @@ export class ListSitesRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tag filtering rule.
+   * A list of tags to use for filtering sites.
    */
   tagFilter?: ListSitesRequestTagFilter[];
   static names(): { [key: string]: string } {

package/src/models/ListSitesResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListSitesResponseBodySites extends $dara.Model {
   /**
    * @remarks
-   * The DNS setup for the website. Valid values:
+   * The access type. Valid values:
    * 
-   * *   **NS**
-   * *   **CNAME**
+   * - **NS**: The site connects via NS.
+   * 
+   * - **CNAME**: The site connects via a CNAME record.
    * 
    * @example
    * NS
@@ -16,7 +17,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.
+   * The CNAME suffix for the site. This suffix is required for CNAME record configuration.
    * 
    * @example
    * example.cname.com
@@ -24,11 +25,13 @@ export class ListSitesResponseBodySites extends $dara.Model {
   cnameZone?: string;
   /**
    * @remarks
-   * The service location for the website. Valid values:
+   * The acceleration region. Valid values:
+   * 
+   * - **domestic**: Chinese mainland only.
    * 
-   * *   **domestic**: the Chinese mainland
-   * *   **global**: global
-   * *   **overseas**: outside the Chinese mainland
+   * - **global**: Global.
+   * 
+   * - **overseas**: Global (excluding Chinese mainland).
    * 
    * @example
    * domestic
@@ -36,7 +39,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * The time when the website was added. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time (UTC) when the site was created, in `yyyy-MM-ddTHH:mm:ssZ` format.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -44,7 +47,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The ID of the plan associated with the website.
+   * The ID of the plan instance associated with the site.
    * 
    * @example
    * onBvtlmIyeXLbiDw81F9
@@ -52,16 +55,33 @@ export class ListSitesResponseBodySites extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The nameservers assigned to the website domain, which are separated by commas (,).
+   * The list of name servers (NS) assigned to the site. Multiple name servers are separated by commas.
    * 
    * @example
    * male1-1.ialicdn.com,female1-1.ialicdn.com
    */
   nameServerList?: string;
+  /**
+   * @remarks
+   * The reason the site was disabled. Valid values:
+   * 
+   * - **expiration_ arrears**: The plan has expired or payment is overdue.
+   * 
+   * - **internally_disabled**: Disabled by the system.
+   * 
+   * - **missing_icp**: The domain name is missing an ICP filing.
+   * 
+   * - **content_violation**: The site content violates regulations.
+   * 
+   * - **proactively_disabled**: The user disabled the site, or a usage cap was reached.
+   * 
+   * @example
+   * expiration_ arrears
+   */
   offlineReason?: string;
   /**
    * @remarks
-   * The plan name.
+   * The name of the plan.
    * 
    * @example
    * plan-168656498****
@@ -69,7 +89,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   planName?: string;
   /**
    * @remarks
-   * The plan associated with the website.
+   * The name of the plan specification.
    * 
    * @example
    * normal
@@ -85,7 +105,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The website ID.
+   * The ID of the site.
    * 
    * @example
    * 123456789****
@@ -93,7 +113,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The domain name.
    * 
    * @example
    * example.com
@@ -101,12 +121,15 @@ export class ListSitesResponseBodySites extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The website status. Valid values:
+   * The status. Valid values:
+   * 
+   * - **pending**: The site is awaiting configuration.
+   * 
+   * - **active**: The site is active.
+   * 
+   * - **offline**: The site is offline.
    * 
-   * *   **pending**: The website is to be configured.
-   * *   **active**: The website is active.
-   * *   **offline**: The website is suspended.
-   * *   **moved**: The website has been added and verified by another Alibaba Cloud account.
+   * - **moved**: The site has moved to another instance.
    * 
    * @example
    * pending
@@ -114,7 +137,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags of the website.
+   * The tags associated with the site.
    * 
    * @example
    * {"tag1":"value1"}
@@ -122,7 +145,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   tags?: { [key: string]: any };
   /**
    * @remarks
-   * The time when the website was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time (UTC) when the site was last updated, in `yyyy-MM-ddTHH:mm:ssZ` format.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -130,7 +153,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.
+   * The TXT verification code for site ownership. For sites that connect via CNAME, you must configure this code.
    * 
    * @example
    * verify_d516cb3740f81f0cef77d162edd1****
@@ -138,7 +161,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   verifyCode?: string;
   /**
    * @remarks
-   * The website visit time is represented in the ISO 8601 date format using UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ.
+   * The time (UTC) when the site was last accessed, in `yyyy-MM-ddTHH:mm:ssZ` format.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -211,7 +234,7 @@ export class ListSitesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of websites per page.
+   * The number of sites to return on each page.
    * 
    * @example
    * 20
@@ -227,12 +250,12 @@ export class ListSitesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried websites.
+   * A list of sites.
    */
   sites?: ListSitesResponseBodySites[];
   /**
    * @remarks
-   * The total number of websites.
+   * The total count of sites.
    * 
    * @example
    * 40

package/src/models/ListSitesShrinkRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListSitesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The DNS setup. Valid values:
+   * The access type. Valid values:
    * 
-   * *   **NS**
-   * *   **CNAME**
+   * - **NS**: NS access.
+   * 
+   * - **CNAME**: CNAME access.
    * 
    * @example
    * NS
@@ -16,11 +17,13 @@ export class ListSitesShrinkRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The service location. Valid values:
+   * The acceleration region. Valid values:
+   * 
+   * - **domestic**: Chinese mainland only.
+   * 
+   * - **global**: Global.
    * 
-   * *   **domestic**: the Chinese mainland
-   * *   **global**: global
-   * *   **overseas**: outside the Chinese mainland
+   * - **overseas**: Global (excluding the Chinese mainland).
    * 
    * @example
    * global
@@ -28,7 +31,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Specifies whether to query only websites on Enterprise plans. Valid values: **true and false**.
+   * Specifies whether to return only sites that use the Enterprise Edition.
    * 
    * @example
    * false
@@ -36,9 +39,11 @@ export class ListSitesShrinkRequest extends $dara.Model {
   onlyEnterprise?: boolean;
   /**
    * @remarks
-   * Sorting field. By default, it sorts by creation time, supporting the following options:
-   * - gmtCreate: website creation time
-   * - visitTime: website visit time
+   * The field to sort the results by. By default, results are sorted by creation time (gmtCreate). Supported values:
+   * 
+   * - `gmtCreate`: site creation time
+   * 
+   * - `visitTime`: site access time
    * 
    * @example
    * visitTime
@@ -46,7 +51,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The number of the page to return. The default value is **1**.
    * 
    * @example
    * 1
@@ -54,7 +59,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: **500**.
+   * The number of entries to return on each page. The default value is **500**.
    * 
    * @example
    * 20
@@ -62,12 +67,15 @@ export class ListSitesShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The plan type. Valid values:
+   * The subscription plan type. Valid values:
+   * 
+   * - **basicplan**: Basic Edition.
    * 
-   * *   **basicplan**: Entrance
-   * *   **standardplan**: Pro
-   * *   **advancedplan**: Premium
-   * *   **enterpriseplan**: Enterprise
+   * - **standardplan**: Standard Edition.
+   * 
+   * - **advancedplan**: Advanced Edition.
+   * 
+   * - **enterpriseplan**: Enterprise Edition.
    * 
    * @example
    * basicplan
@@ -75,7 +83,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   planSubscribeType?: string;
   /**
    * @remarks
-   * The ID of the resource group. This parameter specifies a filter condition for the query.
+   * The resource group ID, used to filter query results.
    * 
    * @example
    * rg-aekzd3styujvyei
@@ -83,7 +91,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The website name. This parameter specifies a filter condition for the query.
+   * The site name, used to filter query results.
    * 
    * @example
    * example.com
@@ -91,12 +99,15 @@ export class ListSitesShrinkRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The match mode to search for the website name. Default value: exact. Valid values:
+   * The match mode for the `SiteName` parameter. The default value is `exact`. Valid values:
+   * 
+   * - **prefix**: prefix match.
+   * 
+   * - **suffix**: suffix match.
+   * 
+   * - **exact**: exact match.
    * 
-   * *   **prefix**: match by prefix.
-   * *   **suffix**: match by suffix.
-   * *   **exact**: exact match.
-   * *   **fuzzy**: fuzzy match.
+   * - **fuzzy**: fuzzy match.
    * 
    * @example
    * fuzzy
@@ -104,7 +115,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   siteSearchType?: string;
   /**
    * @remarks
-   * The website status. This parameter specifies a filter condition for the query.
+   * The site status, used to filter query results.
    * 
    * @example
    * pending
@@ -112,7 +123,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tag filtering rule.
+   * A list of tags to use for filtering sites.
    */
   tagFilterShrink?: string;
   static names(): { [key: string]: string } {