@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/ListSiteRoutesRequest.ts

@@ -13,7 +13,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Use this parameter to query global or feature-specific configurations. This parameter takes effect only if the `functionName` parameter is also specified.
+   * The configuration type. You can use this parameter to query global or feature configurations. This parameter takes effect only when functionName is specified.
    * 
    * @example
    * global
@@ -21,7 +21,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. The default is 1.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -29,7 +29,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page, with a maximum of 500. The default is 500.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -37,7 +37,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The route name. Use this parameter to find a route by its name. This parameter takes effect only if the `functionName` parameter is also specified.
+   * The route name. You can use this parameter to query the rule whose name matches the specified value. This parameter takes effect only when functionName is specified.
    * 
    * @example
    * test_route
@@ -45,7 +45,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/ListSiteRoutesResponseBody.ts

@@ -5,10 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * Whether bypass mode is enabled. Valid values:
-   * 
+   * The bypass mode. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -25,11 +23,10 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Valid values:
-   * 
-   * - global: Global configuration.
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
    * 
-   * - rule: Rule-based configuration.
+   * - global: Queries global configurations.
+   * - rule: Queries rule configurations.
    * 
    * @example
    * global
@@ -37,10 +34,8 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Whether CDN fallback is enabled. Valid values:
-   * 
+   * The CDN fallback. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -50,9 +45,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
    * The configuration mode. Valid values:
-   * 
    * - simple: Simple mode.
-   * 
    * - custom: Custom mode.
    * 
    * @example
@@ -61,10 +54,8 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * Whether the route is enabled. Valid values:
-   * 
+   * The route switch. Valid values:
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -81,7 +72,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The routine name.
+   * The Edge Routine name.
    * 
    * @example
    * test-routine1
@@ -97,7 +88,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The rule execution sequence.
+   * The execution order of the rule.
    * 
    * @example
    * 1
@@ -105,7 +96,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site version.
+   * The version number of the site.
    * 
    * @example
    * 1
@@ -113,7 +104,7 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The ER timeout.
+   * The Edge Routine timeout period, in seconds.
    * 
    * @example
    * 60
@@ -165,12 +156,12 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
 export class ListSiteRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of returned configs.
