@alicloud/cas20200407 3.2.7 → 3.2.9

package/src/models/EncryptRequest.ts

@@ -7,9 +7,11 @@ export class EncryptRequest extends $dara.Model {
    * @remarks
    * The encryption algorithm. Valid values:
    * 
-   * *   **RSAES_OAEP_SHA_1**
-   * *   **RSAES_OAEP_SHA_256**
-   * *   **SM2PKE**
+   * - **RSAES_OAEP_SHA_1**
+   * 
+   * - **RSAES_OAEP_SHA_256**
+   * 
+   * - **SM2PKE**
    * 
    * This parameter is required.
    * 
@@ -19,22 +21,31 @@ export class EncryptRequest extends $dara.Model {
   algorithm?: string;
   /**
    * @remarks
-   * The unique identifier of the certificate. You can call the [ListCert](https://help.aliyun.com/document_detail/455806.html) operation to obtain the identifier.
+   * The unique identifier of the certificate. To obtain this parameter, call the [ListCert](https://help.aliyun.com/document_detail/455806.html) operation.
+   * 
+   * - The identifier of an SSL certificate is usually in the {Certificate ID}-cn-hangzhou format.
    * 
-   * *   If the certificate is an SSL certificate, the value of this parameter must be in the {Certificate ID}-cn-hangzhou format.
-   * *   If the certificate is a private certificate, the value of this parameter must be the value of the Identifier field for the private certificate.
+   * - For a private certificate authority (PCA) certificate, this is the value of the Identifier field of the private certificate.
    * 
    * @example
-   * 12345678-1234-1234-1234-12345678****
+   * 1ef1da5f-38ed-69b3-****-037781890265
    */
   certIdentifier?: string;
+  /**
+   * @remarks
+   * The custom identifier, which serves as a unique key.
+   * 
+   * @example
+   * ****6bb538d538c70c01f81dg3****
+   */
   customIdentifier?: string;
   /**
    * @remarks
-   * The value type of the Message parameter. Valid values:
+   * The message type. Valid values:
+   * 
+   * - RAW (default): Directly encrypts the value of Plaintext.
    * 
-   * *   RAW: The value of the Plaintext parameter is directly encrypted. This is the default value.
-   * *   Base64: The value of the Plaintext parameter is Base64-encoded data. The data is decoded and then encrypted.
+   * - Base64: Decodes the Base64-encoded value of Plaintext and then encrypts the decoded data.
    * 
    * @example
    * RAW
@@ -42,11 +53,13 @@ export class EncryptRequest extends $dara.Model {
   messageType?: string;
   /**
    * @remarks
-   * The data that you want to encrypt. The value of this parameter can be raw data or Base64-encoded data. For more information, see the description of the MessageType parameter. For example, if the hexadecimal data that you want to encrypt is `[0x31, 0x32, 0x33, 0x34]`, the Base64-encoded data is MTIzNA==. The size of data that can be encrypted varies based on the encryption algorithm that you use. The following list describes the relationship between the encryption algorithms and data sizes:
+   * The data to encrypt. The data can be plaintext or Base64-encoded plaintext. For more information, see the MessageType parameter. If you use Base64 encoding, for example, if the hexadecimal content of the data to be encrypted is `[0x31, 0x32, 0x33, 0x34]`, the corresponding Base64-encoded string is MTIzNA==. The maximum size of Plaintext depends on the Algorithm:
    * 
-   * *   **RSAES_OAEP_SHA_1**: 214 bytes
-   * *   **RSAES_OAEP_SHA_256**: 190 bytes
-   * *   **SM2PKE**: 6,047 bytes
+   * - **RSAES_OAEP_SHA_1**: 214 bytes.
+   * 
+   * - **RSAES_OAEP_SHA_256**: 190 bytes.
+   * 
+   * - **SM2PKE**: 6047 bytes.
    * 
    * This parameter is required.
    * 
@@ -54,6 +67,15 @@ export class EncryptRequest extends $dara.Model {
    * 1234***
    */
   plaintext?: string;
+  /**
+   * @remarks
+   * The repository ID.
+   * 
+   * > To obtain this ID, call the [ListCertWarehouse](https://help.aliyun.com/document_detail/455805.html) operation.
+   * 
+   * @example
+   * 12
+   */
   warehouseId?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/EncryptResponseBody.ts

@@ -8,12 +8,12 @@ export class EncryptResponseBody extends $dara.Model {
    * The unique identifier of the certificate.
    * 
    * @example
-   * 12345678-1234-1234-1234-12345678****
+   * 1ef1da5f-38ed-69b3-****-037781890265
    */
   certIdentifier?: string;
   /**
    * @remarks
-   * The data after encryption. The value is encoded in Base64.
+   * The encrypted data. The data is Base64-encoded.
    * 
    * @example
    * ZOyIygCyaOW6Gj****MlNKiuyjfzw=
@@ -21,7 +21,7 @@ export class EncryptResponseBody extends $dara.Model {
   ciphertextBlob?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5979d897-d69f-4fc9-87dd-f3bb73c40b80

package/src/models/GetAssetCountResponseBody.ts

@@ -3,22 +3,109 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetAssetCountResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Total number of Alibaba Cloud resources.
+   * 
+   * @example
+   * 10
+   */
   aliyunAssetCount?: number;
+  /**
+   * @remarks
+   * Total number of Amazon Cloud resources.
+   * 
+   * @example
+   * 10
+   */
   awsAssetCount?: number;
+  /**
+   * @remarks
+   * Number of paid certificates.
+   * 
+   * @example
+   * 10
+   */
   buyCertificateCount?: number;
+  /**
+   * @remarks
+   * Total number of Domain Name resources.
+   * 
+   * @example
+   * 10
+   */
   domainAssetCount?: number;
+  /**
+   * @remarks
+   * Number of free certificates.
+   * 
+   * @example
+   * 10
+   */
   freeCertificateCount?: number;
+  /**
+   * @remarks
+   * Total number of Huawei Cloud resources.
+   * 
+   * @example
+   * 10
+   */
   huaweiAssetCount?: number;
+  /**
+   * @remarks
+   * Last health score.
+   * 
+   * @example
+   * 60
+   */
   lastPoint?: number;
+  /**
+   * @remarks
+   * Generated perspective.
+   * 
+   * @example
+   * 50
+   */
   point?: number;
+  /**
+   * @remarks
+   * Health score ratio.
+   * 
+   * @example
+   * 1
+   */
   pointRatio?: number;
+  /**
+   * @remarks
+   * Health score update time.
+   * 
+   * @example
+   * 1767681210879
+   */
   pointTime?: number;
   /**
+   * @remarks
+   * This ID is a unique identifier generated by Alibaba Cloud for the request. Use it to troubleshoot and locate issues.
+   * 
    * @example
    * EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Total number of Tencent Cloud resources.
+   * 
+   * @example
+   * 10
+   */
   tencentAssetCount?: number;
+  /**
+   * @remarks
+   * Number of uploaded certificates.
+   * 
+   * @example
+   * 10
+   */
   uploadCertificateCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetCertWarehouseQuotaResponseBody.ts

@@ -3,11 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetCertWarehouseQuotaResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The total quota for the certificate application service. This includes both complimentary and purchased quotas.
+   * 
+   * @example
+   * 5000
+   */
   appTotalQuota?: number;
+  /**
+   * @remarks
+   * The used quota for the certificate application service.
+   * 
+   * @example
+   * 1000
+   */
   appUseCount?: number;
   /**
    * @remarks
-   * The ID of the request, which is used to locate and troubleshoot issues.
+   * The request ID. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.
    * 
    * @example
    * CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
@@ -15,7 +29,7 @@ export class GetCertWarehouseQuotaResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total quota for certificate repositories, including the free quota and purchased quota.
+   * The total quota for the electronic contract signing service. This includes both complimentary and purchased quotas.
    * 
    * @example
    * 5000
@@ -23,7 +37,7 @@ export class GetCertWarehouseQuotaResponseBody extends $dara.Model {
   totalQuota?: number;
   /**
    * @remarks
-   * The used quota.
+   * The used quota for the electronic contract signing service.
    * 
    * @example
    * 1000

package/src/models/GetCertificateDetailRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetCertificateDetailRequest extends $dara.Model {
   /**
    * @remarks
+   * The certificate ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetCertificateDetailResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCertificateDetailResponseBodyCertificateChainList extends $dara.Model {
   /**
+   * @remarks
+   * The issuer of the certificate chain.
+   * 
    * @example
    * Digicert
    */
   issuer?: string;
   /**
+   * @remarks
+   * The end of the validity period.
+   * 
    * @example
    * 17326613180000
    */
   notAfter?: number;
   /**
+   * @remarks
+   * The beginning of the validity period.
+   * 
    * @example
    * 17321613180000
    */
   notBefore?: number;
   /**
+   * @remarks
+   * The remaining validity period of the certificate chain.
+   * 
    * @example
    * 10
    */
   remainDay?: number;
   /**
+   * @remarks
+   * The common name of the certificate chain.
+   * 
    * @example
    * Digicert
    */
@@ -59,11 +74,19 @@ export class GetCertificateDetailResponseBodyCertificateChainList extends $dara.
 
 export class GetCertificateDetailResponseBodyTags extends $dara.Model {
   /**
+   * @remarks
+   * The tag key of the instance. You can specify 1 to 20 tag keys. The value cannot be an empty string.
+   * 
+   * The value can be up to 64 characters in length, cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
+   * 
    * @example
    * test
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * test
    */
@@ -93,95 +116,209 @@ export class GetCertificateDetailResponseBodyTags extends $dara.Model {
 
 export class GetCertificateDetailResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The certificate algorithm. Valid values:
+   * 
+   * - **RSA**: The RSA algorithm.
+   * 
+   * - **ECC**: The ECC algorithm.
+   * 
+   * - **SM2**: The SM2 algorithm.
+   * 
    * @example
    * RSA
    */
   algorithm?: string;
   /**
+   * @remarks
+   * The global ID of the certificate, which is used in various Alibaba Cloud services. The format of the ID is `<Certificate ID>-<Region ID>`. The region ID is `cn-hangzhou` for the China site and `ap-southeast-1` for the International site. For example, if a certificate ID is `123`, its `CertIdentifier` is `123-cn-hangzhou` for the China site and `123-ap-southeast-1` for the International site.
+   * 
    * @example
    * 21912069-cn-hangzhou
    */
   certIdentifier?: string;
+  /**
+   * @remarks
+   * The information about the certificate chain.
+   */
   certificateChainList?: GetCertificateDetailResponseBodyCertificateChainList[];
   /**
+   * @remarks
+   * The certificate ID.
+   * 
    * @example
    * 22559621
    */
   certificateId?: number;
   /**
+   * @remarks
+   * The certificate name.
+   * 
    * @example
    * 123
    */
   certificateName?: string;
   /**
+   * @remarks
+   * The source of the certificate. Valid values:
+   * 
+   * - **BUY**: a purchased certificate.
+   * 
+   * - **TEST**: a test certificate.
+   * 
+   * - Upload the certificate.
+   * 
    * @example
    * BUY
    */
   certificateSource?: string;
   /**
+   * @remarks
+   * The status of the certificate. Valid values:
+   * 
+   * - **issued**: The certificate is issued.
+   * 
+   * - **revoked**: The certificate is revoked.
+   * 
+   * - **willExpire**: The certificate is about to expire.
+   * 
+   * - **expired**: The certificate has expired.
+   * 
    * @example
    * issued
    */
   certificateStatus?: string;
   /**
+   * @remarks
+   * The common name.
+   * 
    * @example
    * www.example.com
    */
   commonName?: string;
+  /**
+   * @remarks
+   * The ID of the company profile that is associated with the certificate application. This parameter is empty for DV certificates.
+   * 
+   * @example
+   * 44211
+   */
   companyId?: number;
+  /**
+   * @remarks
+   * The ID of the contact.
+   * 
+   * @example
+   * 304066
+   */
   contactId?: number;
   /**
+   * @example
+   * -----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
+   */
+  csr?: string;
+  /**
+   * @remarks
+   * The domain names that are bound to the certificate. Multiple domain names are separated by commas (,).
+   * 
    * @example
    * aliyundoc.com,example.aliyundoc.com
    */
   domain?: string;
   /**
+   * @remarks
+   * Indicates whether a private key is available. Valid values:
+   * 
+   * - **true**
+   * 
+   * - **false**
+   * 
    * @example
    * true
    */
   existPrivateKey?: boolean;
   /**
+   * @remarks
+   * The fingerprint of the public key.
+   * 
    * @example
    * 123
    */
   fingerPrint?: string;
   /**
+   * @remarks
+   * The ID of the instance.
+   * 
    * @example
    * cas_dv-cn-123
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The issuer of the certificate.
+   * 
    * @example
    * Digicert
    */
   issuer?: string;
   /**
+   * @remarks
+   * The key size.
+   * 
+   * - For RSA algorithms, the key size is typically 2,048, 3,072, or 4,096 bits.
+   * 
+   * - For ECC and SM2 algorithms, the key size is typically 256 bits.
+   * 
    * @example
    * 2048
    */
   keySize?: number;
   /**
+   * @remarks
+   * The end of the validity period of the certificate.
+   * 
    * @example
    * 17326613180000
    */
   notAfter?: number;
   /**
+   * @remarks
+   * The beginning of the validity period of the certificate.
+   * 
    * @example
    * 17321613180000
    */
   notBefore?: number;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 5979d897-d69f-4fc9-87dd-f3bb73c40b80
    */
   requestId?: string;
   /**
+   * @remarks
+   * The serial number of the certificate.
+   * 
    * @example
    * 123
    */
   serial?: string;
+  /**
+   * @remarks
+   * The subject alternative names (SANs) of the certificate.
+   */
   subjectAlternativeNames?: string[];
+  /**
+   * @remarks
+   * The list of tags.
+   */
   tags?: GetCertificateDetailResponseBodyTags[];
+  /**
+   * @remarks
+   * The list of cloud services in which the certificate is deployed.
+   */
   usingProductList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -195,6 +332,7 @@ export class GetCertificateDetailResponseBody extends $dara.Model {
       commonName: 'CommonName',
       companyId: 'CompanyId',
       contactId: 'ContactId',
+      csr: 'Csr',
       domain: 'Domain',
       existPrivateKey: 'ExistPrivateKey',
       fingerPrint: 'FingerPrint',
@@ -223,6 +361,7 @@ export class GetCertificateDetailResponseBody extends $dara.Model {
       commonName: 'string',
       companyId: 'number',
       contactId: 'number',
+      csr: 'string',
       domain: 'string',
       existPrivateKey: 'boolean',
       fingerPrint: 'string',

package/src/models/GetInstanceDetailRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetInstanceDetailRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example