@alicloud/cas20200407 3.2.8 → 3.2.9

package/src/models/ListInstancesResponseBody.ts

@@ -4,114 +4,221 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListInstancesResponseBodyInstanceList extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether automatic managed renewal is enabled. Valid values:
+   * - enable: enabled.
+   * - disable: disabled.
+   * 
    * @example
    * enable
    */
   autoReissue?: string;
   /**
+   * @remarks
+   * The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.
+   * 
    * @example
    * DigiCert
    */
   brand?: string;
   /**
+   * @remarks
+   * The global certificate ID in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services.
+   * - For the China site: certificate ID + "-cn-hangzhou"
+   * - For the China site: certificate ID + "-ap-southeast-1"
+   * 
+   * For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the China site is "123-ap-southeast-1".
+   * 
    * @example
    * 21795675-cn-hangzhou
    */
   certIdentifier?: string;
+  /**
+   * @remarks
+   * The domain name of the latest issued certificate.
+   * 
+   * @example
+   * abc.com,www.abc.com
+   */
   certificateDomain?: string;
   /**
+   * @remarks
+   * The certificate ID.
+   * 
    * @example
    * 18541349
    */
   certificateId?: number;
   /**
+   * @remarks
+   * The certificate name.
+   * 
    * @example
    * cert-13216408
    */
   certificateName?: string;
   /**
+   * @remarks
+   * The end time of the latest certificate, in UNIX timestamp format. If no certificate has been issued, this value is empty.
+   * 
    * @example
    * 1801324800000
    */
   certificateNotAfter?: number;
+  certificateNotBefore?: number;
   /**
+   * @remarks
+   * The revocation time of the latest certificate, in UNIX timestamp format.
+   * 
    * @example
    * 1801324800000
    */
   certificateRevokeTime?: number;
   /**
+   * @remarks
+   * The status of the certificate. Valid values:
+   * - **issued**: issued.
+   * - **revoked**: revoked.
+   * - **willExpire**: about to expire.
+   * - **expired**: expired.
+   * 
    * @example
    * issued
    */
   certificateStatus?: string;
   /**
+   * @remarks
+   * The type of the certificate. Valid values: DV, OV, and EV.
+   * 
    * @example
    * DV
    */
   certificateType?: string;
   /**
+   * @remarks
+   * The domain name bound to the certificate.
+   * 
    * @example
    * test.com
    */
   domain?: string;
   /**
+   * @remarks
+   * The number of exact-match domain names.
+   * 
    * @example
    * 1
    */
   fullDomainCount?: number;
   /**
+   * @remarks
+   * The expiration time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.
+   * 
    * @example
    * 1801324800000
    */
   instanceEndTime?: number;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * cas_dv-cn-123
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The start time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.
+   * 
    * @example
    * 1801324800000
    */
   instanceStartTime?: number;
   /**
+   * @remarks
+   * The instance type. Valid values: BUY (official certificate) and TEST (test certificate).
+   * 
    * @example
    * BUY
    */
   instanceType?: string;
   /**
+   * @remarks
+   * The certificate algorithm. Default value: RSA_2048. Valid values:
+   * - **RSA_2048**
+   * - **RSA_3072**
+   * - **RSA_4096**
+   * - **ECC_256**
+   * - **SM2**.
+   * 
    * @example
    * RSA_2048
    */
   keyAlgorithm?: string;
   /**
+   * @remarks
+   * The end time of the instance purchase, in UNIX timestamp format. This value is used to determine the purchase duration of the instance.
+   * 
    * @example
    * 1801324800000
    */
   orderEndTime?: number;
   /**
+   * @remarks
+   * The start time of the instance purchase, in UNIX timestamp format. This value is used to determine the refund time limit.
+   * 
    * @example
    * 1801324800000
    */
   orderStartTime?: number;
   /**
+   * @remarks
+   * The result returned by the CA during the last certificate operation.
+   * 
    * @example
    * pending
    */
   pendingResult?: string;
+  /**
+   * @remarks
+   * The resource group ID.
+   * 
+   * @example
+   * 123
+   */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * The purchased instance specification.
+   * 
    * @example
    * ss.dv.t
    */
   spec?: string;
   /**
+   * @remarks
+   * The instance status. Valid values:
+   * - **inactive**: pending use.
+   * - **pending**: under review. The latest certificate is being reviewed.
+   * - **willExpire**: about to expire.
+   * - **expired**: expired.
+   * - **refund**: refunded.
+   * - **normal**: normal.
+   * - **closed**: closed and unavailable.
+   * 
    * @example
    * inactive
    */
   status?: string;
+  /**
+   * @remarks
+   * The list of cloud services to which the latest certificate is deployed.
+   */
   usingProductList?: string[];
   /**
+   * @remarks
+   * The number of wildcard domain names.
+   * 
    * @example
    * 0
    */
