@alicloud/cas20200407 3.2.8 → 3.2.9

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,96 +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 {

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

package/src/models/GetInstanceDetailResponseBody.ts

@@ -4,21 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetInstanceDetailResponseBodyDingGroupList extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID of the expert service DingTalk group.
+   * 
    * @example
    * 123
    */
   dingGroupInstanceId?: string;
   /**
+   * @remarks
+   * The name of the expert service DingTalk group.
+   * 
    * @example
    * 123
    */
   dingGroupName?: string;
   /**
+   * @remarks
+   * The type of the expert service DingTalk group. Valid values:
+   * - expedite: application assistance.
+   * - remote: offline deployment.
+   * 
    * @example
    * remote
    */
   dingGroupType?: string;
   /**
+   * @remarks
+   * The link to join the expert service DingTalk group.
+   * 
    * @example
    * https://123.com
    */
@@ -52,32 +66,57 @@ export class GetInstanceDetailResponseBodyDingGroupList extends $dara.Model {
 
 export class GetInstanceDetailResponseBodyDomainValidationList extends $dara.Model {
   /**
+   * @remarks
+   * The CNAME record value for verification-free authorization. This field may be empty.
+   * 
    * @example
    * 123.com
    */
   cname?: string;
+  /**
+   * @remarks
+   * The prefix for CNAME validation.
+   * 
+   * @example
+   * abc
+   */
   cnameKey?: string;
   /**
+   * @remarks
+   * The domain name to be validated.
+   * 
    * @example
    * example.com
    */
   domain?: string;
   /**
+   * @remarks
+   * The root domain name.
+   * 
    * @example
    * example.com
    */
   rootDomain?: string;
   /**
+   * @remarks
+   * The host record.
+   * 
    * @example
    * @
    */
   validationKey?: string;
   /**
+   * @remarks
+   * The validation type. Valid values: TXT, HTTP, and CNAME.
+   * 
    * @example
    * TXT
    */
   validationType?: string;
   /**
+   * @remarks
+   * The host record value for validation.
+   * 
    * @example
    * 123
    */
@@ -117,11 +156,17 @@ export class GetInstanceDetailResponseBodyDomainValidationList extends $dara.Mod
 
 export class GetInstanceDetailResponseBodyTags extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * test
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * test
    */
@@ -151,166 +196,319 @@ export class GetInstanceDetailResponseBodyTags extends $dara.Model {
 
 export class GetInstanceDetailResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether automatic managed renewal is enabled. Valid values:
+   * - enable: Enabled.
+   * - disable: Disabled.
+   * 
    * @example
    * enable
    */
   autoReissue?: string;
   /**
+   * @remarks
+   * The average waiting time for issuing a certificate of this specification. Unit: seconds.
+   * 
    * @example
    * 120
    */
   averageWaitingTime?: 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, the format is certificate ID + "-cn-hangzhou".
+   * For the China site, the format is 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
    * 22783111-cn-hangzhou
    */
   certIdentifier?: string;
   /**
+   * @remarks
+   * The certificate ID.
+   * 
    * @example
    * 1234567890
    */
   certificateId?: number;
   /**
+   * @remarks
+   * The name of the instance. When a certificate is issued, this name is used as the default certificate name.
+   * 
    * @example
    * 123
    */
   certificateName?: string;
   /**
+   * @remarks
+   * The end time of the latest certificate. The value is a UNIX timestamp. This field is empty if no certificate has been issued.
+   * 
    * @example
    * 1801324800000
    */
   certificateNotAfter?: number;
+  certificateNotBefore?: number;
   /**
+   * @remarks
+   * The revocation time of the latest certificate. The value is a UNIX timestamp.
+   * 
    * @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 city where the company or organization of the certificate purchaser is located. This field is required when generating a certificate signing request. Default value: Beijing.
+   * 
    * @example
    * Beijing
    */
   city?: string;
   /**
+   * @remarks
+   * The company information ID.
+   * 
    * @example
    * 47305
    */
   companyId?: number;
+  /**
+   * @remarks
+   * The list of contact IDs.
+   */
   contactIdList?: number[];
   /**
+   * @remarks
+   * The code of the country or region where the certificate organization is located. For example, CN indicates China, and US indicates the United States. This field is required when generating a certificate signing request. Default value: CN.
+   * 
    * @example
    * CN
    */
   countryCode?: string;
   /**
+   * @remarks
+   * The certificate signing request in PEM format.
+   * 
    * @example
    * -----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----
    */
   csr?: string;
+  /**
+   * @remarks
+   * The list of associated expert service DingTalk groups.
+   */
   dingGroupList?: GetInstanceDetailResponseBodyDingGroupList[];
   /**
+   * @remarks
+   * The domain name bound to the certificate.
+   * 
    * @example
    * example.com
    */
   domain?: string;
+  /**
+   * @remarks
+   * The list of domain names to be validated.
+   */
   domainValidationList?: GetInstanceDetailResponseBodyDomainValidationList[];
   /**
+   * @remarks
+   * The number of exact-match domain names.
+   * 
    * @example
    * 1
    */
   fullDomainCount?: number;
   /**
+   * @remarks
+   * The CSR generation method. Valid values:
+   * - online: system-generated. The Csr field is ignored.
+   * - upload: user-uploaded. The Csr field is required.
+   * 
    * @example
    * online
    */
   generateCsrMethod?: string;
   /**
+   * @remarks
+   * The expiration time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.
+   * 
    * @example
    * 1801324800000
    */
   instanceEndTime?: number;
   /**
+   * @remarks
+   * The ID of the instance.
+   * 
    * @example
    * cas_dv-cn-123
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The start time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.
+   * 
    * @example
    * 1801324800000
    */
   instanceStartTime?: number;
   /**
+   * @remarks
+   * The instance type. Valid values:
+   * - **BUY**: formal certificate.
+   * - **TEST**: test certificate.
+   * 
    * @example
    * TEST
    */
   instanceType?: string;
   /**
+   * @remarks
+   * The certificate algorithm. Valid values:
+   * - **RSA_2048**
+   * - **RSA_3072**
+   * - **RSA_4096**
+   * - **ECC_256**
+   * - **SM2**.
+   * 
    * @example
    * RSA_2048
    */
   keyAlgorithm?: string;
   /**
+   * @remarks
+   * The end time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the purchase duration of the instance.
+   * 
    * @example
    * 1801324800000
    */
   orderEndTime?: number;
   /**
+   * @remarks
+   * The start time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the refund time limit.
+   * 
    * @example
    * 1801324800000
    */
   orderStartTime?: number;
   /**
+   * @remarks
+   * The result returned by the certification authority (CA) during the last certificate operation.
+   * 
    * @example
    * pending
    */
   pendingResult?: string;
   /**
+   * @remarks
+   * The province or region where the company is located. This field is required when generating a certificate signing request. Default value: Beijing.
+   * 
    * @example
    * Beijing
    */
   province?: string;
   /**
+   * @remarks
+   * The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.
+   * 
    * @example
    * B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-aek****wia
    */
   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**: the instance is about to expire.
+   * - **expired**: the instance has expired.
+   * - **refund**: refunded.
+   * - **normal**: normal.
+   * - **closed**: closed and unavailable.
+   * 
    * @example
    * inactive
    */
   status?: string;
+  /**
+   * @remarks
+   * The list of tags.
+   */
   tags?: GetInstanceDetailResponseBodyTags[];
+  /**
+   * @remarks
+   * The upgrade status of the instance. Valid values:
+   * 
+   * - none: the instance has not been upgraded.
+   * 
+   * - payed: the instance upgrade has been paid.
+   * 
+   * - issued: the latest certificate has been issued after the instance upgrade.
+   * 
+   * @example
+   * none
+   */
   upgradeStatus?: string;
   /**
+   * @remarks
+   * The validation method for the certificate application. Valid values:
+   * - DNS: DNS validation, using TXT or CNAME.
+   * - HTTP: file-based validation.
+   * 
    * @example
    * DNS
    */
   validationMethod?: string;
   /**
+   * @remarks
+   * The number of wildcard domain names.
+   * 
    * @example
    * 0
    */
@@ -324,6 +522,7 @@ export class GetInstanceDetailResponseBody extends $dara.Model {
       certificateId: 'CertificateId',
       certificateName: 'CertificateName',
       certificateNotAfter: 'CertificateNotAfter',
+      certificateNotBefore: 'CertificateNotBefore',
       certificateRevokeTime: 'CertificateRevokeTime',
       certificateStatus: 'CertificateStatus',
       certificateType: 'CertificateType',
@@ -366,6 +565,7 @@ export class GetInstanceDetailResponseBody extends $dara.Model {
       certificateId: 'number',
       certificateName: 'string',
       certificateNotAfter: 'number',
+      certificateNotBefore: 'number',
       certificateRevokeTime: 'number',
       certificateStatus: 'string',
       certificateType: 'string',