tenyun/types/sslpod.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** 证书信息 */
declare interface CertInfo {
  /** 证书sha1 */
  Hash: string;
  /** 证书通用名称 */
  CN: string;
  /** 备用名称 */
  SANs: string;
  /** 公钥算法 */
  KeyAlgo: string;
  /** 颁发者 */
  Issuer: string;
  /** 有效期开始 */
  BeginTime: string;
  /** 有效期结束 */
  EndTime: string;
  /** 剩余天数 */
  Days: number;
  /** 品牌 */
  Brand: string;
  /** 信任状态 */
  TrustStatus: string;
  /** 证书类型 */
  CertType: string | null;
}

/** 直方图数据结构 */
declare interface ChartHistogram {
  /** 项目名 */
  Name: string;
  /** 项目值 */
  Children: ChartNameValue[];
}

/** 通用图表键值对 */
declare interface ChartNameValue {
  /** 图表项名称 */
  Name: string;
  /** 图表项值 */
  Value: number;
}

/** 面板数据 */
declare interface DashboardResult {
  /** 安全等级图表 */
  SecurityLevelPie: ChartNameValue[];
  /** 证书品牌图表 */
  CertBrandsPie: ChartNameValue[];
  /** 证书有效时间图表 */
  CertValidTimePie: ChartNameValue[];
  /** 证书类型图表 */
  CertTypePie: ChartNameValue[];
  /** ssl bugs图表 */
  SSLBugsLoopholeHistogram: ChartHistogram[];
  /** 合规图表 */
  ComplianceHistogram: ChartHistogram[];
}

/** 监控域名列表 */
declare interface DescribeDomains {
  /** 列表数据 */
  Result: DomainSiteInfo[] | null;
  /** 搜索出来的数量 */
  SearchTotal: number;
  /** 总数 */
  Total: number;
  /** 允许的监控数量 */
  AllowMonitoringCount: number;
  /** 当前监控的数量 */
  CurrentMonitoringCount: number;
  /** 允许添加域名总数 */
  AllowMaxAddDomain: number;
}

/** 监控的域名站点信息 */
declare interface DomainSiteInfo {
  /** ID标识 */
  Id: number;
  /** 域名 */
  Domain: string;
  /** IP地址 */
  Ip: string;
  /** 是否自动获取IP：true：是，false:否 */
  AutoIP: boolean;
  /** 评级"A+"， "A"，"A-"，"B"，"C"，"D"， "E"， "F"，"T"， */
  Grade: string;
  /** 证书品牌 */
  Brand: string;
  /** 监控服务类型0 :Web1: SMTP2: IMAP3: POP3 */
  ServerType: number;
  /** 评级Code0："unknown"，1："A+"，2： "A"，3："A-"，4："B"，5："C"，6："D"，7： "E"，8： "F"，9："T"， */
  GradeCode: number;
  /** 是否监控告警；true：是，false:否 */
  Notice: boolean;
  /** 账号域名关系ID */
  AccountDomainId: number;
  /** 标签 */
  Tags: string[] | null;
  /** 域名状态:连接异常，证书已过期，证书已吊销，证书黑名单，证书域名不匹配，证书不可信，证书密钥弱，证书即将过期，少于7天，证书即将过期，少于30天，正常，部分异常 */
  Status: string;
  /** 域名端口 */
  Port: string;
}

/** 通知额度限制信息 */
declare interface LimitInfo {
  /** 通知类型：limit_emai：邮件limit_wechat：微信limit_phone：手机 */
  Type: string;
  /** 总量 */
  Total: number;
  /** 已发送 */
  Sent: number;
}

/** 通知信息结果 */
declare interface NoticeInfoResult {
  /** 通知ID */
  Id: number;
  /** 通知开关信息；0：关闭；15开启 */
  NoticeType: number;
  /** 额度信息 */
  LimitInfos: LimitInfo[];
}

declare interface CreateDomainRequest {
  /** 监控的服务器类型（0：web，1：smtp，2：imap，3：pops） */
  ServerType: number;
  /** 添加的域名 */
  Domain: string;
  /** 添加的端口 */
  Port: string;
  /** 指定域名的IP */
  IP?: string;
  /** 是否开启通知告警；true：开启通知告警，false：关闭通知告警 */
  Notice?: boolean;
  /** 给域名添加标签，多个以逗号隔开 */
  Tags?: string;
}

declare interface CreateDomainResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DeleteDomainRequest {
  /** 域名ID，可通过搜索域名接口获得 */
  DomainId: number;
}

declare interface DeleteDomainResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeDashboardRequest {
}

