@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/ListRecordsRequest.ts

@@ -5,12 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListRecordsRequest extends $dara.Model {
   /**
    * @remarks
-   * The business scenario for acceleration. Use this parameter to filter results. Valid values:
-   * 
-   * - **image_video**: Images and videos.
-   * 
+   * The business scenario for record acceleration. Used as a filter condition for queries. Valid values:
+   * - **image_video**: Image and video.
    * - **api**: API.
-   * 
    * - **web**: Web page.
    * 
    * @example
@@ -20,7 +17,7 @@ export class ListRecordsRequest extends $dara.Model {
   customPort?: string;
   /**
    * @remarks
-   * The page number. Defaults to **1**.
+   * The page number for paginated queries. The value must be greater than or equal to 1. Default value: **1**.
    * 
    * @example
    * 1
@@ -28,7 +25,7 @@ export class ListRecordsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size. Defaults to **500**.
+   * The number of entries per page for paginated queries. Valid values: 1 to 500. Default value: **500**.
    * 
    * @example
    * 10
@@ -36,11 +33,10 @@ export class ListRecordsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Filters the results based on whether the record is proxied. Valid values:
+   * Specifies whether proxy acceleration is enabled for the record. Used as a filter condition for queries. Valid values:
    * 
-   * - **true**: The record is proxied.
-   * 
-   * - **false**: The record is not proxied.
+   * - **true**: Proxy enabled.
+   * - **false**: Proxy acceleration disabled.
    * 
    * @example
    * true
@@ -48,14 +44,11 @@ export class ListRecordsRequest extends $dara.Model {
   proxied?: boolean;
   /**
    * @remarks
-   * The match type for the record name search. Defaults to **exact**. Valid values:
+   * The search matching mode for record names. Defaults to exact match. Valid values:
    * 
    * - **prefix**: Prefix match.
-   * 
    * - **suffix**: Suffix match.
-   * 
    * - **exact**: Exact match.
-   * 
    * - **fuzzy**: Fuzzy match.
    * 
    * @example
@@ -64,7 +57,7 @@ export class ListRecordsRequest extends $dara.Model {
   recordMatchType?: string;
   /**
    * @remarks
-   * The record name. Use this parameter to filter query results.
+   * Record name. Used as a filter condition for queries.
    * 
    * @example
    * www.example.com
@@ -72,7 +65,7 @@ export class ListRecordsRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The site ID. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 
@@ -82,17 +75,12 @@ export class ListRecordsRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Filters the results by the record\\"s origin type. This filter applies only to CNAME records. Valid values:
-   * 
+   * The origin type of the record. Used as a filter condition for queries (only CNAME records can be filtered by this field). Valid values:
    * - **OSS**: OSS origin.
-   * 
    * - **S3**: S3 origin.
-   * 
    * - **LB**: Load balancer origin.
-   * 
    * - **OP**: Origin pool.
-   * 
-   * - **Domain**: Domain origin.
+   * - **Domain**: Standard domain origin.
    * 
    * @example
    * OSS
@@ -100,7 +88,7 @@ export class ListRecordsRequest extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The DNS record type. Use this parameter to filter results.
+   * The DNS record type of the record. Used as a filter condition for queries.
    * 
    * @example
    * CNAME

package/src/models/ListRecordsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
   /**
    * @remarks
-   * The AccessKey for the account that owns the origin server. This parameter is required if the origin type is OSS and the authentication type is `private_cross_account`, or if the origin type is S3 and the authentication type is `private`.
+   * The AccessKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.
    * 
    * @example
    * u0Nkg5gBK***QF5wvKMM504JUHt
@@ -13,15 +13,11 @@ export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
   accessKey?: string;
   /**
    * @remarks
-   * The origin authentication type. The available authentication types depend on the origin type, which is specified by the `RecordSourceType` parameter. This parameter is required if the origin type is OSS or S3. Valid values:
-   * 
-   * - **public**: Public read. Use this value if the origin type is OSS or S3 and the origin server allows public read access.
-   * 
-   * - **private**: Private read. Use this value if the origin type is S3 and the origin server requires private read access.
-   * 
-   * - **private_same_account**: Private read within the same account. Use this value if the origin type is OSS, the origin server is in the same Alibaba Cloud account, and requires private read access.
-   * 
-   * - **private_cross_account**: Private read across different accounts. Use this value if the origin type is OSS, the origin server is in a different Alibaba Cloud account, and requires private read access.
+   * The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this API. When the origin type is OSS or S3, the origin authentication type must be specified. Valid values:
+   * - **public**: Public read. Use this value when the origin type is OSS or S3 and the origin has public read access.
+   * - **private**: Private read. Use this value when the origin type is S3 and the origin has private read access.
+   * - **private_same_account**: Private same-account read. Use this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin has private read access.
+   * - **private_cross_account**: Private cross-account read. Use this value when the origin type is OSS, the origin is not under the same Alibaba Cloud account, and the origin has private read access.
    * 
    * @example
    * private
@@ -29,7 +25,7 @@ export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
   authType?: string;
   /**
    * @remarks
-   * The region where the origin server is located. This parameter is required if the origin type is S3. For valid region names, refer to the official S3 documentation.
+   * The region where the origin is located. This parameter is available when the origin type is S3. The region of the origin can be obtained from the official S3 website.
    * 
    * @example
    * us-east-1
@@ -37,7 +33,7 @@ export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The SecretKey for the account that owns the origin server. This parameter is required if the origin type is OSS and the authentication type is `private_cross_account`, or if the origin type is S3 and the authentication type is `private`.
+   * The SecretKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.
    * 
    * @example
    * VIxuvJSA2S03f***kp208dy5w7
@@ -45,13 +41,11 @@ export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
   secretKey?: string;
   /**
    * @remarks
-   * The signature algorithm version. This parameter is required if the origin type is S3 and the authentication type is `private`. Valid values:
-   * 
+   * The signature algorithm version. This parameter is available when the origin type is S3 and the origin authentication type is private read. Valid values:
    * - **v2**
-   * 
    * - **v4**
    * 
-   * The default is `v4`.
+   * Default value: v4.
    * 
    * @example
    * v4
@@ -89,7 +83,7 @@ export class ListRecordsResponseBodyRecordsAuthConf extends $dara.Model {
 export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   /**
    * @remarks
-   * The encryption algorithm for the record. The value ranges from **0 to 255**. This parameter is valid only for CERT and SSHFP records.
+   * The encryption algorithm used by the record. Valid values: **0 to 255**. Exclusive to CERT and SSHFP records.
    * 
    * @example
    * 0
@@ -97,7 +91,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   algorithm?: number;
   /**
    * @remarks
-   * The public key certificate. This parameter is valid only for CERT, SMIMEA, and TLSA records.
+   * The public key certificate information of the record. Exclusive to CERT, SMIMEA, and TLSA records.
    * 
    * @example
    * dGVzdGFkYWxrcw==
@@ -105,7 +99,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   certificate?: string;
   /**
    * @remarks
-   * The public key fingerprint. This parameter is valid only for SSHFP records.
+   * The public key fingerprint value of the record. Exclusive to SSHFP records.
    * 
    * @example
    * abcdef1234567890
@@ -113,7 +107,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   fingerprint?: string;
   /**
    * @remarks
-   * The record\\"s flag. For a CAA record, the flag determines how a certificate authority (CA) processes the record. The value ranges from **0 to 255**. This parameter applies only to CAA records.
+   * The flag of the record. The Flag of a CAA record indicates its priority and processing method. Valid values: **0 to 255**. Exclusive to CAA records.
    * 
    * @example
    * 128
@@ -121,7 +115,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   flag?: number;
   /**
    * @remarks
-   * The public key identifier. The value ranges from **0 to 65535**. This parameter is valid only for CERT records.
+   * The public key identifier of the record. Valid values: **0 to 65535**. Exclusive to CERT records.
    * 
    * @example
    * 0
@@ -129,7 +123,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   keyTag?: number;
   /**
    * @remarks
-   * The algorithm policy for matching or validating certificates. The value ranges from **0 to 255**. This parameter is valid only for SMIMEA and TLSA records.
+   * The algorithm strategy used by the record for matching or verifying certificates. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -137,7 +131,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   matchingType?: number;
   /**
    * @remarks
-   * The port number, which must be an integer from **0 to 65535**. This parameter applies only to SRV records.
+   * The port of the record. Valid values: **0 to 65535**. Exclusive to SRV records.
    * 
    * @example
    * 80
@@ -145,7 +139,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * The priority of the record, which must be an integer from **0 to 65535**. A lower value indicates a higher priority. This parameter applies only to MX, SRV, and URI records.
+   * The priority of the record. Valid values: **0 to 65535**. A smaller value indicates a higher priority. Exclusive to MX, SRV, and URI records.
    * 
    * @example
    * 0
@@ -153,7 +147,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   priority?: number;
   /**
    * @remarks
-   * The type of certificate or public key for the record. The value ranges from **0 to 255**. This parameter is valid only for SMIMEA and TLSA records.
+   * The type of certificate or public key used by the record. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -161,16 +155,23 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   selector?: number;
   /**
    * @remarks
-   * The record\\"s tag. For a CAA record, the tag indicates its specific type and purpose. This parameter is valid only for CAA records.
+   * The tag of the record. The Tag of a CAA record indicates its specific type and purpose. Exclusive to CAA records.
    * 
    * @example
    * issue
    */
   tag?: string;
+  /**
+   * @remarks
+   * The tags of the record.
+   * 
+   * @example
+   * {\\"Name\\":\\"PARAMETER\\"}
+   */
   tags?: { [key: string]: any };
   /**
    * @remarks
-   * The certificate type for a CERT record, or the public key type for an SSHFP record.
+   * The certificate type of the record (in CERT records), or the public key type (in SSHFP records).
    * 
    * @example
    * 0
@@ -178,7 +179,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   type?: number;
   /**
    * @remarks
-   * The usage identifier. The value ranges from **0 to 255**. This parameter is valid only for SMIMEA and TLSA records.
+   * The usage identifier of the record. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -186,23 +187,16 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   usage?: number;
   /**
    * @remarks
-   * The value of the record. This parameter applies to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. The meaning of this parameter varies based on the record type:
-   * 
-   * - **A/AAAA**: The target IP address. Use an IPv4 address for an A record and an IPv6 address for an AAAA record.
-   * 
-   * - **CNAME**: The target domain name.
+   * The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings for different record types:
    * 
+   * - **A/AAAA**: The IP address pointed to. When there are multiple IPs, they are separated by commas (,). At least one IPv4 address is required.
+   * - **CNAME**: The target domain name pointed to.
    * - **NS**: The name server for the specified domain.
-   * 
-   * - **MX**: The domain name of the target mail server.
-   * 
-   * - **TXT**: A text string.
-   * 
-   * - **CAA**: The domain name of the certificate authority.
-   * 
-   * - **SRV**: The domain name of the target host.
-   * 
-   * - **URI**: A URI string.
+   * - **MX**: A valid target mail server domain name.
+   * - **TXT**: A valid text string.
+   * - **CAA**: A valid certificate authority domain name.
+   * - **SRV**: A valid target host domain name.
+   * - **URI**: A valid URI string.
    * 
    * @example
    * CNAME
@@ -210,7 +204,7 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
   value?: string;
   /**
    * @remarks
-   * The weight of the record, which must be an integer from **0 to 65535**. This parameter applies only to SRV and URI records.
+   * The weight of the record. Valid values: **0 to 65535**. Exclusive to SRV and URI records.
    * 
    * @example
    * 0
@@ -271,17 +265,14 @@ export class ListRecordsResponseBodyRecordsData extends $dara.Model {
 export class ListRecordsResponseBodyRecords extends $dara.Model {
   /**
    * @remarks
-   * The origin authentication settings for the CNAME record.
+   * The origin authentication information of the CNAME record.
    */
   authConf?: ListRecordsResponseBodyRecordsAuthConf;
   /**
    * @remarks
    * The business scenario for record acceleration. Valid values:
-   * 
-   * - **image_video**: Images and videos.
-   * 
+   * - **image_video**: Image and video.
    * - **api**: API.
-   * 
    * - **web**: Web page.
    * 
    * @example
@@ -290,7 +281,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   bizName?: string;
   /**
    * @remarks
-   * The record\\"s comment.
+   * The comment of the record.
    * 
    * @example
    * this is a remark.
@@ -298,7 +289,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The UTC time when the record was created, in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
+   * The creation time of the record. The date format follows the ISO 8601 standard and uses UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -307,7 +298,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   customPort?: string;
   /**
    * @remarks
-   * The DNS details of the record. The fields in this object vary based on the record type.
+   * The specific DNS information of the record. Different record types contain different information.
    * 
    * @example
    * {"value":"1.1.1.1"}
@@ -315,11 +306,10 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   data?: ListRecordsResponseBodyRecordsData;
   /**
    * @remarks
-   * The policy for the `HOST` header in back-to-origin requests. This parameter applies only to CNAME records. Valid values:
+   * The origin host policy. This takes effect when the record type is CNAME. It sets the policy for the host header used during origin requests. Two modes are available:
    * 
-   * - **follow_hostname**: Uses the `HOST` header of the incoming request.
-   * 
-   * - **follow_origin_domain**: Uses the domain name of the origin server.
+   * - **follow_hostname**: Follow the request host.
+   * - **follow_origin_domain**: Follow the origin domain.
    * 
    * @example
    * follow_origin_domain
@@ -331,9 +321,8 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
    * @remarks
    * Indicates whether proxy acceleration is enabled for the record. Valid values:
    * 
-   * - **true**: Proxy acceleration is enabled.
-   * 
-   * - **false**: Proxy acceleration is disabled.
+   * - **true**: Proxy enabled.
+   * - **false**: Proxy acceleration disabled.
    * 
    * @example
    * true
@@ -341,7 +330,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   proxied?: boolean;
   /**
    * @remarks
-   * The CNAME value assigned to this record. To enable the service, create a CNAME record in your DNS provider\\"s settings that points to this value.
+   * The CNAME of the record. This is the CNAME value that needs to be configured for the record when the site access method is CNAME access.
    * 
    * @example
    * a.example.com.cnamezone.com
@@ -365,19 +354,15 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The type of origin for the CNAME record. This parameter is required when you add a CNAME record. Valid values:
+   * The origin type of the CNAME record. This parameter is required when adding a CNAME record. Valid values:
    * 
    * - **OSS**: OSS origin.
-   * 
    * - **S3**: S3 origin.
-   * 
    * - **LB**: Load balancer origin.
-   * 
    * - **OP**: Origin pool.
+   * - **Domain**: Standard domain origin.
    * 
-   * - **Domain**: Domain origin.
-   * 
-   * If this parameter is not specified, the default value is `Domain`.
+   * If this parameter is not specified or left empty, the default value is Domain, which indicates a standard domain origin type.
    * 
    * @example
    * OSS
@@ -385,7 +370,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   recordSourceType?: string;
   /**
    * @remarks
-   * The DNS record type, such as **A/AAAA, CNAME, and TXT**.
+   * The DNS type of the record, such as **A/AAAA, CNAME, TXT**, etc.
    * 
    * @example
    * A/AAAA
@@ -409,7 +394,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The Time to Live (TTL) for the record, in seconds. A value of 1 indicates that the TTL is automatic.
+   * The TTL (Time to Live) of the record, in seconds. When the value is 1, it indicates that the TTL is set to automatic.
    * 
    * @example
    * 30
@@ -417,7 +402,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
   ttl?: number;
   /**
    * @remarks
-   * The UTC time when the record was last updated, in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.
+   * The update time of the record. The date format follows the ISO 8601 standard and uses UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-06-07T10:02:59Z
@@ -489,7 +474,7 @@ export class ListRecordsResponseBodyRecords extends $dara.Model {
 export class ListRecordsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The current page number.
+   * The current page number, same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -497,7 +482,7 @@ export class ListRecordsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of records returned per page.
+   * The number of records displayed per page.
    * 
    * @example
    * 10
@@ -505,7 +490,7 @@ export class ListRecordsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * A list of DNS records. For details, see the <props="china">[documentation](https://help.aliyun.com/document_detail/2708761.html)<props="intl">[documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).
+   * DNS information of the records. For details, refer to <props="china">[Documentation](https://help.aliyun.com/document_detail/2708761.html)<props="intl">[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).
    */
   records?: ListRecordsResponseBodyRecords[];
   /**

package/src/models/ListRedirectRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListRedirectRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,9 +13,9 @@ export class ListRedirectRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type. Possible values:
-   * - global: Global configuration.
-   * - rule: Rule configuration.
+   * The configuration type. Valid values:
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * rule
@@ -23,7 +23,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -31,7 +31,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size, default is **500**, and the value range is **1~500**.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -39,7 +39,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name, which can be used to find the rule with the specified name.
+   * The rule name. You can use this parameter to query the rule whose name matches the specified value.
    * 
    * @example
    * rule_example
@@ -47,7 +47,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @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.
    * 
@@ -57,7 +57,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, with the default being version 0.
+   * The version number of the site configuration. 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
    * 0