@cloudbase/manager-node 5.7.1-beta.0 → 5.7.1-beta.1

package/lib/env/index.js

@@ -28,6 +28,7 @@ class EnvService {
         this.tcbService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
         this.commonService = environment.getCommonService('lowcode', '2021-01-08');
         this.billingService = new billing_1.BillingService(environment.cloudBaseContext);
+        this.certificateCloudService = new utils_1.CloudService(environment.cloudBaseContext, 'ssl', '2019-12-05');
         this.tokenCache = new Map();
     }
     /**
@@ -769,6 +770,23 @@ class EnvService {
     async describeCreditsUsageDetail(params) {
         return this.cloudService.request('DescribeCreditsUsageDetail', Object.assign({}, params));
     }
+    /**
+     * 获取当前凭证有权限访问的 SSL 证书列表。
+     *
+     * 证书用于自定义域名 HTTPS 配置，本接口不依赖 CloudBase 环境信息。
+     * @param {DescribeCertificatesParams} params 查询参数
+     * @returns {Promise<DescribeCertificatesRes>}
+     */
+    async describeCertificates(params = {}) {
+        if (params.Offset !== undefined && (!Number.isInteger(params.Offset) || params.Offset < 0)) {
+            throw new error_1.CloudBaseError('Offset 必须是大于等于 0 的整数');
+        }
+        if (params.Limit !== undefined &&
+            (!Number.isInteger(params.Limit) || params.Limit < 1 || params.Limit > 1000)) {
+            throw new error_1.CloudBaseError('Limit 必须是 1 至 1000 的整数');
+        }
+        return this.certificateCloudService.request('DescribeCertificates', params);
+    }
     /**
      * 查询HTTP访问服务域名路由信息
      * @param {DescribeHttpServiceRouteParams} params 查询参数

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "5.7.1-beta.0",
+    "version": "5.7.1-beta.1",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {

package/types/env/index.d.ts

@@ -1,6 +1,6 @@
 import { Environment } from '../environment';
 import { IResponseInfo, AuthDomain, EnvInfo, LoginConfigItem, ICheckTcbServiceRes, ICreatePostpayRes, EnvBillingInfoItem, PriceResult } from '../interfaces';
-import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams, DescribeHttpServiceRouteParams, DescribeHttpServiceRouteRes, VerifyHttpServiceRouteParams, VerifyHttpServiceRouteRes, CreateHttpServiceRouteParams, CreateHttpServiceRouteRes, ModifyHttpServiceRouteParams, ModifyHttpServiceRouteRes, DeleteHttpServiceRouteParams, DeleteHttpServiceRouteRes, BindCustomDomainParams, BindCustomDomainRes, DeleteCustomDomainParams, DeleteCustomDomainRes } from './type';
+import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams, DescribeHttpServiceRouteParams, DescribeHttpServiceRouteRes, VerifyHttpServiceRouteParams, VerifyHttpServiceRouteRes, CreateHttpServiceRouteParams, CreateHttpServiceRouteRes, ModifyHttpServiceRouteParams, ModifyHttpServiceRouteRes, DeleteHttpServiceRouteParams, DeleteHttpServiceRouteRes, BindCustomDomainParams, BindCustomDomainRes, DeleteCustomDomainParams, DeleteCustomDomainRes, DescribeCertificatesParams, DescribeCertificatesRes } from './type';
 import { CreateBillingDealParams, CreateEnvParams, BaasPackageInfo, DescribeBaasPackageListParams, ModifyEnvPlanParams, RenewEnvParams, DestroyEnvParams, DescribeEnvsParams, DescribeEnvInfoParams, DescribeEnvInfoResponse, DescribeEnvAccountCircleParams, DescribeEnvAccountCircleRes, DescribeCreditsUsageDetailParams, EnvPkgCreditsUsage } from '../interfaces/tcb.interface';
 type SOURCE = 'miniapp' | 'qcloud';
 interface IDeleteDomainRes {
@@ -559,6 +559,7 @@ export declare class EnvService {
     private envType?;
     private commonService;
     private billingService;
+    private certificateCloudService;
     private tokenCache;
     constructor(environment: Environment);
     /**
@@ -882,6 +883,14 @@ export declare class EnvService {
         Usages: EnvPkgCreditsUsage[];
         RequestId: string;
     }>;
+    /**
+     * 获取当前凭证有权限访问的 SSL 证书列表。
+     *
+     * 证书用于自定义域名 HTTPS 配置，本接口不依赖 CloudBase 环境信息。
+     * @param {DescribeCertificatesParams} params 查询参数
+     * @returns {Promise<DescribeCertificatesRes>}
+     */
+    describeCertificates(params?: DescribeCertificatesParams): Promise<DescribeCertificatesRes>;
     /**
      * 查询HTTP访问服务域名路由信息
      * @param {DescribeHttpServiceRouteParams} params 查询参数

package/types/env/type.d.ts

@@ -14,6 +14,169 @@ export interface CalculatePackageModifyPriceParams {
     envId: string;
     currency?: 'CNY' | 'USD';
 }
+/** 获取 SSL 证书列表请求参数。 */
+export interface DescribeCertificatesParams {
+    /** 分页偏移量，从 0 开始。 */
+    Offset?: number;
+    /** 每页数量，范围为 1 至 1000。 */
+    Limit?: number;
+    /** 模糊匹配证书 ID、备注名称或证书域名。 */
+    SearchKey?: string;
+    /** 证书类型：CA 为客户端证书，SVR 为服务器证书。 */
+    CertificateType?: 'CA' | 'SVR';
+    /** 项目 ID。 */
+    ProjectId?: number;
+    /** 按证书到期时间排序。 */
+    ExpirationSort?: 'ASC' | 'DESC';
+    /** 证书状态筛选。 */
+    CertificateStatus?: number[];
+    /** 是否仅返回可部署证书：1 是，0 否。 */
+    Deployable?: 0 | 1;
+    /** 是否仅返回上传托管证书：1 是，0 否。 */
+    Upload?: 0 | 1;
+    /** 是否仅返回可续期证书：1 是，0 否。 */
+    Renew?: 0 | 1;
+    /** 来源筛选。 */
+    FilterSource?: 'upload' | 'buy';
+    /** 是否仅返回国密证书：1 是，0 否。 */
+    IsSM?: 0 | 1;
+    /** 是否仅返回即将过期证书：1 是，0 否。 */
+    FilterExpiring?: 0 | 1;
+    /** 是否仅返回可托管证书：1 是，0 否。 */
+    Hostable?: 0 | 1;
+    /** 标签筛选条件。 */
+    Tags?: Array<{
+        TagKey: string;
+        TagValue?: string;
+    }>;
+    /** 是否仅返回等待签发证书：1 是，0 否。 */
+    IsPendingIssue?: 0 | 1;
+    /** 指定证书 ID 列表。 */
+    CertIds?: string[];
+    /** 订阅服务 ID。 */
+    ServiceId?: string;
+}
+/** Certificates.CertificateExtra：证书扩展信息。 */
+export interface CertificateExtra {
+    DomainNumber: string;
+    OriginCertificateId: string | null;
+    ReplacedBy: string | null;
+    ReplacedFor: string | null;
+    RenewOrder: string | null;
+    SMCert: number;
+    CompanyType: number;
+    ServiceRenewCertificateId: string;
+    ServiceOriginCertificateId: string;
+}
+/** Certificates.ProjectInfo：项目信息。 */
+export interface ProjectInfo {
+    ProjectName: string;
+    ProjectCreatorUin: number;
+    ProjectCreateTime: string;
+    ProjectResume: string;
+    OwnerUin: number;
+    ProjectId: string;
+}
+/** Certificates.PreAuditInfo：证书预审核信息。 */
+export interface PreAuditInfo {
+    TotalPeriod: number;
+    NowPeriod: number;
+    ManagerId: string;
+}
+/** Certificates.HostingConfig：托管配置。 */
+export interface HostingConfig {
+    ReplaceTime?: number;
+    MessageTypes?: number[];
+    ReplaceStartTime?: string;
+    ReplaceEndTime?: string;
+}
+/** Certificates.SupportDownloadType：支持下载的服务器格式。 */
+export interface SupportDownloadType {
+    NGINX: boolean;
+    APACHE: boolean;
+    TOMCAT: boolean;
+    IIS: boolean;
+    JKS: boolean;
+    OTHER: boolean;
+    ROOT: boolean;
+}
+/** Certificates.Tags：标签信息。 */
+export interface CertificateTag {
+    TagKey: string;
+    TagValue: string;
+}
+/** SSL 证书列表项，对应 DescribeCertificates 响应中的 Certificates 元素。 */
+export interface Certificates {
+    OwnerUin: string;
+    ProjectId: string;
+    From: string;
+    PackageType: string;
+    CertificateType: 'CA' | 'SVR';
+    ProductZhName: string;
+    Domain: string;
+    Alias: string;
+    Status: number;
+    CertificateExtra: CertificateExtra;
+    VulnerabilityStatus: 'INACTIVE' | 'ACTIVE';
+    StatusMsg: string;
+    VerifyType: 'DNS_AUTO' | 'DNS' | 'FILE' | 'DNS_PROXY' | 'FILE_PROXY';
+    CertBeginTime: string;
+    CertEndTime: string;
+    ValidityPeriod: string;
+    InsertTime: string;
+    CertificateId: string;
+    SubjectAltName: string[];
+    PackageTypeName: string;
+    StatusName: string;
+    IsVip: boolean;
+    IsDv: boolean;
+    IsWildcard: boolean;
+    IsVulnerability: boolean;
+    RenewAble: boolean;
+    ProjectInfo: ProjectInfo;
+    BoundResource: string[];
+    Deployable: boolean;
+    Tags: CertificateTag[];
+    IsIgnore: boolean;
+    IsSM: boolean;
+    EncryptAlgorithm: string;
+    CAEncryptAlgorithms: string[];
+    CAEndTimes: string[];
+    CACommonNames: string[];
+    PreAuditInfo: PreAuditInfo;
+    AutoRenewFlag: number;
+    HostingStatus: number;
+    HostingCompleteTime: string;
+    HostingRenewCertId: string;
+    HasRenewOrder: string;
+    ReplaceOriCertIsDelete: boolean;
+    IsExpiring: boolean;
+    DVAuthDeadline: string;
+    ValidationPassedTime: string;
+    CertSANs: string[];
+    AwaitingValidationMsg: string;
+    AllowDownload: boolean;
+    IsDNSPODResolve: boolean;
+    IsPackage: boolean;
+    KeyPasswordCustomFlag: boolean;
+    SupportDownloadType: SupportDownloadType;
+    CertRevokedTime: string;
+    HostingResourceTypes: string[];
+    HostingConfig: HostingConfig | null;
+    IsHostingUploadRenewCert: boolean;
+    ServiceId: string;
+    ServiceStatus: 'initing' | 'running' | 'expired' | 'refunded' | 'nearExpire';
+    CertServiceBeginTime: string;
+    CertServiceEndTime: string;
+    CertServiceShareEnabled: boolean;
+    CertServiceValidCertificateCount: number;
+}
+/** 获取 SSL 证书列表响应。 */
+export interface DescribeCertificatesRes {
+    TotalCount: number;
+    Certificates: Certificates[];
+    RequestId: string;
+}
 /**
  * 客户端限频配置
  */