@alicloud/esa20240910 2.32.1 → 2.34.0

package/src/models/ListHttpIncomingRequestHeaderModificationRulesResponseBody.ts

@@ -4,21 +4,40 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRequestHeaderModification extends $dara.Model {
   /**
+   * @remarks
+   * The name of the request header.
+   * 
    * @example
    * headerName
    */
   name?: string;
   /**
+   * @remarks
+   * The action. Valid values:
+   * 
+   * *   add: adds a response header.
+   * *   del: deletes a response header.
+   * *   modify: modifies a response header.
+   * 
    * @example
    * add
    */
   operation?: string;
   /**
+   * @remarks
+   * The type of the value. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the request header.
+   * 
    * @example
    * headerValue
    */
@@ -52,37 +71,71 @@ export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRe
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 429422870243328
    */
   configId?: number;
   /**
+   * @remarks
+   * The type of the configuration. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: rule configurations.
+   * 
    * @example
    * rule
    */
   configType?: string;
+  /**
+   * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   */
   requestHeaderModification?: ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRequestHeaderModification[];
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: 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
    * 0
    */
@@ -126,28 +179,47 @@ export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs e
 }
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration list of the incoming HTTP request header modification.
+   */
   configs?: ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs[];
   /**
+   * @remarks
+   * The number of the returned page. 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 request ID.
+   * 
    * @example
    * 7FB6EBC8-8849-5FC6-890E-3A761A5CD42D
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 10
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 1
    */

package/src/models/ListHttpIncomingResponseHeaderModificationRulesRequest.ts

@@ -4,32 +4,52 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListHttpIncomingResponseHeaderModificationRulesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * 
    * @example
    * 432915173664768
    */
   configId?: number;
   /**
+   * @remarks
+   * The configuration type to query. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: rule configurations.
+   * 
    * @example
    * rule
    */
   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.
+   * 
    * @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 +57,9 @@ export class ListHttpIncomingResponseHeaderModificationRulesRequest extends $dar
    */
   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
    * 0
    */

package/src/models/ListHttpIncomingResponseHeaderModificationRulesResponseBody.ts

@@ -4,21 +4,40 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigsResponseHeaderModification extends $dara.Model {
   /**
+   * @remarks
+   * The name of the response header.
+   * 
    * @example
    * headerName
    */
   name?: string;
   /**
+   * @remarks
+   * The action. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * 
+   * *   add: adds a response header.
+   * *   del: deletes a response header.
+   * *   modify: modifies a response header.
+   * 
    * @example
    * add
    */
   operation?: string;
   /**
+   * @remarks
+   * The type of the header. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the response header.
+   * 
    * @example
    * headerValue
    */
@@ -52,37 +71,71 @@ export class ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigsR
 
 export class ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 430559776208896
    */
   configId?: number;
   /**
+   * @remarks
+   * The type of the configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * 
+   * *   global: global configuration.
+   * *   rule: rule configuration.
+   * 
    * @example
    * rule
    */
   configType?: string;
+  /**
+   * @remarks
+   * The configurations of modifying response headers. You can add, delete, or modify a response header.
+   */
   responseHeaderModification?: ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigsResponseHeaderModification[];
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example:(http.host eq "video.example.com"): Match the specified request.
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: 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
    * 0
    */
@@ -126,28 +179,47 @@ export class ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigs
 }
 
 export class ListHttpIncomingResponseHeaderModificationRulesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of incoming response header modification rules.
+   */
   configs?: ListHttpIncomingResponseHeaderModificationRulesResponseBodyConfigs[];
   /**
+   * @remarks
+   * The number of the returned page. 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 request ID.
+   * 
    * @example
    * CF02C6F6-DB59-5438-8C05-3CE42DFCB0AD
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 10
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 1
    */

package/src/models/ListRoutineCodeVersionsRequest.ts

