@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListRoutineRoutesResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * Bypass mode. Valid values:
+   * The bypass mode. Valid values:
    * 
-   * *   on
-   * *   off
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -24,10 +25,11 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type to query. Valid values:
+   * The type of configuration. You can query global configurations or rule-based configurations based on this parameter. Valid values:
+   * 
+   * - `global`: A global configuration.
    * 
-   * *   global: global configurations.
-   * *   rule: queries rule configurations.
+   * - `rule`: A rule-based configuration.
    * 
    * @example
    * global
@@ -35,10 +37,11 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The exception origin switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:
+   * Indicates whether to enable fallback to origin. If this feature is enabled, the request is routed to the origin server when an exception occurs in the edge function, such as exceeding the CPU usage limit. Valid values:
    * 
-   * *   on
-   * *   off
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -48,8 +51,9 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
    * @remarks
    * The configuration mode. Valid values:
    * 
-   * *   simple: Simple mode.
-   * *   custom: Custom mode.
+   * - `simple`: Simple mode.
+   * 
+   * - `custom`: Custom mode.
    * 
    * @example
    * simple
@@ -57,10 +61,11 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * The route switch. Valid values:
+   * Indicates whether the route is enabled. Valid values:
    * 
-   * *   on
-   * *   off
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -76,7 +81,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The routine name.
+   * The edge function routine name.
    * 
    * @example
    * test-routine1
@@ -92,7 +97,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The order in which the rule is executed.
+   * The rule execution order.
    * 
    * @example
    * 1
@@ -100,7 +105,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * @example
    * 554889455535696
@@ -108,7 +113,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * test.com
@@ -116,13 +121,16 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The version number of the website configurations.
+   * The site configuration version.
    * 
    * @example
    * 1
    */
   siteVersion?: number;
   /**
+   * @remarks
+   * The timeout period. Unit: seconds.
+   * 
    * @example
    * 5
    */
@@ -177,7 +185,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
 export class ListRoutineRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned configurations.
