@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/ListOriginRulesRequest.ts

@@ -13,13 +13,11 @@ export class ListOriginRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Filters the results by configuration type. Valid values:
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
+   * - global: Query global configurations.
+   * - rule: Query rule configurations.
    * 
-   * - `global`: Queries the global configuration.
-   * 
-   * - `rule`: Queries rule configurations.
-   * 
-   * If you do not specify this parameter, the operation returns both global and rule configurations.
+   * This parameter is optional. If not specified, both global and rule configurations are returned without distinction.
    * 
    * @example
    * global
@@ -27,7 +25,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. The default value is 1.
+   * The page number for paginated queries. The value must be greater than or equal to 1. Default value: 1.
    * 
    * @example
    * 1
@@ -35,7 +33,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The maximum value is 500, and the default value is 20.
+   * The number of entries per page for paginated queries. Valid values: 1 to 500. Default value: 500.
    * 
    * @example
    * 20
@@ -43,7 +41,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The rule name. This parameter is not required when querying the global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * test
@@ -51,7 +49,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The site ID. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can obtain the site ID by calling the [ListSites](~~ListSites~~) API operation.
    * 
    * This parameter is required.
    * 
@@ -61,7 +59,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Specifies the site version to query. This parameter applies only to sites that have version management enabled. The default value is 0.
+   * The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 1

package/src/models/ListOriginRulesResponseBody.ts

@@ -13,11 +13,10 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. You can use this parameter to query for global or rule-specific configurations. Valid values:
+   * The configuration type. You can query global or rule configurations based on this parameter. Valid values:
    * 
-   * - `global`: The global configuration.
-   * 
-   * - `rule`: A rule-specific configuration.
+   * - global: Query global configurations.
+   * - rule: Query rule configurations.
    * 
    * @example
    * global
@@ -25,7 +24,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Overrides the DNS record for the origin request.
+   * The rewritten DNS resolution record for back-to-origin requests.
    * 
    * @example
    * test.example.com