@@ -125,6 +232,7 @@ export class ListInstancesResponseBodyInstanceList extends $dara.Model {
       certificateId: 'CertificateId',
       certificateName: 'CertificateName',
       certificateNotAfter: 'CertificateNotAfter',
+      certificateNotBefore: 'CertificateNotBefore',
       certificateRevokeTime: 'CertificateRevokeTime',
       certificateStatus: 'CertificateStatus',
       certificateType: 'CertificateType',
@@ -155,6 +263,7 @@ export class ListInstancesResponseBodyInstanceList extends $dara.Model {
       certificateId: 'number',
       certificateName: 'string',
       certificateNotAfter: 'number',
+      certificateNotBefore: 'number',
       certificateRevokeTime: 'number',
       certificateStatus: 'string',
       certificateType: 'string',
@@ -190,22 +299,38 @@ export class ListInstancesResponseBodyInstanceList extends $dara.Model {
 
 export class ListInstancesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The current page number in a paged query.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * The list of instances.
+   */
   instanceList?: ListInstancesResponseBodyInstanceList[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 12345678-1234-1234-1234-123456789ABC
    */
   requestId?: string;
   /**
+   * @remarks
+   * The number of records per page.
+   * 
    * @example
    * 20
    */
   showSize?: number;
   /**
+   * @remarks
+   * The total number of instances.
+   * 
    * @example
    * 12
    */

package/src/models/ListUserCertificateOrderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserCertificateOrderRequest extends $dara.Model {
   /**
    * @remarks
-   * The number of the page to return.
+   * The page number. Default value: 1.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListUserCertificateOrderRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The domain name that is bound or the ID of the resource. Fuzzy match is supported.
+   * Performs a fuzzy query. The keyword can be a domain name or a resource ID.
    * 
    * @example
    * cert-instanceId
@@ -21,12 +21,15 @@ export class ListUserCertificateOrderRequest extends $dara.Model {
   keyword?: string;
   /**
    * @remarks
-   * The type of the order. Default value: **CPACK**. Valid values:
+   * The resource type. Default value: **CPACK**. Valid values:
    * 
-   * *   **CPACK**: virtual resource order. If you set OrderType to CPACK, only the information about orders that are generated to consume the certificate quota is returned.
-   * *   **BUY**: purchase order. If you set OrderType to BUY, only the information about purchase orders is returned. In most cases, this type of order can be ignored.
-   * *   **UPLOAD**: uploaded certificate. If you set OrderType to UPLOAD, only uploaded certificates are returned.
-   * *   **CERT**: certificate. If you set OrderType to CERT, both issued certificates and uploaded certificates are returned.
+   * - **CPACK**: An order for a resource plan. Only orders created from a resource plan are returned.
+   * 
+   * - **BUY**: A direct purchase. Only orders created from direct purchases are returned. You can ignore this type in most cases.
+   * 
+   * - **UPLOAD**: An uploaded certificate. Only uploaded certificates are returned.
+   * 
+   * - **CERT**: A certificate. Both issued and uploaded certificates are returned.
    * 
    * @example
    * CPACK
@@ -34,7 +37,7 @@ export class ListUserCertificateOrderRequest extends $dara.Model {
   orderType?: string;
   /**
    * @remarks
-   * The ID of the resource group. You can call the [ListResources](https://help.aliyun.com/document_detail/2716559.html) operation to obtain the ID.
+   * The ID of the resource group. For more information, see [ListResources](https://help.aliyun.com/document_detail/2716559.html).
    * 
    * @example
    * rg-ae******4wia
@@ -50,18 +53,25 @@ export class ListUserCertificateOrderRequest extends $dara.Model {
   showSize?: number;
   /**
    * @remarks
-   * The certificate status of the order. Valid values:
-   * 
-   * *   **PAYED**: pending application. You can set Status to PAYED only if you set OrderType to CPACK or BUY.
-   * *   **CHECKING**: validating. You can set Status to CHECKING only if you set OrderType to CPACK or BUY.
-   * *   **CHECKED_FAIL**: validation failed. You can set Status to CHECKED_FAIL only if you set OrderType to CPACK or BUY.
-   * *   **ISSUED**: issued.
-   * *   **WILLEXPIRED**: about to expire.
-   * *   **EXPIRED**: expired.
-   * *   **NOTACTIVATED**: not activated. You can set Status to NOTACTIVATED only if you set OrderType to CPACK or BUY.
-   * *   **REVOKED**: revoked. You can set Status to REVOKED only if you set OrderType to CPACK or BUY.
-   * 
-   * If you set OrderType to CERT or UPLOAD and Status is left empty, valid certificates are returned by default, including issued certificates and certificates that are about to expire. If you set OrderType to CPACK or BUY and Status is left empty, all orders are returned by default.
+   * The status of the order. Valid values:
+   * 
+   * - **PAYED**: The certificate is pending application. This value is valid only when OrderType is set to CPACK or BUY.
+   * 
+   * - **CHECKING**: The certificate is under review. This value is valid only when OrderType is set to CPACK or BUY.
+   * 
+   * - **CHECKED_FAIL**: The review failed. This value is valid only when OrderType is set to CPACK or BUY.
+   * 
+   * - **ISSUED**: The certificate is issued.
+   * 
+   * - **WILLEXPIRED**: The certificate is about to expire.
+   * 
+   * - **EXPIRED**: The certificate has expired.
+   * 
+   * - **NOTACTIVATED**: The certificate is not activated. This value is valid only when OrderType is set to CPACK or BUY.
+   * 
+   * - **REVOKED**: The certificate is revoked. This value is valid only when OrderType is set to CPACK or BUY.
+   * 
+   * If OrderType is CERT or UPLOAD and you leave this parameter empty, active certificates are returned by default. Active certificates are those in the ISSUED or WILLEXPIRED state. If OrderType is CPACK or BUY and you leave this parameter empty, all orders are returned by default.
    * 
    * @example
    * ISSUED