@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListOriginClientCertificatesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -29,12 +29,12 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   fingerprintSha256?: string;
   /**
    * @remarks
-   * The domain names to associate.
+   * The hostnames bound to the certificate.
    */
   hostnames?: string[];
   /**
    * @remarks
-   * The certificate ID.
+   * The ID of the certificate.
    * 
    * @example
    * babaabcd****
@@ -42,7 +42,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The issuer of the certificate.
    * 
    * @example
    * DigiCert
@@ -50,7 +50,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   issuer?: string;
   /**
    * @remarks
-   * The certificate name.
+   * The name of the certificate.
    * 
    * @example
    * yourCertName
@@ -58,7 +58,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   name?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The expiration date and time of the certificate.
    * 
    * @example
    * 2024-03-31 02:08:00
@@ -66,7 +66,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The beginning of the certificate\\"s validity period.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -74,7 +74,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   notBefore?: string;
   /**
    * @remarks
-   * The public-key algorithm of the certificate.
+   * The public key algorithm of the certificate.
    * 
    * @example
    * RSA
@@ -106,7 +106,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   signatureAlgorithm?: string;
   /**
    * @remarks
-   * The certificate status.
+   * The status of the certificate.
    * 
    * @example
    * OK
@@ -114,8 +114,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   status?: string;
   /**
    * @remarks
-   * The certificate type.
-   * *   upload: custom certificate that you upload
+   * The type of the certificate.
    * 
    * @example
    * upload
@@ -123,7 +122,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
   type?: string;
   /**
    * @remarks
-   * The time when the certificate was updated.
+   * The time when the certificate was last updated.
    * 
    * @example
    * 2024-07-20 06:18:42
@@ -186,7 +185,7 @@ export class ListOriginClientCertificatesResponseBodyResult extends $dara.Model
 export class ListOriginClientCertificatesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number. The default value is **1**.
    * 
    * @example
    * 1
@@ -210,12 +209,12 @@ export class ListOriginClientCertificatesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The certificate information.
+   * The list of certificate information.
    */
   result?: ListOriginClientCertificatesResponseBodyResult[];
   /**
    * @remarks
-   * The website ID.
+   * The ID of the site.
    * 
    * @example
    * 123456789****
@@ -223,7 +222,7 @@ export class ListOriginClientCertificatesResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The name of the site.
    * 
    * @example
    * example.com

package/src/models/ListOriginPoolsRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListOriginPoolsRequest extends $dara.Model {
   /**
    * @remarks
-   * Type of name match query, supporting the following two types, with exact match as the default.
+   * Specifies how to match the origin pool name. The default is `exact`. Valid values:
    * 
-   * - fuzzy: Fuzzy query.
-   * - exact: Exact query.
+   * - `fuzzy`: Performs a fuzzy search.
+   * 
+   * - `exact`: Performs an exact match.
    * 
    * @example
    * exact
@@ -16,7 +17,7 @@ export class ListOriginPoolsRequest extends $dara.Model {
   matchType?: string;
   /**
    * @remarks
-   * Name of the origin pool.
+   * The name of the origin pool.
    * 
    * @example
    * pool1
@@ -24,10 +25,11 @@ export class ListOriginPoolsRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Sorting, supports ascending and descending order by ID, default is descending by ID, which is positively correlated with creation time.
+   * Specifies how the results are sorted. By default, results are sorted by ID in descending order. To sort by ID in ascending order, set this parameter to `id`. IDs increase with creation time.
+   * 
+   * - id: Sorts by ID in descending order.
    * 
-   * - -id: Sort by ID in descending order.
-   * - id: Sort by ID in ascending order.
+   * - id: Sorts by ID in ascending order.
    * 
    * @example
    * id
@@ -35,7 +37,7 @@ export class ListOriginPoolsRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * Page number, default value is 1.
+   * The page number. The default value is 1.
    * 
    * @example
    * 1
@@ -43,7 +45,7 @@ export class ListOriginPoolsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size, an integer greater than 0, with a maximum of 500. If the value exceeds 500, it will be set to 500.
+   * The number of entries per page. The value must be an integer from 1 to 500. If you specify a value greater than 500, the system uses 500.
    * 
    * @example
    * 20
@@ -51,7 +53,7 @@ export class ListOriginPoolsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.
+   * The site ID. To get this ID, call the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 

package/src/models/ListOriginPoolsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara.Model {
   /**
    * @remarks
-   * The AccessKey required for private authentication.
+   * The Access Key ID required for private authentication.
    * 
    * @example
    * yourAccessKeyID
@@ -13,12 +13,15 @@ export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara
   accessKey?: string;
   /**
    * @remarks
-   * Authentication type.
+   * The authentication type. Valid values:
    * 
-   * - public: Public read/write, used when the origin is OSS or S3 and it is set to public read/write;
-   * - private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;
-   * - private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts;
-   * - private: Used when the origin is S3 and the authentication type is private.
+   * - `public`: Public read/write. Use for OSS or AWS S3 origins that have public access permissions.
+   * 
+   * - `private_same_account`: Private, same account. Use for OSS origins that use private authentication within the same account.
+   * 
+   * - `private_cross_account`: Private, cross-account. Use for OSS origins that use private authentication from a different account.
+   * 
+   * - `private`: Private. Use for AWS S3 origins that require private authentication.
    * 
    * @example
    * public
@@ -26,7 +29,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara
   authType?: string;
   /**
    * @remarks
-   * The Region of the origin required when the origin is AWS S3.
+   * The region of the origin. Required for AWS S3 origins.
    * 
    * @example
    * us-east-1
@@ -34,7 +37,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara
   region?: string;
   /**
    * @remarks
-   * The SecretKey required for private authentication.
+   * The Secret Access Key required for private authentication.
    * 
    * @example
    * yourAccessKeySecret
@@ -42,7 +45,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara
   secretKey?: string;
   /**
    * @remarks
-   * The signature version required when the origin is AWS S3.
+   * The signature version. Required for AWS S3 origins.
    * 
    * @example
    * v2
@@ -80,7 +83,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf extends $dara
 export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   /**
    * @remarks
-   * Origin address, e.g., www.example.com.
+   * The address of the origin, such as `www.example.com`.
    * 
    * @example
    * www.example.com
@@ -88,15 +91,16 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   address?: string;
   /**
    * @remarks
-   * Authentication information. When the origin is OSS or S3 and requires authentication, you need to provide related configuration information for authentication.
+   * The authentication configuration. This parameter is required if the origin is an OSS or AWS S3 bucket that requires authentication.
    */
   authConf?: ListOriginPoolsResponseBodyOriginPoolsOriginsAuthConf;
   /**
    * @remarks
-   * Whether the origin is enabled:
+   * Indicates whether the origin is enabled.
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - `true`: Enabled.
+   * 
+   * - `false`: Disabled.
    * 
    * @example
    * true
@@ -104,7 +108,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The request header to be carried during back-to-origin, only supports Host.
+   * The request header to include in origin fetches. Only the `Host` header is supported.
    * 
    * @example
    * {
@@ -116,16 +120,31 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   header?: any;
   /**
    * @remarks
-   * Origin ID.
+   * The ID of the origin.
    * 
    * @example
    * 997502094872132
    */
   id?: number;