+   * The configuration list in the response.
    */
   configs?: ListSiteRoutesResponseBodyConfigs[];
   /**
    * @remarks
-   * The current page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -178,7 +169,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -194,7 +185,7 @@ export class ListSiteRoutesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of records.
    * 
    * @example
    * 16

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, used to filter query results.
+   * The tag key. Used as a filter condition for the query.
    * 
    * @example
    * tag1
@@ -13,7 +13,7 @@ export class ListSitesRequestTagFilter extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value, used to filter query results.
+   * The tag value. Used as a filter condition for the query.
    * 
    * @example
    * aaa
@@ -47,9 +47,9 @@ export class ListSitesRequest extends $dara.Model {
    * @remarks
    * The access type. Valid values:
    * 
-   * - **NS**: NS access.
+   * - **NS**: NS-based access.
    * 
-   * - **CNAME**: CNAME access.
+   * - **CNAME**: CNAME-based access.
    * 
    * @example
    * NS
@@ -58,12 +58,9 @@ export class ListSitesRequest extends $dara.Model {
   /**
    * @remarks
    * The acceleration region. Valid values:
-   * 
-   * - **domestic**: Chinese mainland only.
-   * 
-   * - **global**: Global.
-   * 
-   * - **overseas**: Global (excluding the Chinese mainland).
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
    * @example
    * global
@@ -71,7 +68,7 @@ export class ListSitesRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Specifies whether to return only sites that use the Enterprise Edition.
+   * Specifies whether to query only Enterprise Edition sites. Set this parameter to **true** to query only Enterprise Edition sites.
    * 
    * @example
    * false
@@ -79,11 +76,9 @@ export class ListSitesRequest extends $dara.Model {
   onlyEnterprise?: boolean;
   /**
    * @remarks
-   * 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
+   * The sort field. By default, results are sorted by creation time. Valid values:
+   * - gmtCreate: site creation time.
+   * - visitTime: site access time.
    * 
    * @example
    * visitTime
@@ -91,7 +86,7 @@ export class ListSitesRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The number of the page to return. The default value is **1**.
+   * The page number for paging. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -99,7 +94,7 @@ export class ListSitesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The default value is **500**.
+   * The number of entries per page for paging. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -107,14 +102,10 @@ export class ListSitesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The subscription plan type. Valid values:
-   * 
+   * The plan subscription type. Valid values:
    * - **basicplan**: Basic Edition.
-   * 
    * - **standardplan**: Standard Edition.
-   * 
-   * - **advancedplan**: Advanced Edition.
-   * 
+   * - **advancedplan**: Premium Edition.
    * - **enterpriseplan**: Enterprise Edition.
    * 
    * @example
@@ -123,7 +114,7 @@ export class ListSitesRequest extends $dara.Model {
   planSubscribeType?: string;
   /**
    * @remarks
-   * The resource group ID, used to filter query results.
+   * The resource group ID. Used as a filter condition for the query.
    * 
    * @example
    * rg-aekzd3styujvyei
@@ -131,7 +122,7 @@ export class ListSitesRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The site name, used to filter query results.
+   * The site name. Used as a filter condition for the query.
    * 
    * @example
    * example.com
@@ -139,14 +130,11 @@ export class ListSitesRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The match mode for the `SiteName` parameter. The default value is `exact`. Valid values:
+   * The search matching mode for the site name. Default is exact match. Valid values:
    * 
    * - **prefix**: prefix match.
-   * 
    * - **suffix**: suffix match.
-   * 
    * - **exact**: exact match.
-   * 
    * - **fuzzy**: fuzzy match.
    * 
    * @example
@@ -155,7 +143,7 @@ export class ListSitesRequest extends $dara.Model {
   siteSearchType?: string;
   /**
    * @remarks
-   * The site status, used to filter query results.
+   * The site status. Used as a filter condition for the query.
    * 
    * @example
    * pending
@@ -163,7 +151,7 @@ export class ListSitesRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * A list of tags to use for filtering sites.
+   * The tag filter rules.
    */
   tagFilter?: ListSitesRequestTagFilter[];
   static names(): { [key: string]: string } {

package/src/models/ListSitesResponseBody.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ListSitesResponseBodySites extends $dara.Model {
   /**
    * @remarks
-   * The access type. Valid values:
+   * The site access type. Valid values:
    * 
-   * - **NS**: The site connects via NS.
-   * 
-   * - **CNAME**: The site connects via a CNAME record.
+   * - **NS**: NS-based access.
+   * - **CNAME**: CNAME-based access.
    * 
    * @example
    * NS
@@ -17,7 +16,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The CNAME suffix for the site. This suffix is required for CNAME record configuration.
+   * The CNAME suffix of the site. For sites that use CNAME-based access, this is the CNAME suffix that needs to be configured for records.
    * 
    * @example
    * example.cname.com
@@ -25,13 +24,11 @@ export class ListSitesResponseBodySites extends $dara.Model {
   cnameZone?: string;
   /**
    * @remarks
-   * The acceleration region. Valid values:
-   * 
-   * - **domestic**: Chinese mainland only.
-   * 
-   * - **global**: Global.
+   * The acceleration region of the site. Valid values:
    * 
-   * - **overseas**: Global (excluding Chinese mainland).
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
    * @example
    * domestic
@@ -39,7 +36,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * The time (UTC) when the site was created, in `yyyy-MM-ddTHH:mm:ssZ` format.
+   * The creation time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -47,7 +44,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The ID of the plan instance associated with the site.
+   * The instance ID of the plan attached to the site.
    * 
    * @example
    * onBvtlmIyeXLbiDw81F9
@@ -55,7 +52,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The list of name servers (NS) assigned to the site. Multiple name servers are separated by commas.
+   * The list of name servers assigned to the site. Multiple values are separated by commas (,).
    * 
    * @example
    * male1-1.ialicdn.com,female1-1.ialicdn.com
@@ -63,17 +60,13 @@ export class ListSitesResponseBodySites extends $dara.Model {
   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.
+   * The reason why the site is disabled. Valid values:
    * 
-   * - **content_violation**: The site content violates regulations.
-   * 
-   * - **proactively_disabled**: The user disabled the site, or a usage cap was reached.
+   * - **expiration_ arrears**: The subscription plan has expired or the account has an overdue payment.
+   * - **internally_disabled**: The site is 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 site or the site is disabled because the usage cap you configured is reached.
    * 
    * @example
    * expiration_ arrears
@@ -81,7 +74,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   offlineReason?: string;
   /**
    * @remarks
-   * The name of the plan.
+   * The plan name.
    * 
    * @example
    * plan-168656498****
@@ -89,7 +82,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   planName?: string;
   /**
    * @remarks
-   * The name of the plan specification.
+   * The specification name of the site plan.
    * 
    * @example
    * normal
@@ -97,7 +90,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   planSpecName?: string;
   /**
    * @remarks
-   * The ID of the resource group.
+   * The resource group ID.
    * 
    * @example
    * rg-aek26g6i6se6pna
@@ -105,7 +98,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * @example
    * 123456789****
@@ -113,7 +106,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The domain name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -121,15 +114,11 @@ export class ListSitesResponseBodySites extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The status. Valid values:
-   * 
-   * - **pending**: The site is awaiting configuration.
-   * 
-   * - **active**: The site is active.
-   * 
-   * - **offline**: The site is offline.
-   * 
-   * - **moved**: The site has moved to another instance.
+   * The site status. Valid values:
+   * - **pending**: the site is pending configuration.
+   * - **active**: the site is activated.
+   * - **offline**: the site is offline.
+   * - **moved**: the site has been superseded.
    * 
    * @example
    * pending
@@ -137,7 +126,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags associated with the site.
+   * The site tags.
    * 
    * @example
    * {"tag1":"value1"}
@@ -145,7 +134,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   tags?: { [key: string]: any };
   /**
    * @remarks
-   * The time (UTC) when the site was last updated, in `yyyy-MM-ddTHH:mm:ssZ` format.
+   * The update time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -153,7 +142,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The TXT verification code for site ownership. For sites that connect via CNAME, you must configure this code.
+   * The site ownership verification code. When a site uses CNAME-based access, this TXT verification code must be configured.
    * 
    * @example
    * verify_d516cb3740f81f0cef77d162edd1****
@@ -161,7 +150,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
   verifyCode?: string;
   /**
    * @remarks
-   * The time (UTC) when the site was last accessed, in `yyyy-MM-ddTHH:mm:ssZ` format.
+   * The access time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -226,7 +215,7 @@ export class ListSitesResponseBodySites extends $dara.Model {
 export class ListSitesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number.
+   * The page number of the returned data.
    * 
    * @example
    * 1
@@ -234,7 +223,7 @@ export class ListSitesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of sites to return on each page.
+   * The number of sites displayed per page.
    * 
    * @example
    * 20
@@ -250,12 +239,12 @@ export class ListSitesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * A list of sites.
+   * The list of queried site information.
    */
   sites?: ListSitesResponseBodySites[];
   /**
    * @remarks
-   * The total count of sites.
+   * The total number of sites.
    * 
    * @example
    * 40

package/src/models/ListSitesShrinkRequest.ts

@@ -7,9 +7,9 @@ export class ListSitesShrinkRequest extends $dara.Model {
    * @remarks
    * The access type. Valid values:
    * 
-   * - **NS**: NS access.
+   * - **NS**: NS-based access.
    * 
-   * - **CNAME**: CNAME access.
+   * - **CNAME**: CNAME-based access.
    * 
    * @example
    * NS
@@ -18,12 +18,9 @@ export class ListSitesShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The acceleration region. Valid values:
-   * 
-   * - **domestic**: Chinese mainland only.
-   * 
-   * - **global**: Global.
-   * 
-   * - **overseas**: Global (excluding the Chinese mainland).
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
    * @example
    * global
@@ -31,7 +28,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Specifies whether to return only sites that use the Enterprise Edition.
+   * Specifies whether to query only Enterprise Edition sites. Set this parameter to **true** to query only Enterprise Edition sites.
    * 
    * @example
    * false
@@ -39,11 +36,9 @@ export class ListSitesShrinkRequest extends $dara.Model {
   onlyEnterprise?: boolean;
   /**
    * @remarks
-   * 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
+   * The sort field. By default, results are sorted by creation time. Valid values:
+   * - gmtCreate: site creation time.
+   * - visitTime: site access time.
    * 
    * @example
    * visitTime
@@ -51,7 +46,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The number of the page to return. The default value is **1**.
+   * The page number for paging. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -59,7 +54,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The default value is **500**.
+   * The number of entries per page for paging. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -67,14 +62,10 @@ export class ListSitesShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The subscription plan type. Valid values:
-   * 
+   * The plan subscription type. Valid values:
    * - **basicplan**: Basic Edition.
-   * 
    * - **standardplan**: Standard Edition.
-   * 
-   * - **advancedplan**: Advanced Edition.
-   * 
+   * - **advancedplan**: Premium Edition.
    * - **enterpriseplan**: Enterprise Edition.
    * 
    * @example
@@ -83,7 +74,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   planSubscribeType?: string;
   /**
    * @remarks
-   * The resource group ID, used to filter query results.
+   * The resource group ID. Used as a filter condition for the query.
    * 
    * @example
    * rg-aekzd3styujvyei
@@ -91,7 +82,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The site name, used to filter query results.
+   * The site name. Used as a filter condition for the query.
    * 
    * @example
    * example.com
@@ -99,14 +90,11 @@ export class ListSitesShrinkRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The match mode for the `SiteName` parameter. The default value is `exact`. Valid values:
+   * The search matching mode for the site name. Default is exact match. Valid values:
    * 
    * - **prefix**: prefix match.
-   * 
    * - **suffix**: suffix match.
-   * 
    * - **exact**: exact match.
-   * 
    * - **fuzzy**: fuzzy match.
    * 
    * @example
@@ -115,7 +103,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   siteSearchType?: string;
   /**
    * @remarks
-   * The site status, used to filter query results.
+   * The site status. Used as a filter condition for the query.
    * 
    * @example
    * pending
@@ -123,7 +111,7 @@ export class ListSitesShrinkRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * A list of tags to use for filtering sites.
+   * The tag filter rules.
    */
   tagFilterShrink?: string;
   static names(): { [key: string]: string } {