@alicloud/esa20240910 2.32.1 → 2.34.0

package/src/models/ListRoutineRoutesResponseBody.ts

@@ -4,62 +4,120 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * Bypass mode. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   bypass?: string;
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The configuration type to query. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: queries rule configurations.
+   * 
    * @example
    * global
    */
   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:
+   * 
+   * *   on
+   * *   off
+   * 
+   * @example
+   * on
+   */
   fallback?: string;
   /**
+   * @remarks
+   * The configuration mode. Valid values:
+   * 
+   * *   simple: Simple mode.
+   * *   custom: Custom mode.
+   * 
    * @example
    * simple
    */
   mode?: string;
   /**
+   * @remarks
+   * The route switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   routeEnable?: string;
   /**
+   * @remarks
+   * The route name.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
+   * @remarks
+   * The routine name.
+   * 
    * @example
    * test-routine1
    */
   routineName?: string;
   /**
+   * @remarks
+   * The rule content.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
+   * @remarks
+   * The website ID.
+   * 
    * @example
    * 554889455535696
    */
   siteId?: number;
   /**
+   * @remarks
+   * The website name.
+   * 
    * @example
    * test.com
    */
   siteName?: string;
   /**
+   * @remarks
+   * The version number of the website configurations.
+   * 
    * @example
    * 1
    */
@@ -110,28 +168,47 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
 }
 
 export class ListRoutineRoutesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned configurations.
+   */
   configs?: ListRoutineRoutesResponseBodyConfigs[];
   /**
+   * @remarks
+   * The page number of the returned page.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 83
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 2
    */

package/src/models/ListSiteRoutesRequest.ts

@@ -4,32 +4,54 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSiteRoutesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   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
+   * 
    * @example
    * global
    */
   configType?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The rule name. This parameter takes effect only when parameter functionName is specified.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListSiteRoutesResponseBody.ts

@@ -4,52 +4,94 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * The bypass mode. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   bypass?: string;
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The configuration type to query. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: queries rule configurations.
+   * 
    * @example
    * global
    */
   configType?: string;
   fallback?: string;
   /**
+   * @remarks
+   * The configuration mode. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * 
+   * *   simple: Simple Mode
+   * *   custom: Custom Mode
+   * 
    * @example
    * simple
    */
   mode?: string;
   /**
+   * @remarks
+   * The route switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   routeEnable?: string;
   /**
+   * @remarks
+   * The route name.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
+   * @remarks
+   * The function name.
+   * 
    * @example
    * test-routine1
    */
   routineName?: string;
   /**
+   * @remarks
+   * The rule content.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
+   * @remarks
+   * The version number of the website.
+   * 
    * @example
    * 1
    */
@@ -96,28 +138,47 @@ export class ListSiteRoutesResponseBodyConfigs extends $dara.Model {
 }
 
 export class ListSiteRoutesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned configurations.
+   */
   configs?: ListSiteRoutesResponseBodyConfigs[];
   /**
+   * @remarks
+   * The page number of the returned page.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 16
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The total number of pages returned.
+   * 
    * @example
    * 10
    */

package/src/models/ListUrlObservationsRequest.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListUrlObservationsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID,
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The page number. Page starts from page 1. Default value: 1
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: **500**. Valid values: **1 to 500**.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListUrlObservationsResponseBody.ts

@@ -4,16 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListUrlObservationsResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * SDK integration. Valid values:
+   * 
+   * *   **automatic**
+   * *   **manual**
+   * 
    * @example
    * manual
    */
   sdkType?: string;
   /**
+   * @remarks
+   * The URL of the web page to monitor.
+   * 
    * @example
    * example.com/test
    */
@@ -44,13 +56,23 @@ export class ListUrlObservationsResponseBodyConfigs extends $dara.Model {
 }
 
 export class ListUrlObservationsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The configurations of the feature.
+   */
   configs?: ListUrlObservationsResponseBodyConfigs[];
   /**
+   * @remarks
+   * The number of the returned page.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 20
    */
@@ -64,11 +86,17 @@ export class ListUrlObservationsResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 1
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The total number of pages returned.
+   * 
    * @example
    * 1
    */

package/src/models/ListUserRoutinesRequest.ts

@@ -4,11 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListUserRoutinesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number of the returned page. Default value: 1. Valid values: 1 to 10.
+   * 
    * @example
    * ListUserRoutines
    */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 20.
+   * 
+   * @example
+   * 20
+   */
   pageSize?: number;
+  /**
+   * @remarks
+   * The keyword used for fuzzy search.
+   * 
+   * @example
+   * hello
+   */
   searchKeyWord?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListUserRoutinesResponseBody.ts

@@ -3,10 +3,45 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the function was created.
+   * 
+   * @example
+   * 2024-03-11T01:23:02.883361712Z
+   */
   createTime?: string;
+  /**
+   * @remarks
+   * The default record name to access.
+   * 
+   * @example
+   * serverless-test-2.154edaf6.er.aliyun-esa.net
+   */
   defaultRelatedRecord?: string;
+  /**
+   * @remarks
+   * The function description.
+   * 
+   * @example
+   * ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==
+   */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether to include the Assets file tag.
+   * 
+   * @example
+   * false
+   */
   hasAssets?: boolean;
+  /**
+   * @remarks
+   * The function name.
+   * 
+   * @example
+   * hello
+   */
   routineName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -38,16 +73,58 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
 }
 
 export class ListUserRoutinesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The page number. Pages start from page 1. Default value: 1.
+   * 
+   * @example
+   * 1
+   */
   pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 20
+   */
   pageSize?: number;
+  /**
+   * @remarks
+   * The maximum number of functions supported by the billing plan.
+   * 
+   * @example
+   * 20
+   */
   quotaRoutineNumber?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
+   * 
+   * @example
+   * 1234567890ABCDEF
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The functions.
+   */
   routines?: ListUserRoutinesResponseBodyRoutines[];
+  /**
+   * @remarks
+   * The total count.
+   * 
+   * @example
+   * 3
+   */
   totalCount?: number;
+  /**
+   * @remarks
+   * The number of functions that were already created.
+   * 
+   * @example
+   * 5
+   */
   usedRoutineNumber?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListVideoProcessingsRequest.ts

@@ -4,32 +4,54 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListVideoProcessingsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID, You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The configuration type. 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
+   * 
    * @example
    * global
    */
   configType?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The rule name. This parameter takes effect only when parameter functionName is specified.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +59,9 @@ export class ListVideoProcessingsRequest extends $dara.Model {
    */
   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.
+   * 
    * @example
    * 1
    */