declare interface DescribeDashboardResponse {
  /** dashboard面板数据 */
  Data?: DashboardResult | null;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeDomainCertsRequest {
  /** 域名ID，可通过搜索域名接口获得 */
  DomainId: number;
}

declare interface DescribeDomainCertsResponse {
  /** 证书信息 */
  Data?: CertInfo[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeDomainTagsRequest {
}

declare interface DescribeDomainTagsResponse {
  /** Tag数组 */
  Data?: string[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeDomainsRequest {
  /** 偏移量 */
  Offset: number;
  /** 获取数量 */
  Limit: number;
  /** 搜索的类型有：none，tags，grade，brand，code，hash，limit，domain。选tags，入参请填Tag，选grade，入参请填Grade，选brand，入参请填Brand，选code，入参请填Code，选hash，入参请填Hash选limit，标识只返回数量信息选domain，入参请填Domain */
  SearchType: string;
  /** 标签，多个标签用逗号分隔 */
  Tag?: string;
  /** 等级 */
  Grade?: string;
  /** 品牌 */
  Brand?: string;
  /** 混合搜索 */
  Code?: string;
  /** 证书指纹 */
  Hash?: string;
  /** 搜索图标类型 */
  Item?: string;
  /** 搜索图标值 */
  Status?: string;
  /** 搜索域名 */
  Domain?: string;
}

declare interface DescribeDomainsResponse {
  /** 列表数据 */
  Data: DescribeDomains;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeNoticeInfoRequest {
}

declare interface DescribeNoticeInfoResponse {
  /** 通知信息结果 */
  Data?: NoticeInfoResult;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ModifyDomainTagsRequest {
  /** 账号下域名ID */
  AccountDomainId: number;
  /** 更新后的tag，多个以逗号隔开 */
  Tags: string;
}

declare interface ModifyDomainTagsResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface RefreshDomainRequest {
  /** 域名列表中的ID，可通过搜索域名接口获得 */
  DomainId: number;
}

declare interface RefreshDomainResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface ResolveDomainRequest {
  /** 域名 */
  Domain: string;
}

declare interface ResolveDomainResponse {
  /** 响应数据 */
  Data?: string[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Sslpod 证书监控 SSLPod} */
declare interface Sslpod {
  (): Versions;
  /** 添加域名 {@link CreateDomainRequest} {@link CreateDomainResponse} */
  CreateDomain(data: CreateDomainRequest, config?: AxiosRequestConfig): AxiosPromise<CreateDomainResponse>;
  /** 删除域名 {@link DeleteDomainRequest} {@link DeleteDomainResponse} */
  DeleteDomain(data: DeleteDomainRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteDomainResponse>;
  /** 仪表盘数据 {@link DescribeDashboardRequest} {@link DescribeDashboardResponse} */
  DescribeDashboard(data?: DescribeDashboardRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeDashboardResponse>;
  /** 获取域名证书 {@link DescribeDomainCertsRequest} {@link DescribeDomainCertsResponse} */
  DescribeDomainCerts(data: DescribeDomainCertsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeDomainCertsResponse>;
  /** 获取账号的tags {@link DescribeDomainTagsRequest} {@link DescribeDomainTagsResponse} */
  DescribeDomainTags(data?: DescribeDomainTagsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeDomainTagsResponse>;
  /** 搜索域名 {@link DescribeDomainsRequest} {@link DescribeDomainsResponse} */
  DescribeDomains(data: DescribeDomainsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeDomainsResponse>;
  /** 通知额度信息 {@link DescribeNoticeInfoRequest} {@link DescribeNoticeInfoResponse} */
  DescribeNoticeInfo(data?: DescribeNoticeInfoRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeNoticeInfoResponse>;
  /** 修改域名tag {@link ModifyDomainTagsRequest} {@link ModifyDomainTagsResponse} */
  ModifyDomainTags(data: ModifyDomainTagsRequest, config?: AxiosRequestConfig): AxiosPromise<ModifyDomainTagsResponse>;
  /** 重新检测域名 {@link RefreshDomainRequest} {@link RefreshDomainResponse} */
  RefreshDomain(data: RefreshDomainRequest, config?: AxiosRequestConfig): AxiosPromise<RefreshDomainResponse>;
  /** 域名解析 {@link ResolveDomainRequest} {@link ResolveDomainResponse} */
  ResolveDomain(data: ResolveDomainRequest, config?: AxiosRequestConfig): AxiosPromise<ResolveDomainResponse>;
}

export declare type Versions = ["2019-06-05"];

export default Sslpod;