@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListCertificatesByRecordRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCertificatesByRecordRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to return the certificate details. 0 indicates that the certificate details are not returned. 1 indicates that the certificate details are returned.
+   * Specifies whether to return certificate details. A value of `1` includes certificate details, whereas a value of `0` excludes them.
    * 
    * @example
    * 1
@@ -23,7 +23,7 @@ export class ListCertificatesByRecordRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. To obtain this ID, call the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -33,7 +33,7 @@ export class ListCertificatesByRecordRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Specifies whether to return only valid certificates. 0 indicates that all matched certificates are returned. 1 indicates that only valid certificates are returned.
+   * Specifies whether to return only valid certificates. A value of `1` returns only valid certificates, whereas `0` returns all matching certificates.
    * 
    * @example
    * 1

package/src/models/ListCertificatesByRecordResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCertificatesByRecordResponseBodyResultCertificates extends $dara.Model {
   /**
    * @remarks
-   * The certificate ID on Certificate Management Service.
+   * The ID of the Alibaba Cloud certificate.
    * 
    * @example
    * 30000137
@@ -13,7 +13,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   casId?: string;
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -21,7 +21,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   commonName?: string;
   /**
    * @remarks
-   * The creation time.
+   * The time when the certificate was created.
    * 
    * @example
    * 2023-02-28 06:17:11
@@ -45,7 +45,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The issuer of the certificate.
    * 
    * @example
    * GlobalSign nv-sa
@@ -53,16 +53,23 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   issuer?: string;
   /**
    * @remarks
-   * The Common Name of the certificate issuer.
+   * The common name of the certificate issuer.
    * 
    * @example
    * GlobalSign Organization Validation CA - SHA256 - G3
    */
   issuerCN?: string;
+  /**
+   * @remarks
+   * The Keyless server ID. This parameter is valid only when `Type` is set to `keyless`.
+   * 
+   * @example
+   * baba39055622c008b90285a8838e****
+   */
   keyServerId?: string;
   /**
    * @remarks
-   * The certificate name.
+   * The name of the certificate.
    * 
    * @example
    * yourCertName
@@ -70,7 +77,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   name?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The date and time when the certificate expires.
    * 
    * @example
    * 2024-02-28 06:17:11
@@ -78,7 +85,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The date and time when the certificate becomes valid.
    * 
    * @example
    * 2023-02-28 06:17:11
@@ -102,7 +109,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   region?: string;
   /**
    * @remarks
-   * The Subject Alternative Name (SAN) of the certificate.
+   * The Subject Alternative Names (SANs) of the certificate.
    * 
    * @example
    * www.example.com,*.example.com
@@ -134,7 +141,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   status?: string;
   /**
    * @remarks
-   * The type of the SSL certificate. Valid values:
+   * The type of the certificate. Valid values:
    * 
    * @example
    * free
@@ -142,7 +149,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
   type?: string;
   /**
    * @remarks
-   * The update time.
+   * The time when the certificate was last updated.
    * 
    * @example
    * 2023-02-28 06:17:11
@@ -208,7 +215,7 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
 export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The number of certificates that are being requested.
+   * The number of certificate requests in progress.
    * 
    * @example
    * 1
@@ -216,12 +223,12 @@ export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
   applylingCount?: number;
   /**
    * @remarks
-   * The certificates that match the specified records.
+   * A list of certificates matching the record.
    */
   certificates?: ListCertificatesByRecordResponseBodyResultCertificates[];
   /**
    * @remarks
-   * The number of certificates that match the specified records.
+   * The number of certificates matching the record.
    * 
    * @example
    * 3
@@ -229,7 +236,7 @@ export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
   count?: number;
   /**
    * @remarks
-   * The name of the record.
+   * The record name.
    * 
    * @example
    * www.example.com
@@ -237,7 +244,7 @@ export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * Certificate configuration status. Possible values: none; configured; applying; failed.
+   * The certificate configuration status for the record. Valid values:
    * 
    * @example
    * none
@@ -286,12 +293,12 @@ export class ListCertificatesByRecordResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried certificates.
+   * An array of record details.
    */
   result?: ListCertificatesByRecordResponseBodyResult[];
   /**
    * @remarks
-   * The website ID,
+   * The site ID.
    * 
    * @example
    * 1234567890123
@@ -299,7 +306,7 @@ export class ListCertificatesByRecordResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -307,7 +314,7 @@ export class ListCertificatesByRecordResponseBody extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The total number of records that you specified.
+   * The total number of records.
    * 
    * @example
    * 12

package/src/models/ListCertificatesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCertificatesRequest extends $dara.Model {
   /**
    * @remarks
-   * The keyword that is used for the search.
+   * The search keyword.
    * 
    * @example
    * example
@@ -13,7 +13,7 @@ export class ListCertificatesRequest extends $dara.Model {
   keyword?: string;
   /**
    * @remarks
-   * The page number.
+   * The page number to return.
    * 
    * @example
    * 3
@@ -21,7 +21,7 @@ export class ListCertificatesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries to return on each page.
    * 
    * @example
    * 10
@@ -29,7 +29,7 @@ export class ListCertificatesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. To get this ID, call the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/ListCertificatesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
   /**
    * @remarks
-   * The DCV ID.
+   * The ID of the DCV record.
    * 
    * @example
    * bababf7cdd1546a2ad04c0def1f4****
@@ -13,7 +13,7 @@ export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The DCV name. It is a TXT record name if Type is DNS or URL if Type is HTTP.
+   * The DCV key. For the `DNS` method, this is the name of the TXT record. For the `HTTP` method, this is the URL.
    * 
    * @example
    * http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
@@ -21,7 +21,7 @@ export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The verification status.
+   * The validation status.
    * 
    * @example
    * pending
@@ -29,7 +29,7 @@ export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The DCV type. Valid values: DNS and HTTP.
+   * The DCV method. Valid values: `DNS` and `HTTP`.
    * 
    * @example
    * HTTP
@@ -37,7 +37,7 @@ export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The DCV content.
+   * The DCV value.
    * 
    * @example
    * pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
@@ -75,7 +75,7 @@ export class ListCertificatesResponseBodyResultDCV extends $dara.Model {
 export class ListCertificatesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The error code returned for certificate application.
+   * The error code returned when a certificate application fails.
    * 
    * @example
    * 2
@@ -83,7 +83,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   applyCode?: number;
   /**
    * @remarks
-   * The error message returned for certificate application.
+   * The error message returned when a certificate application fails.
    * 
    * @example
    * canceled
@@ -91,7 +91,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   applyMessage?: string;
   /**
    * @remarks
-   * The certificate ID on Certificate Management Service.
+   * The ID of the cloud certificate.
    * 
    * @example
    * 30000569
@@ -99,7 +99,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   casId?: string;
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -115,7 +115,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The Domain Control Validation (DCV) information.
+   * The domain control validation (DCV) information.
    */
   DCV?: ListCertificatesResponseBodyResultDCV[];
   /**
@@ -128,7 +128,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   fingerprintSha256?: string;
   /**
    * @remarks
-   * The certificate ID on ESA.
+   * The ID of the certificate.
    * 
    * @example
    * baba39055622c008b90285a8838e****
@@ -136,7 +136,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The issuer of the certificate.
    * 
    * @example
    * GlobalSign nv-sa
@@ -144,16 +144,23 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   issuer?: string;
   /**
    * @remarks
-   * The Common Name of the certificate issuer.
+   * The common name of the certificate issuer.
    * 
    * @example
    * GlobalSign Organization Validation CA - SHA256 - G3
    */
   issuerCN?: string;
+  /**
+   * @remarks
+   * The ID of the keyless server. This parameter is valid only when `Type` is set to `keyless`.
+   * 
+   * @example
+   * baba39055622c008b90285a8838e****
+   */
   keyServerId?: string;
   /**
    * @remarks
-   * The certificate name.
+   * The name of the certificate.
    * 
    * @example
    * yourCertName
@@ -169,7 +176,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The time when the certificate becomes valid.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -185,7 +192,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   pubAlg?: string;
   /**
    * @remarks
-   * The region where the certificate is stored.
+   * The region.
    * 
    * @example
    * cn-hangzhou
@@ -193,7 +200,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The Subject Alternative Name (SAN) of the certificate.
+   * The subject alternative name (SAN) of the certificate.
    * 
    * @example
    * www.example.com,*.example.com
@@ -217,15 +224,21 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   sigAlg?: string;
   /**
    * @remarks
-   * The certificate status.
+   * The status of the certificate. Valid values:
+   * 
+   * - `OK`: The certificate is valid.
+   * 
+   * - `Expired`: The certificate has expired.
    * 
-   * *   OK
-   * *   Expired
-   * *   Expiring
-   * *   Issued
-   * *   Applying
-   * *   ApplyFailed
-   * *   Canceled
+   * - `Expiring`: The certificate is due to expire within 30 days.
+   * 
+   * - `Issued`: The free certificate has been issued.
+   * 
+   * - `Applying`: The free certificate application is in progress.
+   * 
+   * - `ApplyFailed`: The free certificate application has failed.
+   * 
+   * - `Canceled`: The free certificate application has been canceled.
    * 
    * @example
    * OK
@@ -233,11 +246,15 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The certificate type.
+   * The type of the certificate. Valid values:
+   * 
+   * - `cas`: An Alibaba Cloud certificate.
+   * 
+   * - `upload`: A user-uploaded certificate.
+   * 
+   * - `free`: A free certificate.
    * 
-   * *   cas: certificate that is purchased by using Certificate Management Service
-   * *   upload: custom certificate that you upload
-   * *   free: free certificate
+   * - `keyless`: A keyless certificate.
    * 
    * @example
    * free
@@ -245,7 +262,7 @@ export class ListCertificatesResponseBodyResult extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The time when the certificate was updated.
+   * The time when the certificate was last updated.
    * 
    * @example
    * 2023-04-20 06:18:42
@@ -328,7 +345,7 @@ export class ListCertificatesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries to return on each page.
    * 
    * @example
    * 20
@@ -344,12 +361,12 @@ export class ListCertificatesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried certificates.
+   * A list of certificate details.
    */
   result?: ListCertificatesResponseBodyResult[];
   /**
    * @remarks
-   * The website ID.
+   * The ID of the site.
    * 
    * @example
    * 1234567890123
@@ -357,7 +374,7 @@ export class ListCertificatesResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The name of the site.
    * 
    * @example
    * example.com
@@ -365,7 +382,7 @@ export class ListCertificatesResponseBody extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 10

package/src/models/ListClientCaCertificatesRequest.ts

@@ -13,7 +13,7 @@ export class ListClientCaCertificatesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: 20. Valid values: 1 to 100.
+   * The number of entries to return per page. Valid values: 1 to 100. The default value is 20.
    * 
    * @example
    * 20
@@ -21,7 +21,7 @@ export class ListClientCaCertificatesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. Call the [ListSites](~~ListSites~~) operation to obtain this ID.
    * 
    * This parameter is required.
    * 

package/src/models/ListClientCaCertificatesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name.
    * 
    * @example
    * www.example.com
@@ -13,12 +13,19 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   commonName?: string;
   /**
    * @remarks
-   * The time when the certificate was created.
+   * The time when the certificate was added.
    * 
    * @example
    * 2024-06-24 07:48:51
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The SHA-256 fingerprint.
+   * 
+   * @example
+   * 1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****
+   */
   fingerprintSha256?: string;
   /**
    * @remarks
@@ -30,7 +37,7 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The CA that issued the certificate.
+   * The issuer of the certificate.
    * 
    * @example
    * GlobalSign nv-sa
@@ -46,7 +53,7 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The date and time when the certificate expires.
    * 
    * @example
    * 2024-03-31 02:08:00
@@ -54,7 +61,7 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The date and time when the certificate becomes valid.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -62,7 +69,7 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   notBefore?: string;
   /**
    * @remarks
-   * The public-key algorithm of the certificate.
+   * The algorithm of the certificate\\"s public key.
    * 
    * @example
    * RSA
@@ -70,16 +77,23 @@ export class ListClientCaCertificatesResponseBodyResult extends $dara.Model {
   pubkeyAlgorithm?: string;
   /**
    * @remarks
-   * The Subject Alternative Name (SAN) of the certificate.
+   * The subject alternative names (SANs) of the certificate.
    * 
    * @example
    * www.example.com,*.example.com
    */
   SAN?: string;
+  /**
+   * @remarks
+   * The unique serial number assigned by the issuer.
+   * 
+   * @example
+   * babab022c5e9b27bf9c64d7f4b16****
+   */
   serialNumber?: string;
   /**
    * @remarks
-   * The signature algorithm of the certificate.
+   * The algorithm used to sign the certificate.
    * 
    * @example
    * SHA256-RSA
@@ -103,7 +117,7 @@ export class ListClientCaCertificatesResponseBodyResult 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
@@ -185,12 +199,12 @@ export class ListClientCaCertificatesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried client CA certificates.
+   * A list of client CA certificates.
    */
   result?: ListClientCaCertificatesResponseBodyResult[];
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * @example
    * 1234567890123
@@ -198,7 +212,7 @@ export class ListClientCaCertificatesResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com

package/src/models/ListClientCertificatesRequest.ts

@@ -21,7 +21,7 @@ export class ListClientCertificatesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * This parameter is required.
    *