@@ -33,11 +32,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   dnsRecord?: string;
   /**
    * @remarks
-   * Specifies whether to follow 302 redirects from the origin. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The back-to-origin 302 redirect follow switch. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -45,7 +42,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   follow302Enable?: string;
   /**
    * @remarks
-   * The maximum number of 302 redirects to follow. Valid range: 1 to 5.
+   * The maximum number of 302 redirect follows. Valid values: 1 to 5.
    * 
    * @example
    * 1
@@ -53,11 +50,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   follow302MaxTries?: string;
   /**
    * @remarks
-   * Specifies whether to retain the original request parameters when following a redirect. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The switch for retaining original request parameters. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -65,11 +60,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   follow302RetainArgs?: string;
   /**
    * @remarks
-   * Specifies whether to retain the original request header when following a redirect. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The switch for retaining original request headers. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -77,7 +70,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   follow302RetainHeader?: string;
   /**
    * @remarks
-   * The host to use for the origin request after following a 302 redirect.
+   * The back-to-origin host after 302 redirect modification.
    * 
    * @example
    * test.com
@@ -85,7 +78,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   follow302TargetHost?: string;
   /**
    * @remarks
-   * The `Host` header carried in the origin request.
+   * The HOST carried in the back-to-origin request.
    * 
    * @example
    * origin.example.com
@@ -93,7 +86,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originHost?: string;
   /**
    * @remarks
-   * The origin server port used for origin requests over HTTP.
+   * The origin server port accessed when using the HTTP protocol for back-to-origin.
    * 
    * @example
    * 8080
@@ -101,7 +94,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originHttpPort?: string;
   /**
    * @remarks
-   * The origin server port used for origin requests over HTTPS.
+   * The origin server port accessed when using the HTTPS protocol for back-to-origin.
    * 
    * @example
    * 4433
@@ -109,11 +102,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originHttpsPort?: string;
   /**
    * @remarks
-   * Specifies whether mTLS is enabled. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The mTLS switch. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -121,7 +112,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originMtls?: string;
   /**
    * @remarks
-   * The read timeout, in seconds, for the origin server.
+   * The origin server read timeout period, in seconds.
    * 
    * @example
    * 10
@@ -129,13 +120,10 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originReadTimeout?: string;
   /**
    * @remarks
-   * The protocol used for origin requests. Valid values:
-   * 
-   * - `http`: Use the HTTP protocol for origin requests.
-   * 
-   * - `https`: Use the HTTPS protocol for origin requests.
-   * 
-   * - `follow`: Use the same protocol as the client request.
+   * The protocol used for back-to-origin requests. Valid values:
+   * - http: Use the HTTP protocol for back-to-origin.
+   * - https: Use the HTTPS protocol for back-to-origin.
+   * - follow: Follow the client protocol for back-to-origin.
    * 
    * @example
    * http
@@ -143,7 +131,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originScheme?: string;
   /**
    * @remarks
-   * The SNI carried in the origin request.
+   * The SNI carried in the back-to-origin request.
    * 
    * @example
    * origin.example.com
@@ -151,11 +139,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originSni?: string;
   /**
    * @remarks
-   * Specifies whether to verify the origin server certificate. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The origin server certificate verification switch. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -163,13 +149,10 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   originVerify?: string;
   /**
    * @remarks
-   * Specifies whether to use range-based requests to retrieve files from the origin. Valid values:
-   * 
-   * - `on`: Enables range requests.
-   * 
-   * - `off`: Disables range requests.
-   * 
-   * - `force`: Forces range requests.
+   * Use range-based slicing for back-to-origin file downloads. Valid values:
+   * - on: Enable.
+   * - off: Disable.
+   * - force: Force enable.
    * 
    * @example
    * on
@@ -177,7 +160,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   range?: string;
   /**
    * @remarks
-   * The size of each chunk for range requests.
+   * The range chunk size.
    * 
    * @example
    * 1MB
@@ -185,11 +168,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   rangeChunkSize?: string;
   /**
    * @remarks
-   * The rule content, which uses a conditional expression to match user requests. This parameter is not required for global configurations. It supports two use cases:
-   * 
-   * - To match all incoming requests, set the value to `true`.
-   * 
-   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
+   * The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. There are two usage scenarios:
+   * - Match all incoming requests: Set the value to true.
+   * - Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -197,11 +178,9 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether the rule is enabled. This parameter is not required for global configurations. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:
+   * - on: Enable.
+   * - off: Disable.
    * 
    * @example
    * on
@@ -209,7 +188,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. This parameter is not required for global configurations.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -217,7 +196,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The rule execution order. Lower values indicate higher priority.
+   * The execution order of the rule. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -225,7 +204,7 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site configuration version. If versioning is enabled for the site, this parameter specifies which version to use. The default is 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 1
@@ -299,12 +278,12 @@ export class ListOriginRulesResponseBodyConfigs extends $dara.Model {
 export class ListOriginRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of configurations.
+   * The configurations in the response.
    */
   configs?: ListOriginRulesResponseBodyConfigs[];
   /**
    * @remarks
-   * The current page number.
+   * The current page number, same as the PageNumber request parameter.
    * 
    * @example
    * 1

package/src/models/ListPostpaidRatePlanInstancesRequest.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to return only instances that have remaining site quota. Valid values:
+   * Specifies whether to check for remaining site quota. Valid values:
    * 
-   * - `true`: Returns only instances with remaining site quota.
+   * - true: Queries instances that have remaining site quota.
    * 
-   * - `false`: Returns all instances, regardless of site quota.
+   * - false: Does not filter by this condition.
    * 
    * @example
    * true
@@ -17,7 +17,7 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   checkRemainingSiteQuota?: string;
   /**
    * @remarks
-   * The ID of the instance to query.
+   * The instance ID. Use this parameter to query a specific instance.
    * 
    * @example
    * sp-dps-xxxxxx
@@ -25,7 +25,7 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. The value must be greater than or equal to 1.
+   * The page number for paging. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -33,7 +33,7 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The maximum value is 500.
+   * The number of entries per page for paging. Valid values: 1 to 500.
    * 
    * @example
    * 12
@@ -41,9 +41,9 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The field to sort the results by. Valid value:
+   * The field by which to sort the results. Valid values:
    * 
-   * - `CreateTime`: Sorts by creation time.
+   * - CreateTime: sorts by creation time.
    * 
    * @example
    * CreateTime
@@ -53,9 +53,9 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
    * @remarks
    * The sort order. Valid values:
    * 
-   * - `asc`: ascending
+   *  * asc: ascending order
    * 
-   * - `desc`: descending
+   *  * desc: descending order.
    * 
    * @example
    * desc
@@ -65,11 +65,11 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
    * @remarks
    * The instance status. Valid values:
    * 
-   * - `online`: The instance is running.
+   *  * online: Normal.
    * 
-   * - `overdue`: The payment for the instance is overdue.
+   *  * overdue: Overdue payment.
    * 
-   * - `disable`: The instance is released.
+   *  * disable: Released.
    * 
    * @example
    * online
@@ -77,7 +77,7 @@ export class ListPostpaidRatePlanInstancesRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The type of add-on service to filter by, such as `bot` or `ddos`.
+   * Specifies whether the instance has purchased additional bot or DDoS protection.
    * 
    * @example
    * bot

package/src/models/ListPostpaidRatePlanInstancesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfoSites extends $dara.Model {
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * @example
    * 123456****
@@ -13,7 +13,7 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfoSites extends
   siteId?: number;
   /**
    * @remarks
-   * The name of the site.
+   * The site name.
    * 
    * @example
    * example.com
@@ -21,15 +21,12 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfoSites extends
   siteName?: string;
   /**
    * @remarks
-   * The status of the site. Valid values:
+   * The site status. Valid values:
    * 
-   * - `pending`: The site is awaiting configuration.
-   * 
-   * - `active`: The site is active.
-   * 
-   * - `offline`: The site is offline.
-   * 
-   * - `moved`: The site has been replaced.
+   * - pending: The site is pending configuration.
+   * - active: The site is activated.
+   * - offline: The site is offline.
+   * - moved: The site has been replaced.
    * 
    * @example
    * pending
@@ -63,9 +60,8 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfoSites extends
 export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara.Model {
   /**
    * @remarks
-   * The billing method. Valid value:
-   * 
-   * - `dps_month95`: Monthly 95th percentile.
+   * The billable methods. Valid values:
+   * - dps_month95: monthly 95th percentile billing.
    * 
    * @example
    * SUBSCRIBE
@@ -73,9 +69,9 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   billingMethod?: string;
   /**
    * @remarks
-   * The billing mode. Valid value:
+   * The billing mode. Valid values:
    * 
-   * - `POSTPAY`: pay-as-you-go.
+   *  * POSTPAY: pay-as-you-go.
    * 
    * @example
    * POSTPAY
@@ -83,13 +79,11 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   billingMode?: string;
   /**
    * @remarks
-   * The coverage area of the instance. Only sites within this area can be bound to the instance. If multiple areas are supported, they are separated by a comma (`,`). Valid values:
+   * The acceleration regions to which the instance can bindable sites. Multiple values are separated by commas (,). Valid values:
    * 
-   * - `domestic`: Chinese mainland.
-   * 
-   * - `overseas`: Regions outside the Chinese mainland.
-   * 
-   * - `global`: Global (including the Chinese mainland).
+   * - domestic: the Chinese mainland.
+   * - overseas: global (excluding the Chinese mainland).
+   * - global: global (including the Chinese mainland).
    * 
    * @example
    * domestic
@@ -97,23 +91,23 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   coverages?: string;
   /**
    * @remarks
-   * The time when the instance was created.
+   * The time when the instance was created. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    * 
    * @example
-   * YYYY-MM-DDThh:mm:ssZ
+   * 2026-04-19T11:15:20Z
    */
   createTime?: string;
   /**
    * @remarks
-   * The time of a scheduled configuration change.
+   * The scheduled specification change time. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
    * 
    * @example
-   * YYYY-MM-DDThh:mm:ssZ
+   * 2026-04-19T11:15:20Z
    */
   expectedUpdateTime?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -137,11 +131,9 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   planNameCn?: string;
   /**
    * @remarks
-   * The type of the plan. Valid values:
-   * 
-   * - `normal`: Normal plan.
-   * 
-   * - `enterprise`: Enterprise plan.
+   * The plan type of the instance. Valid values:
+   * - normal: Fixed plan.
+   * - enterprise: Enterprise plan.
    * 
    * @example
    * normal
@@ -149,7 +141,7 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   planType?: string;
   /**
    * @remarks
-   * The maximum number of sites that can be bound to the instance.
+   * The site quota.
    * 
    * @example
    * 1
@@ -157,12 +149,12 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
   siteQuota?: string;
   /**
    * @remarks
-   * A list of sites bound to the instance.
+   * The list of sites.
    */
   sites?: ListPostpaidRatePlanInstancesResponseBodyInstanceInfoSites[];
   /**
    * @remarks
-   * The status of the instance.
+   * The instance status.
    * 
    * @example
    * online
@@ -217,12 +209,12 @@ export class ListPostpaidRatePlanInstancesResponseBodyInstanceInfo extends $dara
 export class ListPostpaidRatePlanInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of instances.
+   * The list of instance information.
    */
   instanceInfo?: ListPostpaidRatePlanInstancesResponseBodyInstanceInfo[];
   /**
    * @remarks
-   * The page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -238,7 +230,7 @@ export class ListPostpaidRatePlanInstancesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The request ID, used for troubleshooting.
+   * The request ID.
    * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A123425345
@@ -246,7 +238,7 @@ export class ListPostpaidRatePlanInstancesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of records.
    * 
    * @example
    * 1