+  /**
+   * @remarks
+   * The IP protocol version used for origin fetch requests. Valid values:
+   * 
+   * - `round_robin`: Randomly selects an IPv4 or IPv6 origin.
+   * 
+   * - `ipv4_first`: Prioritizes IPv4 origins.
+   * 
+   * - `ipv6_first`: Prioritizes IPv6 origins.
+   * 
+   * - `follow`: Follows the IP version used by the client.
+   * 
+   * @example
+   * round_robin
+   */
   ipVersionPolicy?: string;
   /**
    * @remarks
-   * Origin name.
+   * The name of the origin.
    * 
    * @example
    * origin1
@@ -133,10 +152,13 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Origin type:
-   * - ip_domain: IP or domain type origin; 
-   * - OSS: OSS address origin; 
-   * - S3: AWS S3 origin.
+   * The type of the origin. Valid values:
+   * 
+   * - `ip_domain`: An origin with an IP address or domain name.
+   * 
+   * - `OSS`: An Alibaba Cloud Object Storage Service (OSS) origin.
+   * 
+   * - `S3`: An AWS S3 origin.
    * 
    * @example
    * S3
@@ -144,7 +166,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * Weight, an integer between 0 and 100.
+   * The weight of the origin, an integer from 0 to 100.
    * 
    * @example
    * 50
@@ -193,7 +215,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsOrigins extends $dara.Model {
 export class ListOriginPoolsResponseBodyOriginPoolsReferencesDnsRecords extends $dara.Model {
   /**
    * @remarks
-   * Record ID.
+   * The ID of the record.
    * 
    * @example
    * 1042852886352704
@@ -201,7 +223,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesDnsRecords extends
   id?: number;
   /**
    * @remarks
-   * Record name.
+   * The name of the record.
    * 
    * @example
    * www.example.com
@@ -233,7 +255,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesDnsRecords extends
 export class ListOriginPoolsResponseBodyOriginPoolsReferencesIPARecords extends $dara.Model {
   /**
    * @remarks
-   * Record ID.
+   * The ID of the record.
    * 
    * @example
    * 1042852886352704
@@ -241,7 +263,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesIPARecords extends
   id?: number;
   /**
    * @remarks
-   * Record name.
+   * The name of the record.
    * 
    * @example
    * ipa.example.com
@@ -273,7 +295,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesIPARecords extends
 export class ListOriginPoolsResponseBodyOriginPoolsReferencesLoadBalancers extends $dara.Model {
   /**
    * @remarks
-   * ID of the load balancer.
+   * The ID of the load balancer.
    * 
    * @example
    * 998740660522624
@@ -281,7 +303,7 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesLoadBalancers exten
   id?: number;
   /**
    * @remarks
-   * Name of the load balancer.
+   * The name of the load balancer.
    * 
    * @example
    * lb1.example.com
@@ -313,17 +335,17 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferencesLoadBalancers exten
 export class ListOriginPoolsResponseBodyOriginPoolsReferences extends $dara.Model {
   /**
    * @remarks
-   * 使用此源地址池为源站的七层记录列表。
+   * A list of Layer 7 records that use this origin pool as an origin.
    */
   dnsRecords?: ListOriginPoolsResponseBodyOriginPoolsReferencesDnsRecords[];
   /**
    * @remarks
-   * List of layer 4 records that use this origin pool as the origin.
+   * A list of Layer 4 records that use this origin pool as an origin.
    */
   IPARecords?: ListOriginPoolsResponseBodyOriginPoolsReferencesIPARecords[];
   /**
    * @remarks
-   * List of load balancers using this origin pool.
+   * A list of load balancers that use this origin pool.
    */
   loadBalancers?: ListOriginPoolsResponseBodyOriginPoolsReferencesLoadBalancers[];
   static names(): { [key: string]: string } {
@@ -363,10 +385,11 @@ export class ListOriginPoolsResponseBodyOriginPoolsReferences extends $dara.Mode
 export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   /**
    * @remarks
-   * Whether the origin pool is enabled:
+   * Indicates whether the origin pool is enabled.
+   * 
+   * - `true`: Enabled.
    * 
-   * - true: Enabled;
-   * - false: Disabled.
+   * - `false`: Disabled.
    * 
    * @example
    * false
@@ -374,7 +397,7 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * ID of the origin pool.
+   * The ID of the origin pool.
    * 
    * @example
    * 1038520525196928
@@ -382,7 +405,7 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * Name of the origin pool, unique within a site.
+   * The name of the origin pool. The name must be unique within a site.
    * 
    * @example
    * pool1
@@ -390,12 +413,12 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Information about the origins added to the origin pool.
+   * The origins in the origin pool.
    */
   origins?: ListOriginPoolsResponseBodyOriginPoolsOrigins[];
   /**
    * @remarks
-   * Domain name assigned to the origin pool, which can be used as the origin address for records under the site.
+   * The domain name assigned to the origin pool. This can be used as the origin address for records within the site.
    * 
    * @example
    * pool1.example.com
@@ -403,7 +426,7 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * Number of load balancers that reference this origin pool.
+   * The number of load balancers that reference this origin pool.
    * 
    * @example
    * 5
@@ -411,12 +434,12 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
   referenceLBCount?: number;
   /**
    * @remarks
-   * Reference information for the origin pool. The origin pool is considered referenced when it is configured in a load balancer or set as the origin for a record.
+   * The resources that reference this origin pool. An origin pool is considered referenced when it is configured as an origin for a load balancer or a record.
    */
   references?: ListOriginPoolsResponseBodyOriginPoolsReferences;
   /**
    * @remarks
-   * ID of the site to which the origin pool belongs.
+   * The ID of the site to which the origin pool belongs.
    * 
    * @example
    * 216558609793952
@@ -466,12 +489,12 @@ export class ListOriginPoolsResponseBodyOriginPools extends $dara.Model {
 export class ListOriginPoolsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * List of origin pools.
+   * A list of origin pools.
    */
   originPools?: ListOriginPoolsResponseBodyOriginPools[];
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -479,7 +502,7 @@ export class ListOriginPoolsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size.
+   * The number of items returned per page.
    * 
    * @example
    * 20
@@ -487,7 +510,7 @@ export class ListOriginPoolsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
@@ -495,7 +518,7 @@ export class ListOriginPoolsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total count.
+   * The total number of origin pools found.
    * 
    * @example
    * 16
@@ -503,7 +526,7 @@ export class ListOriginPoolsResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * Total number of pages.
+   * The total number of pages.
    * 
    * @example
    * 10

package/src/models/ListOriginRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListOriginRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,11 +13,13 @@ export class ListOriginRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Value range:
-   * - global: Query global configuration.
-   * - rule: Query rule configuration.
+   * Filters the results by configuration type. Valid values:
    * 
-   * This parameter is optional; if not provided, it does not distinguish between global and 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.
    * 
    * @example
    * global
@@ -25,7 +27,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number, defaulting to 1 if not provided.
+   * The page number. The default value is 1.
    * 
    * @example
    * 1
@@ -33,7 +35,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page, with a maximum of 500. Defaults to 500 if not provided.
+   * The number of entries to return on each page. The maximum value is 500, and the default value is 20.
    * 
    * @example
    * 20
@@ -41,7 +43,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required when querying the global configuration.
    * 
    * @example
    * test
@@ -49,7 +51,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -59,7 +61,7 @@ export class ListOriginRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site. For sites with version management enabled, this parameter can specify the version of the site for which the configuration is effective, defaulting to version 0.
+   * Specifies the site version to query. This parameter applies only to sites that have version management enabled. The default value is 0.
    * 
    * @example
    * 1