+   * The list of configurations.
    */
   configs?: ListRoutineRoutesResponseBodyConfigs[];
   /**
@@ -190,7 +198,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned per page.
    * 
    * @example
    * 20
@@ -206,7 +214,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries that match the query criteria.
    * 
    * @example
    * 83
@@ -214,7 +222,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The total number of pages returned.
    * 
    * @example
    * 2

package/src/models/ListScheduledPreloadExecutionsRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListScheduledPreloadExecutionsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the scheduled prefetch task.
+   * The ID of the scheduled preload task.
    * 
    * This parameter is required.
    * 
    * @example
-   * ListScheduledPreloadExecutions
+   * 665d3af3621bccf3fe29e1a4
    */
   id?: string;
   static names(): { [key: string]: string } {

package/src/models/ListScheduledPreloadExecutionsResponseBody.ts

@@ -13,7 +13,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   aliUid?: string;
   /**
    * @remarks
-   * The end time of the prefetch plan.
+   * The end time of the execution plan.
    * 
    * @example
    * 2024-05-31T18:10:48.849+08:00
@@ -21,7 +21,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   endTime?: string;
   /**
    * @remarks
-   * The ID of the prefetch plan.
+   * The ID of the execution plan.
    * 
    * @example
    * 66599bd7397885b43804901c
@@ -29,7 +29,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   id?: string;
   /**
    * @remarks
-   * The time interval between each batch execution in the plan. Unit: seconds.
+   * The execution interval between batches, in seconds.
    * 
    * @example
    * 60
@@ -37,7 +37,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   interval?: number;
   /**
    * @remarks
-   * The ID of the prefetch task.
+   * The ID of the scheduled preload task.
    * 
    * @example
    * 665d3af3621bccf3fe29e1a4
@@ -45,7 +45,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   jobId?: string;
   /**
    * @remarks
-   * The number of URLs prefetched in each batch.
+   * The number of URLs to preload in each batch.
    * 
    * @example
    * 10
@@ -53,7 +53,7 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   sliceLen?: number;
   /**
    * @remarks
-   * The start time of the prefetch plan.
+   * The start time of the execution plan.
    * 
    * @example
    * 2024-05-31T17:10:48.849+08:00
@@ -61,13 +61,17 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
   startTime?: string;
   /**
    * @remarks
-   * The status of the prefetch plan. Valid values:
+   * The status of the execution plan. Valid values:
    * 
-   * *   **waiting**
-   * *   **running**
-   * *   **finished**
-   * *   **failed**
-   * *   **stopped**
+   * - **waiting**: Pending execution.
+   * 
+   * - **running**: Executing.
+   * 
+   * - **finished**: Completed.
+   * 
+   * - **failed**: Failed.
+   * 
+   * - **stopped**: Paused.
    * 
    * @example
    * running
@@ -111,12 +115,12 @@ export class ListScheduledPreloadExecutionsResponseBodyExecutions extends $dara.
 export class ListScheduledPreloadExecutionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about prefetch plans returned.
+   * A list of execution plans.
    */
   executions?: ListScheduledPreloadExecutionsResponseBodyExecutions[];
   /**
    * @remarks
-   * The request ID.
+   * The unique ID of the request.
    * 
    * @example
    * ET5BF670-09D5-4D0B-BEBY-D96A2A528000
@@ -124,7 +128,7 @@ export class ListScheduledPreloadExecutionsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of execution plans.
    * 
    * @example
    * 2

package/src/models/ListScheduledPreloadJobsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListScheduledPreloadJobsRequest extends $dara.Model {
   /**
    * @remarks
-   * The end time for querying the task creation time range. Specify the timestamp in milliseconds.
+   * End of the time range for querying job creation time, in milliseconds since the UNIX epoch.
    * 
    * @example
    * 1717225277000
@@ -13,7 +13,7 @@ export class ListScheduledPreloadJobsRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The page number.
+   * Page number to retrieve.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListScheduledPreloadJobsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * Number of entries per page.
    * 
    * @example
    * 20
@@ -29,17 +29,17 @@ export class ListScheduledPreloadJobsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID.
+   * Site ID
    * 
    * This parameter is required.
    * 
    * @example
-   * ListScheduledPreloadJobs
+   * 190007158391808
    */
   siteId?: number;
   /**
    * @remarks
-   * The beginning of the task creation time range to query. Specify the timestamp in milliseconds.
+   * Start of the time range for querying job creation time, in milliseconds since the UNIX epoch.
    * 
    * @example
    * 1717225276000

package/src/models/ListScheduledPreloadJobsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account.
+   * Alibaba Cloud account ID.
    * 
    * @example
    * 15685865xxx14622
@@ -13,7 +13,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   aliUid?: string;
   /**
    * @remarks
-   * The time when the task was created.
+   * Job creation time.
    * 
    * @example
    * 2024-06-01T08:53:13Z
@@ -21,7 +21,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The domain names to be prefetched.
+   * List of domains to prefetch.
    * 
    * @example
    * testurl.com
@@ -29,16 +29,23 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   domains?: string;
   /**
    * @remarks
-   * The error message that is returned.
+   * Error message.
    * 
    * @example
    * invalid domain:test.com
    */
   errorInfo?: string;
+  /**
+   * @remarks
+   * Number of prefetch schedules.
+   * 
+   * @example
+   * 1
+   */
   executionCount?: number;
   /**
    * @remarks
-   * The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.
+   * The OSS address of the failed file.
    * 
    * @example
    * https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7
@@ -46,7 +53,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   failedFileOss?: string;
   /**
    * @remarks
-   * The ID of the URL list file, which can be used during downloads.
+   * URL list file ID (used for downloading).
    * 
    * @example
    * 665d3b48621bccf3fe29e1a7
@@ -54,7 +61,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   fileId?: string;
   /**
    * @remarks
-   * The ID of the prefetch task.
+   * Job ID.
    * 
    * @example
    * 665d3af3621bccf3fe29e1a4
@@ -62,7 +69,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The method to submit the URLs to be prefetched.
+   * URL insertion method.
    * 
    * @example
    * oss
@@ -70,7 +77,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   insertWay?: string;
   /**
    * @remarks
-   * The task name.
+   * Job name.
    * 
    * @example
    * example
@@ -78,7 +85,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The website ID.
+   * Site ID
    * 
    * @example
    * 190007158391808
@@ -86,7 +93,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The number of submitted prefetch tasks.
+   * Number of URLs submitted to the system for prefetching.
    * 
    * @example
    * 1
@@ -94,7 +101,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   taskSubmitted?: number;
   /**
    * @remarks
-   * The task type. Valid values: refresh and preload.
+   * Task type (refresh or prefetch).
    * 
    * @example
    * preload
@@ -102,7 +109,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   taskType?: string;
   /**
    * @remarks
-   * The total number of URLs.
+   * Total number of URLs.
    * 
    * @example
    * 2
@@ -110,7 +117,7 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
   urlCount?: number;
   /**
    * @remarks
-   * The number of submitted URLs.
+   * Number of URLs submitted.
    * 
    * @example
    * 1
@@ -168,12 +175,12 @@ export class ListScheduledPreloadJobsResponseBodyJobs extends $dara.Model {
 export class ListScheduledPreloadJobsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of the prefetch tasks.
+   * List of prefetch job details.
    */
   jobs?: ListScheduledPreloadJobsResponseBodyJobs[];
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
@@ -181,7 +188,7 @@ export class ListScheduledPreloadJobsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of tasks returned.
+   * Total number of records after filtering.
    * 
    * @example
    * 5

package/src/models/ListSiteOriginClientCertificatesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSiteOriginClientCertificatesRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number.
+   * The page number. The default value is **1**.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListSiteOriginClientCertificatesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID.
    * 
    * This parameter is required.
    * 

package/src/models/ListSiteOriginClientCertificatesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -29,7 +29,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   fingerprintSha256?: string;
   /**
    * @remarks
-   * The certificate ID on ESA.
+   * The certificate ID.
    * 
    * @example
    * babaabcd****
@@ -37,7 +37,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The certification authority.
    * 
    * @example
    * DigiCert
@@ -53,7 +53,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   name?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The end time of the certificate validity period.
    * 
    * @example
    * 2024-03-31 02:08:00
@@ -61,7 +61,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The start time of the certificate validity period.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -69,7 +69,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   notBefore?: string;
   /**
    * @remarks
-   * The public key algorithm of the certificate.
+   * The public-key algorithm of the certificate.
    * 
    * @example
    * RSA
@@ -77,7 +77,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   pubkeyAlgorithm?: string;
   /**
    * @remarks
-   * The Subject Alternative Name (SAN) of the certificate.
+   * The subject alternative name (SAN) of the certificate.
    * 
    * @example
    * www.example.com,*.example.com
@@ -85,7 +85,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   SAN?: string;
   /**
    * @remarks
-   * The serial number of the certificate.
+   * The certificate serial number.
    * 
    * @example
    * babaded901474b9693acf530e0fb1d**
@@ -117,7 +117,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
   type?: string;
   /**
    * @remarks
-   * The time when the certificate was updated.
+   * The time when the certificate was last updated.
    * 
    * @example
    * 2022-09-22 05:33:13
@@ -175,7 +175,7 @@ export class ListSiteOriginClientCertificatesResponseBodyResult extends $dara.Mo
 export class ListSiteOriginClientCertificatesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number.
+   * The page number. The default value is 1.
    * 
    * @example
    * 1
@@ -199,12 +199,12 @@ export class ListSiteOriginClientCertificatesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Details of the certificates.
+   * The list of certificate information.
    */
   result?: ListSiteOriginClientCertificatesResponseBodyResult[];
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID.
    * 
    * @example
    * 123456789****
@@ -212,7 +212,7 @@ export class ListSiteOriginClientCertificatesResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -220,7 +220,7 @@ export class ListSiteOriginClientCertificatesResponseBody extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The total number of certificate.
+   * The total number of real-time log projects.
    * 
    * @example
    * 90

package/src/models/ListSiteRoutesRequest.ts

@@ -13,12 +13,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. You can use this parameter to query global configurations or feature configurations. This parameter takes effect only if the functionName parameter is passed.
-   * 
-   * Valid values:
-   * 
-   * *   global
-   * *   rule
+   * 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.
    * 
    * @example
    * global
@@ -26,7 +21,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. Default value: 1.
+   * The page number. The default is 1.
    * 
    * @example
    * 1
@@ -34,7 +29,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * The number of entries per page, with a maximum of 500. The default is 500.
    * 
    * @example
    * 20
@@ -42,7 +37,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The rule name. This parameter takes effect only when parameter functionName is specified.
+   * 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.
    * 
    * @example
    * test_route
@@ -50,7 +45,7 @@ export class ListSiteRoutesRequest extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    *