@@ -5,14 +5,37 @@ import * as $dara from '@darabonba/typescript';
 export class ListRoutineCodeVersionsRequest extends $dara.Model {
   /**
    * @remarks
+   * The function name.
+   * 
    * This parameter is required.
    * 
    * @example
    * ListRoutineCodeVersions
    */
   name?: string;
+  /**
+   * @remarks
+   * The page number of the returned page. Default value: 1. Valid values: 1 and 2.
+   * 
+   * @example
+   * 1
+   */
   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/ListRoutineCodeVersionsResponseBody.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListRoutineCodeVersionsResponseBodyCodeVersionsConfOptions extends $dara.Model {
+  /**
+   * @remarks
+   * Code version configuration items NotFoundStrategy.
+   * 
+   * @example
+   * SinglePageApplication
+   */
   notFoundStrategy?: string;
   static names(): { [key: string]: string } {
     return {
@@ -26,12 +33,58 @@ export class ListRoutineCodeVersionsResponseBodyCodeVersionsConfOptions extends
 }
 
 export class ListRoutineCodeVersionsResponseBodyCodeVersions extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the code version build.
+   * 
+   * @example
+   * 25801233
+   */
   buildId?: number;
+  /**
+   * @remarks
+   * The description of the code version.
+   * 
+   * @example
+   * test desc
+   */
   codeDescription?: string;
+  /**
+   * @remarks
+   * The version of the code.
+   * 
+   * @example
+   * 1723599747213377175
+   */
   codeVersion?: string;
+  /**
+   * @remarks
+   * Code version configuration items.
+   */
   confOptions?: ListRoutineCodeVersionsResponseBodyCodeVersionsConfOptions;
+  /**
+   * @remarks
+   * The time when the code version was created.
+   * 
+   * @example
+   * 2024-04-16T09:42:47Z
+   */
   createTime?: string;
+  /**
+   * @remarks
+   * Additional information about the code version.
+   * 
+   * @example
+   * {\\"approver\\":[\\"348678\\",\\"111133\\",\\"411544\\"]}
+   */
   extraInfo?: string;
+  /**
+   * @remarks
+   * The status of the code version.
+   * 
+   * @example
+   * Available
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -70,14 +123,42 @@ export class ListRoutineCodeVersionsResponseBodyCodeVersions extends $dara.Model
 }
 
 export class ListRoutineCodeVersionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The code versions of the routine.
+   */
   codeVersions?: ListRoutineCodeVersionsResponseBodyCodeVersions[];
+  /**
+   * @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
-   * Id of the request
+   * The request ID.
+   * 
+   * @example
+   * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The total number of code versions returned.
+   * 
+   * @example
+   * 5
+   */
   totalCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListRoutineRelatedRecordsRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListRoutineRelatedRecordsRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the function.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,16 +14,25 @@ export class ListRoutineRelatedRecordsRequest extends $dara.Model {
    */
   name?: string;
   /**
+   * @remarks
+   * The page number of the returned page. Default value: 1
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Valid values: an integer from 1 to 20.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The keyword used for fuzzy search.
+   * 
    * @example
    * hello
    */

package/src/models/ListRoutineRelatedRecordsResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListRoutineRelatedRecordsResponseBodyRelatedRecords extends $dara.Model {
   /**
+   * @remarks
+   * The record ID of the domain name.
+   * 
    * @example
    * 509348423011904
    */
   recordId?: number;
   /**
+   * @remarks
+   * The name of the record.
+   * 
    * @example
    * test-record-1.example.com
    */
   recordName?: string;
   /**
+   * @remarks
+   * The website ID.
+   * 
    * @example
    * 54362329990032
    */
   siteId?: number;
   /**
+   * @remarks
+   * The website name.
+   * 
    * @example
    * example.com
    */
@@ -52,22 +64,38 @@ export class ListRoutineRelatedRecordsResponseBodyRelatedRecords extends $dara.M
 
 export class ListRoutineRelatedRecordsResponseBody 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 list of records associated with the edge function.
+   */
   relatedRecords?: ListRoutineRelatedRecordsResponseBodyRelatedRecords[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 16
    */

package/src/models/ListRoutineRoutesRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListRoutineRoutesRequest extends $dara.Model {
   /**
+   * @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
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
+   * The function name.
+   * 
    * This parameter is required.
    * 
    * @example