@alicloud/cas20200407 3.2.8 → 3.2.9

package/src/models/GetInstanceSummaryRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetInstanceSummaryRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance type. Valid values: BUY: a paid certificate. TEST: a test certificate.
+   * 
    * @example
    * TEST
    */

package/src/models/GetInstanceSummaryResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetInstanceSummaryResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The remaining quota for automatic reissue.
+   * 
    * @example
    * 1
    */
   autoReissueCount?: number;
   /**
+   * @remarks
+   * The remaining certificate quota.
+   * 
    * @example
    * 1
    */
   certificateCount?: number;
   /**
+   * @remarks
+   * The total number of inactive instances.
+   * 
    * @example
    * 1
    */
   inactiveCount?: number;
   /**
+   * @remarks
+   * The unique ID of the request. You can use this ID to troubleshoot issues.
+   * 
    * @example
    * 09470F19-CEE8-5C63-BF2C-02B5E3F07A17
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of instances.
+   * 
    * @example
    * 10
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The total number of instances that are about to expire.
+   * 
    * @example
    * 1
    */

package/src/models/GetMatchedResourcesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetMatchedResourcesRequest extends $dara.Model {
   /**
    * @remarks
+   * The certificate IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,15 +14,28 @@ export class GetMatchedResourcesRequest extends $dara.Model {
    */
   certIds?: string;
   /**
+   * @remarks
+   * Because of the large number of matched resources, the backend uses aggregation and does not support pagination. This parameter is reserved. By default, a maximum of 2,000 entries are returned.
+   * 
    * @example
    * 2000
    */
   maxResults?: number;
   /**
+   * @remarks
+   * Because of the large number of matched resources, the backend uses aggregation and does not support pagination. This parameter is reserved.
+   * 
    * @example
    * 666
    */
   nextToken?: string;
+  /**
+   * @remarks
+   * The resource match scope. This parameter can be empty.
+   * 
+   * @example
+   * 目前支持全部云产品
+   */
   resourceScope?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetMatchedResourcesResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetMatchedResourcesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * 请求接口返回的数据。
+   * 
    * @example
    * []
    */
   data?: any;
   /**
+   * @remarks
+   * 分页参数：结果集的最大数量，默认值为 20。
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * 下一个查询开始 Token，NextToken 为空说明没有下一个。
+   * 
    * @example
    * 1d2db86sca4384811e0b5e8707e68181f
    */
   nextToken?: string;
   /**
+   * @remarks
+   * 本次请求的 ID。
+   * 
    * @example
    * 26F62CED-1E0E-51AA-B8EB-BCD61C5B0C50
    */

package/src/models/GetRiskCountResponseBody.ts

@@ -3,28 +3,157 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetRiskCountResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Number of expired Alibaba Cloud certificates.
+   * 
+   * @example
+   * 10
+   */
   aliyunAssetCertificateExpiredCount?: number;
+  /**
+   * @remarks
+   * Number of Alibaba Cloud certificates that will expire soon.
+   * 
+   * @example
+   * 10
+   */
   aliyunAssetCertificateWillExpiredCount?: number;
+  /**
+   * @remarks
+   * Number of expired paid certificates.
+   * 
+   * @example
+   * 10
+   */
   buyCertificateExpireCount?: number;
+  /**
+   * @remarks
+   * Number of paid certificates not deployed.
+   * 
+   * @example
+   * 10
+   */
   buyCertificateNotDeploymentCount?: number;
+  /**
+   * @remarks
+   * Number of paid certificates not managed.
+   * 
+   * @example
+   * 10
+   */
   buyCertificateNotTrusteeCount?: number;
+  /**
+   * @remarks
+   * Number of paid certificates that will expire soon.
+   * 
+   * @example
+   * 10
+   */
   buyCertificateWillExpiredCount?: number;
+  /**
+   * @remarks
+   * Number of failed paid certificate orders.
+   * 
+   * @example
+   * 10
+   */
   buyCheckedFailCount?: number;
+  /**
+   * @remarks
+   * Number of domains without monitoring configured.
+   * 
+   * @example
+   * 10
+   */
   domainAssetNotMonitorCount?: number;
+  /**
+   * @remarks
+   * Number of expired free certificates.
+   * 
+   * @example
+   * 10
+   */
   freeCertificateExpireCount?: number;
+  /**
+   * @remarks
+   * Number of free certificates not deployed.
+   * 
+   * @example
+   * 10
+   */
   freeCertificateNotDeploymentCount?: number;
+  /**
+   * @remarks
+   * Number of free certificates that will expire soon.
+   * 
+   * @example
+   * 10
+   */
   freeCertificateWillExpiredCount?: number;
+  /**
+   * @remarks
+   * Number of failed free certificate orders.
+   * 
+   * @example
+   * 10
+   */
   freeCheckedFailCount?: number;
+  /**
+   * @remarks
+   * Number of expired multicloud certificates.
+   * 
+   * @example
+   * 10
+   */
   multiCloudAssetCertificateExpiredCount?: number;
+  /**
+   * @remarks
+   * Number of multicloud certificates that will expire soon.
+   * 
+   * @example
+   * 10
+   */
   multiCloudAssetCertificateWillExpiredCount?: number;
   /**
+   * @remarks
+   * The ID of this API call. Alibaba Cloud generates this unique identifier for each request. Use it to troubleshoot and locate issues.
+   * 
    * @example
    * 5BCD2F6C-7A9D-47C1-8588-2CC6A4E0BE5E
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Number of expired uploaded certificates.
+   * 
+   * @example
+   * 10
+   */
   uploadCertificateExpireCount?: number;
+  /**
+   * @remarks
+   * Number of uploaded certificates not deployed.
+   * 
+   * @example
+   * 10
+   */
   uploadCertificateNotDeploymentCount?: number;
+  /**
+   * @remarks
+   * Number of uploaded certificates without alerting configured.
+   * 
+   * @example
+   * 10
+   */
   uploadCertificateNotNoticeCount?: number;
+  /**
+   * @remarks
+   * Number of uploaded certificates that will expire soon.
+   * 
+   * @example
+   * 10
+   */
   uploadCertificateWillExpiredCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/GetTaskAttributeRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetTaskAttributeRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the task.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,9 @@ export class GetTaskAttributeRequest extends $dara.Model {
    */
   taskId?: string;
   /**
+   * @remarks
+   * The type of the asynchronous task. The default value is ApplyCertificate, which specifies a query for the result of a certificate application.
+   * 
    * @example
    * ApplyCertificate
    */

package/src/models/GetTaskAttributeResponseBody.ts

@@ -4,16 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetTaskAttributeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID of the request. Alibaba Cloud generates this ID for each request. Use this ID to troubleshoot issues.
+   * 
    * @example
    * CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
    */
   requestId?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * error
    */
   taskMessage?: string;
   /**
+   * @remarks
+   * The result of the task.
+   * 
+   * - success: The submission is successful.
+   * 
+   * - processing: The submission is in progress.
+   * 
+   * - failed: The submission failed.
+   * 
    * @example
    * success
    */

package/src/models/GetUserCertificateDetailRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetUserCertificateDetailRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to filter return results. Valid values: true and false. Default value: false. **true** specifies that the Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey parameters are not returned. **false** specifies that the parameters are returned.
+   * Specifies whether to filter the certificate content from the response. Valid values: **true**: The Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey parameters are not returned. **false** (default): All parameters are returned.
    * 
    * @example
    * false
@@ -13,9 +13,7 @@ export class GetUserCertificateDetailRequest extends $dara.Model {
   certFilter?: boolean;
   /**
    * @remarks
-   * The ID of the certificate.
-   * 
-   * >  You can call the [ListUserCertificateOrder](https://help.aliyun.com/document_detail/455804.html) operation to query the ID.
+   * The ID of the certificate. To get this ID, call the [ListUserCertificateOrder](https://help.aliyun.com/document_detail/455804.html) operation.
    * 
    * This parameter is required.
    * 

package/src/models/GetUserCertificateDetailResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetUserCertificateDetailResponseBodyCertChain extends $dara.Model {
   /**
    * @remarks
-   * The common name of the certificate.
+   * The common name of the certificate in the chain.
    * 
    * @example
    * test
@@ -21,23 +21,23 @@ export class GetUserCertificateDetailResponseBodyCertChain extends $dara.Model {
   issuerCommonName?: string;
   /**
    * @remarks
-   * The end of the validity period of the certificate.
+   * The expiration date of the certificate in the chain.
    * 
    * @example
-   * 17322613180000
+   * 17352613180000
    */
   notAfter?: number;
   /**
    * @remarks
-   * The beginning of the validity period of the certificate.
+   * The issuance date of the certificate in the chain.
    * 
    * @example
-   * 17302633180000
+   * 17322633180000
    */
   notBefore?: number;
   /**
    * @remarks
-   * The remaining days of the certificate validity period.
+   * The number of days until the certificate in the chain expires.
    * 
    * @example
    * 1000
@@ -73,7 +73,21 @@ export class GetUserCertificateDetailResponseBodyCertChain extends $dara.Model {
 }
 
 export class GetUserCertificateDetailResponseBodyTags extends $dara.Model {
+  /**
+   * @remarks
+   * The key of the tag.
+   * 
+   * @example
+   * test
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * The value of the tag.
+   * 
+   * @example
+   * test
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -101,7 +115,7 @@ export class GetUserCertificateDetailResponseBodyTags extends $dara.Model {
 export class GetUserCertificateDetailResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The algorithm.
+   * The algorithm of the certificate.
    * 
    * @example
    * RSA
@@ -111,8 +125,9 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the certificate was purchased from Alibaba Cloud. Valid values:
    * 
-   * *   **true**: yes
-   * *   **false**: no
+   * - **true**: Yes
+   * 
+   * - **false**: No
    * 
    * @example
    * true
@@ -120,7 +135,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   buyInAliyun?: boolean;
   /**
    * @remarks
-   * The content of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The content of the certificate that does not use a Chinese cryptographic algorithm. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * ---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----
@@ -128,21 +143,21 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   cert?: string;
   /**
    * @remarks
-   * The certificate chain.
+   * The information about the certificate chain.
    */
   certChain?: GetUserCertificateDetailResponseBodyCertChain[];
   /**
    * @remarks
-   * The certificate identifier. The value is in the "Certificate ID-cn-hangzhou" format. For example, if the ID of the certificate is 123, the value of CertIdentifier is 123-cn-hangzhou.
+   * The certificate ID followed by "-cn-hangzhou". For example, if the certificate ID is 123, the value of CertIdentifier is "123-cn-hangzhou".
    * 
    * @example
-   * 10741304-cn-hangzhou
+   * 13781326-cn-hangzhou
    */
   certIdentifier?: string;
   certSha2?: string;
   /**
    * @remarks
-   * The city of the company or organization to which the certificate purchaser belongs.
+   * The city where the company or organization of the certificate purchaser is located.
    * 
    * @example
    * hangzhou
@@ -158,7 +173,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   common?: string;
   /**
    * @remarks
-   * The country or region of the company or organization to which the certificate purchaser belongs.
+   * The country where the company or organization of the certificate purchaser is located.
    * 
    * @example
    * CN
@@ -166,7 +181,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   country?: string;
   /**
    * @remarks
-   * The content of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The content of the encryption certificate that uses a Chinese cryptographic algorithm. The certificate is in PEM format. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * -----BEGIN CERTIFICATE-----
@@ -176,7 +191,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   encryptCert?: string;
   /**
    * @remarks
-   * The private key of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The private key of the encryption certificate that uses a Chinese cryptographic algorithm. The private key is in PEM format. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * -----BEGIN EC PRIVATE KEY-----
@@ -196,8 +211,9 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the certificate has expired. Valid values:
    * 
-   * *   **true**: yes
-   * *   **false**: no
+   * - **true**: The certificate has expired.
+   * 
+   * - **false**: The certificate has not expired.
    * 
    * @example
    * true
@@ -221,15 +237,15 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The instance ID of the resource.
+   * The ID of the resource instance.
    * 
    * @example
-   * cas-upload-50yf1q
+   * cas-ivauto-hqito6
    */
   instanceId?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The certification authority (CA) that issued the certificate.
    * 
    * @example
    * Digicert
@@ -237,7 +253,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   issuer?: string;
   /**
    * @remarks
-   * The private key of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The private key of the certificate that does not use a Chinese cryptographic algorithm. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * -----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----
@@ -253,23 +269,23 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The end of the validity period of the certificate.
+   * The end time of the validity period of the certificate.
    * 
    * @example
-   * 17322613180000
+   * 17326613180000
    */
   notAfter?: number;
   /**
    * @remarks
-   * The beginning of the validity period of the certificate.
+   * The start time of the validity period of the certificate.
    * 
    * @example
-   * 17312613180000
+   * 17321613180000
    */
   notBefore?: number;
   /**
    * @remarks
-   * The order ID.
+   * The ID of the certificate application order.
    * 
    * @example
    * 123456
@@ -277,7 +293,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   orderId?: number;
   /**
    * @remarks
-   * The name of the company or organization to which the certificate purchaser belongs.
+   * The name of the company or organization of the certificate purchaser.
    * 
    * @example
    * Alibaba
@@ -285,7 +301,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   orgName?: string;
   /**
    * @remarks
-   * The province of the company or organization to which the certificate purchaser belongs.
+   * The province where the company or organization of the certificate purchaser is located.
    * 
    * @example
    * zhejiang
@@ -293,7 +309,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   province?: string;
   /**
    * @remarks
-   * The ID of the request, which is used to locate and troubleshoot issues.
+   * The ID of the request. This unique ID is generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.
    * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
@@ -320,7 +336,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
    * The serial number of the certificate.
    * 
    * @example
-   * 06ea4879591ddf84e6c8b6ba43607ccf
+   * 033cd852608689ef5e368fde89e0961769e8
    */
   serialNo?: string;
   /**
@@ -328,12 +344,12 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
    * The SHA-2 value of the certificate.
    * 
    * @example
-   * 840707695D5EE41323102DDC2CB4924AA561012FBDC4E1A6324147119ED3C339
+   * 573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8
    */
   sha2?: string;
   /**
    * @remarks
-   * The content of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The content of the signing certificate that uses a Chinese cryptographic algorithm. The certificate is in PEM format. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * -----BEGIN CERTIFICATE-----
@@ -343,7 +359,7 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
   signCert?: string;
   /**
    * @remarks
-   * The private key of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.
+   * The private key of the signing certificate that uses a Chinese cryptographic algorithm. The private key is in PEM format. This parameter is returned only when the certFilter request parameter is false.
    * 
    * @example
    * -----BEGIN EC PRIVATE KEY-----
@@ -359,6 +375,10 @@ export class GetUserCertificateDetailResponseBody extends $dara.Model {
    * 2018-07-13
    */
   startDate?: string;
+  /**
+   * @remarks
+   * The list of tags.
+   */
   tags?: GetUserCertificateDetailResponseBodyTags[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListAssetCountRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAssetCountRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
   /**
+   * @remarks
+   * The expiration date of the certificate.
+   * 
    * @example
    * 2020-07-13
    */
   endDate?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 50.
+   * 
    * @example
    * 1
    */
   showSize?: number;
   /**
+   * @remarks
+   * The date of certificate issuance.
+   * 
    * @example
    * 2018-07-13
    */