@alicloud/esa20240910 3.1.2 → 3.3.0

package/src/models/OpenEdgeContainerRequest.ts

@@ -0,0 +1,27 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class OpenEdgeContainerRequest extends $dara.Model {
+  securityToken?: string;
+  static names(): { [key: string]: string } {
+    return {
+      securityToken: 'SecurityToken',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      securityToken: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/OpenEdgeContainerResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { OpenEdgeContainerResponseBody } from "./OpenEdgeContainerResponseBody";
+
+
+export class OpenEdgeContainerResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: OpenEdgeContainerResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: OpenEdgeContainerResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/OpenEdgeContainerResponseBody.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class OpenEdgeContainerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 54B1C88C-9BB7-568F-9D02-DFBE6F44624D
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/PreloadCachesRequest.ts

@@ -5,17 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class PreloadCachesRequest extends $dara.Model {
   /**
    * @remarks
-   * The files to be prefetched.
+   * The prefetch objects.
    */
   content?: string[];
   /**
    * @remarks
-   * By default, prefetch requests include the Accept-Encoding:gzip header. If you want a prefetch request to include other headers or implement multi-replica prefetch, you can specify a custom prefetch header by configuring the Headers parameter.
+   * The default header carried in a prefetch request is Accept-Encoding:gzip. If you want the prefetch request to carry other headers or implement multi-copy prefetching, use this parameter to specify custom prefetch headers.
    */
   headers?: { [key: string]: 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, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * @example
    * 123456789****

package/src/models/PreloadCachesResponseBody.ts

@@ -13,7 +13,7 @@ export class PreloadCachesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The prefetch task ID.
+   * The task ID. A task ID is returned when you create a prefetch task.
    * 
    * @example
    * 16401427840

package/src/models/PreloadCachesShrinkRequest.ts

@@ -5,17 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class PreloadCachesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The files to be prefetched.
+   * The prefetch objects.
    */
   contentShrink?: string;
   /**
    * @remarks
-   * By default, prefetch requests include the Accept-Encoding:gzip header. If you want a prefetch request to include other headers or implement multi-replica prefetch, you can specify a custom prefetch header by configuring the Headers parameter.
+   * The default header carried in a prefetch request is Accept-Encoding:gzip. If you want the prefetch request to carry other headers or implement multi-copy prefetching, use this parameter to specify custom prefetch headers.
    */
   headersShrink?: 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, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * @example
    * 123456789****

package/src/models/PublishEdgeContainerAppVersionRequest.ts

@@ -33,8 +33,9 @@ export class PublishEdgeContainerAppVersionRequest extends $dara.Model {
    * @remarks
    * The environment to which you want to release the version. Valid values:
    * 
-   * *   prod: the production environment.
-   * *   staging: the staging environment.
+   * - prod: the production environment.
+   * 
+   * - staging: the staging environment.
    * 
    * This parameter is required.
    * 
@@ -46,8 +47,9 @@ export class PublishEdgeContainerAppVersionRequest extends $dara.Model {
    * @remarks
    * Specifies how the version is released. Valid values:
    * 
-   * *   percentage: releases the version by percentage.
-   * *   region: releases the version by region.
+   * - percentage: releases the version by percentage.
+   * 
+   * - region: releases the version by region.
    * 
    * If you do not specify this parameter, the version is released by percentage by default.
    * 

package/src/models/PublishEdgeContainerAppVersionShrinkRequest.ts

@@ -33,8 +33,9 @@ export class PublishEdgeContainerAppVersionShrinkRequest extends $dara.Model {
    * @remarks
    * The environment to which you want to release the version. Valid values:
    * 
-   * *   prod: the production environment.
-   * *   staging: the staging environment.
+   * - prod: the production environment.
+   * 
+   * - staging: the staging environment.
    * 
    * This parameter is required.
    * 
@@ -46,8 +47,9 @@ export class PublishEdgeContainerAppVersionShrinkRequest extends $dara.Model {
    * @remarks
    * Specifies how the version is released. Valid values:
    * 
-   * *   percentage: releases the version by percentage.
-   * *   region: releases the version by region.
+   * - percentage: releases the version by percentage.
+   * 
+   * - region: releases the version by region.
    * 
    * If you do not specify this parameter, the version is released by percentage by default.
    * 

package/src/models/PublishRoutineCodeVersionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PublishRoutineCodeVersionRequest extends $dara.Model {
   /**
    * @remarks
-   * The code version to be released.
+   * The version number of the code to publish.
    * 
    * @example
    * 1710120201067203242
@@ -23,12 +23,12 @@ export class PublishRoutineCodeVersionRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * The routine name.
+   * The name of the Edge Routine.
    * 
    * This parameter is required.
    * 
    * @example
-   * PublishRoutineCodeVersion
+   * test-routine1
    */
   name?: string;
   static names(): { [key: string]: string } {

package/src/models/PublishRoutineCodeVersionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PublishRoutineCodeVersionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The code version.
+   * The code version number.
    * 
    * @example
    * 1710120201067203242

package/src/models/PurchaseRatePlanRequest.ts

@@ -3,10 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PurchaseRatePlanRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The number of plans to purchase.
+   * 
+   * @example
+   * 1
+   */
   amount?: number;
   /**
    * @remarks
-   * Specifies whether to enable auto payment.
+   * Specifies whether to enable automatic payment.
+   * Set this parameter to true when you directly call this operation.
    * 
    * @example
    * true
@@ -14,21 +22,28 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   autoPay?: boolean;
   /**
    * @remarks
-   * Auto-renewal:
-   * - true: Enable auto-renewal.
-   * - false: Disable auto-renewal.
+   * Specifies whether to enable auto-renewal. Valid values:
+   * - true: Auto-renewal is enabled.
+   * - false: Auto-renewal is disabled.
    * 
    * @example
    * true
    */
   autoRenew?: boolean;
+  /**
+   * @remarks
+   * The channel field.
+   * 
+   * @example
+   * xxxWodkxxx
+   */
   channel?: string;
   /**
    * @remarks
    * The billing method. Valid values:
-   * 
-   * *   PREPAY: subscription.
-   * *   POSTPAY: pay-as-you-go.
+   * - PREPAY: subscription.
+   * - POSTPAY: pay-as-you-go.
+   * Set this parameter to PREPAY when you directly call this operation.
    * 
    * @example
    * PREPAY
@@ -36,11 +51,10 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * The service location. Valid values:
-   * 
-   * *   domestic: the Chinese mainland.
-   * *   global: global.
-   * *   overseas: outside the Chinese mainland.
+   * The acceleration region. Valid values:
+   * - domestic: the Chinese mainland only.
+   * - global: global.
+   * - overseas: global (excluding the Chinese mainland).
    * 
    * @example
    * domestic
@@ -48,7 +62,8 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Subscription period (in months).
+   * The purchase period, in months.
+   * This parameter is required when you directly call this operation.
    * 
    * @example
    * 1
@@ -56,15 +71,43 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   period?: number;
   /**
    * @remarks
-   * Package code.
+   * The plan code.
+   * 
+   * China site
+   * 
+   * - Free Edition: entranceplan
+   * - Basic: basicplan
+   * - Standard: standardplan
+   * - Premium: advancedplan
+   * 
+   * International site
+   * 
+   * - Entrance: entranceplan
+   * - Pro: standardplan
+   * - Premium: advancedpla.
    * 
    * @example
-   * entranceplan
+   * basicplan
    */
   planCode?: string;
   /**
    * @remarks
-   * Package name.
+   * The plan name.
+   * 
+   * China site
+   * 
+   * - Free Edition: entranceplan
+   * - Basic: basic
+   * - Standard: medium
+   * - Premium: high
+   * 
+   * International site
+   * 
+   * - Entrance: entranceplan_intl
+   * - Pro: basicplan_intl
+   * - Premium: vipplan_intl
+   * 
+   * > Note: For Enterprise Edition plans, the plan name is provided after backend configuration.
    * 
    * @example
    * basic
@@ -72,7 +115,7 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   planName?: string;
   /**
    * @remarks
-   * Site name.
+   * The site name.
    * 
    * @example
    * test.com
@@ -80,10 +123,9 @@ export class PurchaseRatePlanRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The DNS setup option for the website. Valid values:
-   * 
-   * *   NS
-   * *   CNAME
+   * The site access type. Valid values:
+   * - NS: NS access.
+   * - CNAME: CNAME access.
    * 
    * @example
    * CNAME

package/src/models/PurchaseRatePlanResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PurchaseRatePlanResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * esa-site-ads11w
@@ -13,7 +13,7 @@ export class PurchaseRatePlanResponseBody extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Order ID.
+   * The order ID.
    * 
    * @example
    * 123123
@@ -21,7 +21,7 @@ export class PurchaseRatePlanResponseBody extends $dara.Model {
   orderId?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 30423A7F-A83D-1E24-B80E-86DD25790758

package/src/models/PurgeCachesRequest.ts

@@ -5,23 +5,28 @@ import * as $dara from '@darabonba/typescript';
 export class PurgeCachesRequestContentCacheKeys extends $dara.Model {
   /**
    * @remarks
-   * When refreshing, specify the header information corresponding to the cache key. When the custom cache key feature switch is enabled, the cache key will be generated based on the specified header for refreshing.
+   * The header information corresponding to the cache key specified during the refresh. When the custom cache key feature is enabled, the cache key is generated based on the specified headers for the refresh.
+   * 
+   * **UserGeo: country/region**
    * 
-   * **UserGeo: Country/Region**
    * - Country/region codes follow the ISO 3166-2 standard.
    * 
-   * **UserDeviceType: Device Type, currently there are three enum values**
+   * **UserDeviceType: device type. Valid values:**
+   * 
    * - desktop
-   *  - tablet
-   *  - mobile
    * 
-   * **UserLanguage: Language**
-   * - Language codes follow the ISO 639-1 or BCP47 standards. For example, input \\"zh\\" to refresh content in Chinese.
+   * - tablet
+   * 
+   * - mobile
+   * 
+   * **UserLanguage: language**
+   * 
+   * - Language codes follow the ISO 639-1 or BCP 47 standard. For example, set this to zh to refresh content in Chinese.
    */
   headers?: { [key: string]: string };
   /**
    * @remarks
-   * URL address to be refreshed.
+   * The URL to refresh.
    * 
    * @example
    * http://a.com/1.jpg?b=1
@@ -56,37 +61,37 @@ export class PurgeCachesRequestContentCacheKeys extends $dara.Model {
 export class PurgeCachesRequestContent extends $dara.Model {
   /**
    * @remarks
-   * List of cachekeys to be refreshed, required when the type is cachekey.
+   * The list of cache keys to refresh. This parameter is required when Type is set to cachekey.
    */
   cacheKeys?: PurgeCachesRequestContentCacheKeys[];
   /**
    * @remarks
-   * List of cachetags to be refreshed, required when the type is cachetag.
+   * The list of cache tags to refresh. This parameter is required when Type is set to cachetag.
    */
   cacheTags?: string[];
   /**
    * @remarks
-   * List of directories to be refreshed, required when the type is directory.
+   * The list of directories to refresh. This parameter is required when Type is set to directory.
    */
   directories?: string[];
   /**
    * @remarks
-   * List of files to be refreshed, required when the type is file.
+   * The list of files to refresh. This parameter is required when Type is set to file.
    */
   files?: any[];
   /**
    * @remarks
-   * List of hostnames to be refreshed, required when the type is hostname.
+   * The list of hostnames to refresh. This parameter is required when Type is set to hostname.
    */
   hostnames?: string[];
   /**
    * @remarks
-   * List of files with ignored parameters, required when the type is ignoreParams.
+   * The list of files with parameters ignored. This parameter is required when Type is set to ignoreParams.
    */
   ignoreParams?: string[];
   /**
    * @remarks
-   * Flag for purging all content. Default is false, set to true when the type is purgeall.
+   * Specifies whether to refresh the entire site. Default value: false. Set this parameter to true when Type is set to purgeall.
    * 
    * @example
    * true
@@ -146,12 +151,12 @@ export class PurgeCachesRequestContent extends $dara.Model {
 export class PurgeCachesRequest extends $dara.Model {
   /**
    * @remarks
-   * Content to be refreshed.
+   * The refresh content.
    */
   content?: PurgeCachesRequestContent;
   /**
    * @remarks
-   * Used for refreshing cached resources in edge computing, such as allowing the refresh of content cached using the CacheAPI interface of an edge function.
+   * Specifies whether to refresh edge computing cached resources. For example, this allows you to refresh content cached by the Edge Routine CacheAPI API operation using the edge function.
    * 
    * @example
    * true
@@ -159,12 +164,12 @@ export class PurgeCachesRequest extends $dara.Model {
   edgeComputePurge?: boolean;
   /**
    * @remarks
-   * Indicates whether to refresh all resources under the directory when the content from the origin and the source resource are inconsistent. The default is false.
-   * - **true**: Refreshes all resources under the specified directory.
-   * - **false**: Refreshes only the changed resources under the specified directory.
+   * Specifies whether to refresh all resources under the corresponding directory when the back-to-origin content is inconsistent with the origin server resources. Default value: false.
+   * - **true**: Refreshes all resources under the corresponding directory.
+   * - **false**: Refreshes only the changed resources under the corresponding directory.
    * 
    * > 
-   * >  Applies to: Directory refresh, cachetag refresh, ignoreParams refresh, hostname refresh, and purge all cache of the site.
+   * >  This parameter takes effect for directory refresh, cache tag refresh, parameter-ignored refresh, hostname refresh, and full site refresh.
    * 
    * @example
    * true
@@ -172,7 +177,7 @@ export class PurgeCachesRequest extends $dara.Model {
   force?: boolean;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -182,14 +187,14 @@ export class PurgeCachesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The type of refresh task. Possible values:
-   * - **file** (default): File refresh.
-   * - **cachekey**: Cachekey refresh.
-   * - **cachetag**: Cachetag refresh.
-   * - **directory**: Directory refresh.
-   * - **ignoreParams**: Ignore parameters refresh. Ignoring parameters means removing the ? and everything after it in the request URL. When performing an ignore parameters refresh, the user first submits the URL without parameters through the interface. The submitted URLs to be refreshed will then be matched against the cached resource URLs with the parameters removed. If the cached resource URL, after removing the parameters, matches the URL to be refreshed, the CDN node will refresh the cached resources.
-   * - **hostname**: Hostname refresh.
-   * - **purgeall**: Purge all cache under the site.
+   * The type of the refresh node. Valid values:
+   * - **file** (default): file refresh.
+   * - **cachekey**: cache key refresh.
+   * - **cachetag**: cache label refresh.
+   * - **directory**: folder refresh.
+   * - **ignoreParams**: parameter-ignored refresh. This refers to removing the question mark (?) and all parameters after it from the request URL. When you commit a parameter-stripped URL through this API operation, the committed URL is matched against cached resource URLs after their parameters are also stripped. If a cached resource URL matches the committed URL after parameter stripping, the point of presence executes the refresh on the cached resource.
+   * - **hostname**: hostname refresh.
+   * - **purgeall**: refreshes all cached content under the site.
    * 
    * This parameter is required.
    * 

package/src/models/PurgeCachesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class PurgeCachesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * ET5BF670-09D5-4D0B-BEBY-D96A2A528000
@@ -13,7 +13,7 @@ export class PurgeCachesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Task ID, which is returned when you create a refresh or preheat task.
+   * The task ID. This ID is returned when you create a refresh or prefetch task.
    * 
    * @example
    * 15940956620

package/src/models/PurgeCachesShrinkRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class PurgeCachesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Content to be refreshed.
+   * The refresh content.
    */
   contentShrink?: string;
   /**
    * @remarks
-   * Used for refreshing cached resources in edge computing, such as allowing the refresh of content cached using the CacheAPI interface of an edge function.
+   * Specifies whether to refresh edge computing cached resources. For example, this allows you to refresh content cached by the Edge Routine CacheAPI API operation using the edge function.
    * 
    * @example
    * true
@@ -18,12 +18,12 @@ export class PurgeCachesShrinkRequest extends $dara.Model {
   edgeComputePurge?: boolean;
   /**
    * @remarks
-   * Indicates whether to refresh all resources under the directory when the content from the origin and the source resource are inconsistent. The default is false.
-   * - **true**: Refreshes all resources under the specified directory.
-   * - **false**: Refreshes only the changed resources under the specified directory.
+   * Specifies whether to refresh all resources under the corresponding directory when the back-to-origin content is inconsistent with the origin server resources. Default value: false.
+   * - **true**: Refreshes all resources under the corresponding directory.
+   * - **false**: Refreshes only the changed resources under the corresponding directory.
    * 
    * > 
-   * >  Applies to: Directory refresh, cachetag refresh, ignoreParams refresh, hostname refresh, and purge all cache of the site.
+   * >  This parameter takes effect for directory refresh, cache tag refresh, parameter-ignored refresh, hostname refresh, and full site refresh.
    * 
    * @example
    * true
@@ -31,7 +31,7 @@ export class PurgeCachesShrinkRequest extends $dara.Model {
   force?: boolean;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -41,14 +41,14 @@ export class PurgeCachesShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The type of refresh task. Possible values:
-   * - **file** (default): File refresh.
-   * - **cachekey**: Cachekey refresh.
-   * - **cachetag**: Cachetag refresh.
-   * - **directory**: Directory refresh.
-   * - **ignoreParams**: Ignore parameters refresh. Ignoring parameters means removing the ? and everything after it in the request URL. When performing an ignore parameters refresh, the user first submits the URL without parameters through the interface. The submitted URLs to be refreshed will then be matched against the cached resource URLs with the parameters removed. If the cached resource URL, after removing the parameters, matches the URL to be refreshed, the CDN node will refresh the cached resources.
-   * - **hostname**: Hostname refresh.
-   * - **purgeall**: Purge all cache under the site.
+   * The type of the refresh node. Valid values:
+   * - **file** (default): file refresh.
+   * - **cachekey**: cache key refresh.
+   * - **cachetag**: cache label refresh.
+   * - **directory**: folder refresh.
+   * - **ignoreParams**: parameter-ignored refresh. This refers to removing the question mark (?) and all parameters after it from the request URL. When you commit a parameter-stripped URL through this API operation, the committed URL is matched against cached resource URLs after their parameters are also stripped. If a cached resource URL matches the committed URL after parameter stripping, the point of presence executes the refresh on the cached resource.
+   * - **hostname**: hostname refresh.
+   * - **purgeall**: refreshes all cached content under the site.
    * 
    * This parameter is required.
    *