数据结构

最近更新时间:2024-10-24 01:29:46

我的收藏

ApiGatewayInstanceDetail

apiGateway实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostApiGatewayInstanceList。

名称 类型 描述
ServiceId String 实例ID
ServiceName String 实例名称
Domain String 域名
CertId String 证书ID
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 使用协议

ApiGatewayInstanceList

apigateway实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
InstanceList Array of ApiGatewayInstanceDetail apigateway实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下apigateway实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

BatchDeleteFail

批量删除失败的项

被如下接口引用:DeleteCertificates。

名称 类型 描述
CertId String 失败的证书ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:23y5RzQp
Msg String 失败的原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:当前证书未过期,不能被删除

BindResourceRegionResult

绑定资源地域结果

被如下接口引用:DescribeCertificateBindResourceTaskResult。

名称 类型 描述
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 关联资源总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

BindResourceResult

绑定资源结果

被如下接口引用:DescribeCertificateBindResourceTaskResult。

名称 类型 描述
ResourceType String 资源类型:clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo(edgeOne)
BindResourceRegionResult Array of BindResourceRegionResult 绑定资源地域结果

COSInstanceList

cos实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
InstanceList Array of CosInstanceDetail 实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 地域下总数
注意:此字段可能返回 null,表示取不到有效值。
Error String 错误信息
注意:此字段可能返回 null,表示取不到有效值。

CdnInstanceDetail

CDN实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostCdnInstanceList。

名称 类型 描述
Domain String 域名
CertId String 已部署证书ID
Status String 域名状态
HttpsBillingSwitch String 域名计费状态

CdnInstanceList

cdn实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
TotalCount Integer 该地域下CDN域名总数
InstanceList Array of CdnInstanceDetail cdn域名详情
注意:此字段可能返回 null,表示取不到有效值。
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

CertTaskId

证书异步任务ID

被如下接口引用:CreateCertificateBindResourceSyncTask, DeleteCertificates。

名称 类型 必选 描述
CertId String 证书ID
TaskId String 异步任务ID

Certificate

CLB证书详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostClbInstanceList。

名称 类型 描述
CertId String 证书ID
DnsNames Array of String 证书绑定的域名
CertCaId String 根证书ID
注意:此字段可能返回 null,表示取不到有效值。
SSLMode String 证书认证模式:UNIDIRECTIONAL单向认证,MUTUAL双向认证
注意:此字段可能返回 null,表示取不到有效值。

CertificateExtra

获取证书列表(DescribeCertificates)返回参数键为 Certificates 数组下,key为CertificateExtra 的内容。

被如下接口引用:DescribeCertificate, DescribeCertificateDetail, DescribeCertificates。

名称 类型 描述
DomainNumber String 证书可配置域名数量。
注意:此字段可能返回 null,表示取不到有效值。
OriginCertificateId String 原始证书 ID。
注意:此字段可能返回 null,表示取不到有效值。
ReplacedBy String 重颁发证书原始 ID。
注意:此字段可能返回 null,表示取不到有效值。
ReplacedFor String 重颁发证书新 ID。
注意:此字段可能返回 null,表示取不到有效值。
RenewOrder String 新订单证书 ID。
注意:此字段可能返回 null,表示取不到有效值。
SMCert Integer 是否是国密证书
注意:此字段可能返回 null,表示取不到有效值。
CompanyType Integer 公司类型
注意:此字段可能返回 null,表示取不到有效值。

Certificates

获取证书列表(DescribeCertificates)返回参数键为 Certificates 的内容。

被如下接口引用:DescribeCertificates。

名称 类型 描述
OwnerUin String 用户 UIN。
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目 ID。
注意:此字段可能返回 null,表示取不到有效值。
From String 证书来源。
注意:此字段可能返回 null,表示取不到有效值。
PackageType String 证书套餐类型:
2 = TrustAsia TLS RSA CA,3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = Wotrus 国密域名型证书,34 = Wotrus 国密域名型多域名证书,35 = Wotrus 国密域名型通配符证书,37 = Wotrus 国密企业型证书,38 = Wotrus 国密企业型多域名证书,39 = Wotrus 国密企业型通配符证书,40 = Wotrus 国密增强型证书,41 = Wotrus 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书,43 = DNSPod-企业型(OV)SSL证书,44 = DNSPod-企业型(OV)通配符SSL证书,45 = DNSPod-企业型(OV)多域名SSL证书, 46 = DNSPod-增强型(EV)SSL证书,47 = DNSPod-增强型(EV)多域名SSL证书,48 = DNSPod-域名型(DV)SSL证书,49 = DNSPod-域名型(DV)通配符SSL证书,50 = DNSPod-域名型(DV)多域名SSL证书,51 = DNSPod(国密)-企业型(OV)SSL证书,52 = DNSPod(国密)-企业型(OV)通配符SSL证书,53 = DNSPod(国密)-企业型(OV)多域名SSL证书,54 = DNSPod(国密)-域名型(DV)SSL证书,55 = DNSPod(国密)-域名型(DV)通配符SSL证书, 56 = DNSPod(国密)-域名型(DV)多域名SSL证书,57 = SecureSite 企业型专业版多域名(OV Pro),58 = SecureSite 企业型多域名(OV),59 = SecureSite 增强型专业版多域名(EV Pro),60 = SecureSite 增强型多域名(EV),61 = Geotrust 增强型多域名(EV)
注意:此字段可能返回 null,表示取不到有效值。
CertificateType String 证书类型:CA = 客户端证书,SVR = 服务器证书。
注意:此字段可能返回 null,表示取不到有效值。
ProductZhName String 颁发者。
注意:此字段可能返回 null,表示取不到有效值。
Domain String 主域名。
注意:此字段可能返回 null,表示取不到有效值。
Alias String 备注名称。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 状态。0:审核中,1:已通过,2:审核失败,3:已过期,4:验证方式为 DNS_AUTO 类型的证书, 已添加DNS记录,5:企业证书,待提交,6:订单取消中,7:已取消,8:已提交资料, 待上传确认函,9:证书吊销中,10:已吊销,11:重颁发中,12:待上传吊销确认函,13:免费证书待提交资料状态,14:已退款,
注意:此字段可能返回 null,表示取不到有效值。
CertificateExtra CertificateExtra 证书扩展信息。
注意:此字段可能返回 null,表示取不到有效值。
VulnerabilityStatus String 漏洞扫描状态:INACTIVE = 未开启,ACTIVE = 已开启
注意:此字段可能返回 null,表示取不到有效值。
StatusMsg String 状态信息。
注意:此字段可能返回 null,表示取不到有效值。
VerifyType String 验证类型:DNS_AUTO = 自动DNS验证,DNS = 手动DNS验证,FILE = 文件验证,EMAIL = 邮件验证。
注意:此字段可能返回 null,表示取不到有效值。
CertBeginTime String 证书生效时间。
注意:此字段可能返回 null,表示取不到有效值。
CertEndTime String 证书过期时间。
注意:此字段可能返回 null,表示取不到有效值。
ValidityPeriod String 证书有效期,单位(月)。
注意:此字段可能返回 null,表示取不到有效值。
InsertTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
CertificateId String 证书 ID。
注意:此字段可能返回 null,表示取不到有效值。
SubjectAltName Array of String 证书包含的多个域名(包含主域名)。
注意:此字段可能返回 null,表示取不到有效值。
PackageTypeName String 证书类型名称。
注意:此字段可能返回 null,表示取不到有效值。
StatusName String 状态名称。
注意:此字段可能返回 null,表示取不到有效值。
IsVip Boolean 是否为 VIP 客户。
注意:此字段可能返回 null,表示取不到有效值。
IsDv Boolean 是否为 DV 版证书。
注意:此字段可能返回 null,表示取不到有效值。
IsWildcard Boolean 是否为泛域名证书。
注意:此字段可能返回 null,表示取不到有效值。
IsVulnerability Boolean 是否启用了漏洞扫描功能。
注意:此字段可能返回 null,表示取不到有效值。
RenewAble Boolean 是否可续费。
注意:此字段可能返回 null,表示取不到有效值。
ProjectInfo ProjectInfo 项目信息。
注意:此字段可能返回 null,表示取不到有效值。
BoundResource Array of String 关联的云资源,暂不可用
注意:此字段可能返回 null,表示取不到有效值。
Deployable Boolean 是否可部署。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tags 标签列表
注意:此字段可能返回 null,表示取不到有效值。
IsIgnore Boolean 是否已忽略到期通知
注意:此字段可能返回 null,表示取不到有效值。
IsSM Boolean 是否国密证书
注意:此字段可能返回 null,表示取不到有效值。
EncryptAlgorithm String 证书算法
注意:此字段可能返回 null,表示取不到有效值。
CAEncryptAlgorithms Array of String 上传CA证书的加密算法
注意:此字段可能返回 null,表示取不到有效值。
CAEndTimes Array of String 上传CA证书的过期时间
注意:此字段可能返回 null,表示取不到有效值。
CACommonNames Array of String 上传CA证书的通用名称
注意:此字段可能返回 null,表示取不到有效值。
PreAuditInfo PreAuditInfo 证书预审核信息
注意:此字段可能返回 null,表示取不到有效值。
AutoRenewFlag Integer 是否自动续费
注意:此字段可能返回 null,表示取不到有效值。
HostingStatus Integer 托管状态,0,托管中,5,资源替换中, 10, 托管完成, -1未托管
注意:此字段可能返回 null,表示取不到有效值。
HostingCompleteTime String 托管完成时间
注意:此字段可能返回 null,表示取不到有效值。
HostingRenewCertId String 托管新证书ID
注意:此字段可能返回 null,表示取不到有效值。
HasRenewOrder String 存在的续费证书ID
注意:此字段可能返回 null,表示取不到有效值。
ReplaceOriCertIsDelete Boolean 重颁发证书原证书是否删除
注意:此字段可能返回 null,表示取不到有效值。
IsExpiring Boolean 是否即将过期, 证书即将到期的30天内为即将过期
注意:此字段可能返回 null,表示取不到有效值。
DVAuthDeadline String DV证书添加验证截止时间
注意:此字段可能返回 null,表示取不到有效值。
ValidationPassedTime String 域名验证通过时间
注意:此字段可能返回 null,表示取不到有效值。
CertSANs Array of String 证书关联的多域名
注意:此字段可能返回 null,表示取不到有效值。
AwaitingValidationMsg String 域名验证驳回信息
注意:此字段可能返回 null,表示取不到有效值。
AllowDownload Boolean 是否允许下载
注意:此字段可能返回 null,表示取不到有效值。
IsDNSPODResolve Boolean 证书域名是否全部在DNSPOD托管解析
注意:此字段可能返回 null,表示取不到有效值。
IsPackage Boolean 是否是权益点购买的证书
注意:此字段可能返回 null,表示取不到有效值。
KeyPasswordCustomFlag Boolean 是否存在私钥密码
注意:此字段可能返回 null,表示取不到有效值。
SupportDownloadType SupportDownloadType 支持下载的WEB服务器类型: nginx、apache、iis、tomcat、jks、root、other
注意:此字段可能返回 null,表示取不到有效值。
CertRevokedTime String 证书吊销完成时间
注意:此字段可能返回 null,表示取不到有效值。
HostingResourceTypes Array of String 托管资源类型列表
注意:此字段可能返回 null,表示取不到有效值。
HostingConfig HostingConfig 托管配置信息
注意:此字段可能返回 null,表示取不到有效值。

ClbInstanceDetail

clb实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostClbInstanceList。

名称 类型 描述
LoadBalancerId String CLB实例ID
LoadBalancerName String CLB实例名称
Listeners Array of ClbListener CLB监听器列表
注意:此字段可能返回 null,表示取不到有效值。

ClbInstanceList

clb实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
InstanceList Array of ClbInstanceDetail clb实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下Clb实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

ClbListener

CLB实例监听器

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostClbInstanceList。

名称 类型 描述
ListenerId String 监听器ID
ListenerName String 监听器名称
SniSwitch Integer 是否开启SNI,1为开启,0为关闭
Protocol String 监听器协议类型, HTTPS|TCP_SSL
Certificate Certificate 监听器绑定的证书数据
注意:此字段可能返回 null,表示取不到有效值。
Rules Array of ClbListenerRule 监听器规则列表
注意:此字段可能返回 null,表示取不到有效值。
NoMatchDomains Array of String 不匹配域名列表
注意:此字段可能返回 null,表示取不到有效值。

ClbListenerRule

CLB监听器规则

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostClbInstanceList。

名称 类型 描述
LocationId String 规则ID
Domain String 规则绑定的域名
IsMatch Boolean 规则是否匹配待绑定证书的域名
Certificate Certificate 规则已绑定的证书数据
注意:此字段可能返回 null,表示取不到有效值。
NoMatchDomains Array of String 不匹配域名列表
注意:此字段可能返回 null,表示取不到有效值。
Url String 规则绑定的路径
注意:此字段可能返回 null,表示取不到有效值。

CompanyInfo

公司信息

被如下接口引用:DescribeCompanies, DescribeManagerDetail。

名称 类型 描述
CompanyName String 公司名称
CompanyId Integer 公司ID
CompanyCountry String 公司所在国家
CompanyProvince String 公司所在省份
CompanyCity String 公司所在城市
CompanyAddress String 公司所在详细地址
CompanyPhone String 公司电话
IdType String 类型
注意:此字段可能返回 null,表示取不到有效值。
IdNumber String ID号
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tags 标签
注意:此字段可能返回 null,表示取不到有效值。

CosInstanceDetail

COS实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostCosInstanceList。

名称 类型 描述
Domain String 域名
CertId String 已绑定的证书ID
注意:此字段可能返回 null,表示取不到有效值。
Status String ENABLED: 域名上线状态
DISABLED:域名下线状态
Bucket String 存储桶名称
注意:此字段可能返回 null,表示取不到有效值。
Region String 存储桶地域
注意:此字段可能返回 null,表示取不到有效值。

DdosInstanceDetail

ddos复杂类型

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostDdosInstanceList。

名称 类型 描述
Domain String 域名
InstanceId String 实例ID
Protocol String 协议类型
CertId String 证书ID
注意:此字段可能返回 null,表示取不到有效值。
VirtualPort String 转发端口

DdosInstanceList

ddos实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
TotalCount Integer 该地域下ddos域名总数
InstanceList Array of DdosInstanceDetail ddos实例详情
注意:此字段可能返回 null,表示取不到有效值。
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

DeleteTaskResult

批量删除证书异步任务结果

被如下接口引用:DescribeDeleteCertificatesTaskResult。

名称 类型 描述
TaskId String 任务ID
CertId String 证书ID
Status Integer 异步查询结果: 0表示任务进行中、 1表示任务成功、 2表示任务失败、3表示未授权服务角色导致任务失败、4表示有未解绑的云资源导致任务失败、5表示查询关联云资源超时导致任务失败
Error String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
CacheTime String 当前结果缓存时间
注意:此字段可能返回 null,表示取不到有效值。
Domains Array of String 包含的域名
注意:此字段可能返回 null,表示取不到有效值。

DeployRecordDetail

部署记录详情

被如下接口引用:DescribeHostDeployRecordDetail。

名称 类型 描述
Id Integer 部署记录详情ID
CertId String 部署证书ID
OldCertId String 原绑定证书ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceId String 部署实例ID
InstanceName String 部署实例名称
ListenerId String 部署监听器ID
注意:此字段可能返回 null,表示取不到有效值。
Domains Array of String 部署域名列表
Protocol String 部署监听器协议
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 部署状态
ErrorMsg String 部署错误信息
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 部署记录详情创建时间
UpdateTime String 部署记录详情最后一次更新时间
ListenerName String 部署监听器名称
SniSwitch Integer 是否开启SNI
Bucket String COS存储桶名称
注意:此字段可能返回 null,表示取不到有效值。
Namespace String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
SecretName String secret名称
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 端口
注意:此字段可能返回 null,表示取不到有效值。
EnvId String TCB环境ID
注意:此字段可能返回 null,表示取不到有效值。
TCBType String 部署的TCB类型
注意:此字段可能返回 null,表示取不到有效值。
Region String 部署的TCB地域
注意:此字段可能返回 null,表示取不到有效值。
Url Array of String 部署CLB监听器的Url
注意:此字段可能返回 null,表示取不到有效值。
示例值:["/test1","/test2"]

DeployRecordInfo

部署记录信息

被如下接口引用:DescribeHostDeployRecord。

名称 类型 描述
Id Integer 部署记录ID
CertId String 部署证书ID
ResourceType String 部署资源类型
Region String 部署地域
Status Integer 部署状态
CreateTime String 部署时间
UpdateTime String 最近一次更新时间

DeployedResources

资源详情

被如下接口引用:DescribeDeployedResources。

名称 类型 描述
CertificateId String 证书ID
示例值:nz9ICcbp
Count Integer 数量
Type String 资源标识:clb,cdn,live,waf,antiddos
ResourceIds Array of String 不建议使用。字段返回和Resources相同。本字段后续只返回null
注意:此字段可能返回 null,表示取不到有效值。
Resources Array of String 关联资源ID或关联域名。
注意:此字段可能返回 null,表示取不到有效值。

DomainValidationResult

域名验证结果

被如下接口引用:CheckCertificateDomainVerification。

名称 类型 描述
Domain String 域名。
示例值:qq.com
VerifyType String 验证类型。
注意:此字段可能返回 null,表示取不到有效值。
示例值:DNS
LocalCheck Integer 本地检查结果。
示例值:1
CaCheck Integer CA检查结果。
示例值:1
LocalCheckFailReason String 检查失败原因。
注意:此字段可能返回 null,表示取不到有效值。
CheckValue Array of String 检查到的值。
注意:此字段可能返回 null,表示取不到有效值。
Frequently Boolean 是否频繁请求。
示例值:false
Issued Boolean 是否已经签发。
示例值:false

DvAuthDetail

获取证书列表(DescribeCertificate)返回参数键为 DvAuthDetail 的内容。

被如下接口引用:DescribeCertificate, DescribeCertificateDetail。

名称 类型 描述
DvAuthKey String DV 认证密钥。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthValue String DV 认证值。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthDomain String DV 认证值域名。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthPath String DV 认证值路径。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthKeySubDomain String DV 认证子域名。
注意:此字段可能返回 null,表示取不到有效值。
DvAuths Array of DvAuths DV 认证信息。
注意:此字段可能返回 null,表示取不到有效值。

DvAuths

返回参数键为 DvAuths 的内容。

被如下接口引用:DescribeCertificate, DescribeCertificateDetail。

名称 类型 描述
DvAuthKey String DV 认证密钥。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthValue String DV 认证值。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthDomain String DV 认证值域名。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthPath String DV 认证值路径。
注意:此字段可能返回 null,表示取不到有效值。
DvAuthSubDomain String DV 认证子域名,
注意:此字段可能返回 null,表示取不到有效值。
DvAuthVerifyType String DV 认证类型。
注意:此字段可能返回 null,表示取不到有效值。

Error

错误异常

被如下接口引用:DescribeCertificateBindResourceTaskResult。

名称 类型 描述
Code String 异常错误码
注意:此字段可能返回 null,表示取不到有效值。
Message String 异常错误信息
注意:此字段可能返回 null,表示取不到有效值。

Filter

过滤参数列表

被如下接口引用:DescribeHostApiGatewayInstanceList, DescribeHostCdnInstanceList, DescribeHostClbInstanceList, DescribeHostCosInstanceList, DescribeHostDdosInstanceList, DescribeHostLighthouseInstanceList, DescribeHostLiveInstanceList, DescribeHostTeoInstanceList, DescribeHostTkeInstanceList, DescribeHostVodInstanceList, DescribeHostWafInstanceList。

名称 类型 必选 描述
FilterKey String 过滤参数key
示例值:DomainMatch
FilterValue String 过滤参数值
示例值:1

GatewayCertificate

云原生网关证书信息

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Id String 网关证书ID
注意:此字段可能返回 null,表示取不到有效值。
Name String 网关证书名称
注意:此字段可能返回 null,表示取不到有效值。
BindDomains Array of String 绑定域名
注意:此字段可能返回 null,表示取不到有效值。
CertSource String 证书来源
注意:此字段可能返回 null,表示取不到有效值。
CertId String 当前绑定的SSL证书ID
注意:此字段可能返回 null,表示取不到有效值。

HostingConfig

托管配置

被如下接口引用:DescribeCertificates。

名称 类型 必选 描述
ReplaceTime Integer 托管资源替换时间, 默认为证书过期前30天存在续费证书则替换
注意:此字段可能返回 null,表示取不到有效值。
MessageTypes Array of Integer 托管发送消息类型:0,托管开始前消息提醒(没有续费证书也会收到该提示消息); 1, 托管开始消息提醒(存在续费证书才会收到消息提醒); 2, 托管资源替换失败消息提醒; 3 托管资源替换成功消息提醒
注意:此字段可能返回 null,表示取不到有效值。

LighthouseInstanceDetail

Lighthouse实例

被如下接口引用:DescribeHostLighthouseInstanceList。

名称 类型 描述
InstanceId String 实例ID
示例值:asfgas
InstanceName String 实例名称
示例值:gsehsd
IP Array of String IP地址
Domain Array of String 可选择域名

LiveInstanceDetail

live实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostLiveInstanceList, DescribeHostWafInstanceList。

名称 类型 描述
Domain String 域名
CertId String 已绑定的证书ID
注意:此字段可能返回 null,表示取不到有效值。
Status Integer -1:域名未关联证书。
1: 域名https已开启。
0: 域名https已关闭。

LiveInstanceList

live实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
TotalCount Integer 该地域下live实例总数
InstanceList Array of LiveInstanceDetail live实例详情
注意:此字段可能返回 null,表示取不到有效值。
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

ManagerInfo

管理人信息

被如下接口引用:DescribeManagers。

名称 类型 描述
Status String 状态: audit: 审核中 ok: 审核通过 invalid: 失效 expiring: 即将过期 expired: 已过期
ManagerFirstName String 管理人姓名
ManagerLastName String 管理人姓名
ManagerPosition String 管理人职位
ManagerPhone String 管理人电话
ManagerMail String 管理人邮箱
ManagerDepartment String 管理人所属部门
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
DomainCount Integer 管理人域名数量
CertCount Integer 管理人证书数量
ManagerId Integer 管理人ID
ExpireTime String 审核有效到期时间
注意:此字段可能返回 null,表示取不到有效值。
SubmitAuditTime String 最近一次提交审核时间
注意:此字段可能返回 null,表示取不到有效值。
VerifyTime String 审核通过时间
注意:此字段可能返回 null,表示取不到有效值。
StatusInfo Array of ManagerStatusInfo 具体审核状态信息
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tags 标签
注意:此字段可能返回 null,表示取不到有效值。

ManagerStatusInfo

管理人的四种审核状态

被如下接口引用:DescribeManagerDetail, DescribeManagers。

名称 类型 描述
Type String 审核类型,枚举值:ov,ev,cs,ev_cs
注意:此字段可能返回 null,表示取不到有效值。
Status String 审核状态,枚举值:pending,completed,invalid,submitted,expiring,expired
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 过期时间
注意:此字段可能返回 null,表示取不到有效值。

OperationLog

证书操作日志。

被如下接口引用:DescribeCertificateOperateLogs。

名称 类型 描述
Action String 操作证书动作。
CreatedOn Timestamp 操作时间。
Uin String 主账号
注意:此字段可能返回 null,表示取不到有效值。
SubAccountUin String 子账号
注意:此字段可能返回 null,表示取不到有效值。
CertId String 证书ID
注意:此字段可能返回 null,表示取不到有效值。
Type String 操作
注意:此字段可能返回 null,表示取不到有效值。

PackageInfo

权益包基本信息

被如下接口引用:DescribePackages。

名称 类型 描述
PackageId String 权益包ID。
Total Integer 权益包内权益点总量。
Balance Integer 权益包内权益点余量。
Type String 权益包名称。
SourceUin Integer 权益点是转入时,来源信息。
注意:此字段可能返回 null,表示取不到有效值。
Status String 权益点状态。
ExpireTime String 过期时间。
UpdateTime String 更新时间。
CreateTime String 生成时间。
SourceType String 来源类型。
TransferOutInfos Array of PackageTransferOutInfo 转移信息。
注意:此字段可能返回 null,表示取不到有效值。

PackageTransferOutInfo

权益包转出详情

被如下接口引用:DescribePackages。

名称 类型 描述
PackageId String 权益包ID。
TransferCode String 转移码。
TransferCount Integer 本次转移点数。
ReceivePackageId String 转入的PackageID。
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 本次转移过期时间。
CreateTime String 本次转移生成时间。
UpdateTime String 本次转移更新时间。
TransferStatus String 转移状态。
ReceiverUin Integer 接收者uin。
注意:此字段可能返回 null,表示取不到有效值。
ReceiveTime String 接收时间。
注意:此字段可能返回 null,表示取不到有效值。

PreAuditInfo

预审核信息列表

被如下接口引用:DescribeCertificates。

名称 类型 描述
TotalPeriod Integer 证书总年限
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NowPeriod Integer 证书当前年限
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ManagerId String 证书预审核管理人ID
注意:此字段可能返回 null,表示取不到有效值。

ProjectInfo

获取证书列表(DescribeCertificates)返回参数键为 Certificates 下,key为 ProjectInfo 的内容。

被如下接口引用:DescribeCertificates。

名称 类型 描述
ProjectName String 项目名称。
注意:此字段可能返回 null,表示取不到有效值。
ProjectCreatorUin Integer 项目创建用户 UIN。
注意:此字段可能返回 null,表示取不到有效值。
ProjectCreateTime String 项目创建时间。
注意:此字段可能返回 null,表示取不到有效值。
ProjectResume String 项目信息简述。
注意:此字段可能返回 null,表示取不到有效值。
OwnerUin Integer 用户 UIN。
注意:此字段可能返回 null,表示取不到有效值。
ProjectId String 项目 ID。
注意:此字段可能返回 null,表示取不到有效值。

ResourceTypeRegions

云资源地域列表

被如下接口引用:UpdateCertificateInstance。

名称 类型 必选 描述
ResourceType String 云资源类型
Regions Array of String 地域列表

RevokeDomainValidateAuths

返回参数键为 RevokeDomainValidateAuths 的内容。

被如下接口引用:RevokeCertificate。

名称 类型 描述
DomainValidateAuthPath String DV 认证值路径。
注意:此字段可能返回 null,表示取不到有效值。
DomainValidateAuthKey String DV 认证 KEY。
注意:此字段可能返回 null,表示取不到有效值。
DomainValidateAuthValue String DV 认证值。
注意:此字段可能返回 null,表示取不到有效值。
DomainValidateAuthDomain String DV 认证域名。
注意:此字段可能返回 null,表示取不到有效值。

RootCertificates

根证书

被如下接口引用:DescribeCertificateDetail。

名称 类型 描述
Sign String 国密签名证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:asd
Encrypt String 国密加密证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:asd
Standard String 标准证书
注意:此字段可能返回 null,表示取不到有效值。
示例值:asc

SubmittedData

获取证书列表(DescribeCertificate)返回参数键为 SubmittedData 的内容。

被如下接口引用:DescribeCertificate, DescribeCertificateDetail。

名称 类型 必选 描述
CsrType String CSR 类型,(online = 在线生成CSR,parse = 粘贴 CSR)。
注意:此字段可能返回 null,表示取不到有效值。
CsrContent String CSR 内容。
注意:此字段可能返回 null,表示取不到有效值。
CertificateDomain String 域名信息。
注意:此字段可能返回 null,表示取不到有效值。
DomainList Array of String DNS 信息。
注意:此字段可能返回 null,表示取不到有效值。
KeyPassword String 私钥密码。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationName String 企业或单位名称。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationDivision String 部门。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationAddress String 地址。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationCountry String 国家。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationCity String 市。
注意:此字段可能返回 null,表示取不到有效值。
OrganizationRegion String 省。
注意:此字段可能返回 null,表示取不到有效值。
PostalCode String 邮政编码。
注意:此字段可能返回 null,表示取不到有效值。
PhoneAreaCode String 座机区号。
注意:此字段可能返回 null,表示取不到有效值。
PhoneNumber String 座机号码。
注意:此字段可能返回 null,表示取不到有效值。
AdminFirstName String 管理员名。
注意:此字段可能返回 null,表示取不到有效值。
AdminLastName String 管理员姓。
注意:此字段可能返回 null,表示取不到有效值。
AdminPhoneNum String 管理员电话号码。
注意:此字段可能返回 null,表示取不到有效值。
AdminEmail String 管理员邮箱地址。
注意:此字段可能返回 null,表示取不到有效值。
AdminPosition String 管理员职位。
注意:此字段可能返回 null,表示取不到有效值。
ContactFirstName String 联系人名。
注意:此字段可能返回 null,表示取不到有效值。
ContactLastName String 联系人姓。
注意:此字段可能返回 null,表示取不到有效值。
ContactNumber String 联系人电话号码。
注意:此字段可能返回 null,表示取不到有效值。
ContactEmail String 联系人邮箱地址,
注意:此字段可能返回 null,表示取不到有效值。
ContactPosition String 联系人职位。
注意:此字段可能返回 null,表示取不到有效值。
VerifyType String 验证类型。
注意:此字段可能返回 null,表示取不到有效值。

SupportDownloadType

支持下载的类型

被如下接口引用:DescribeCertificates。

名称 类型 描述
NGINX Boolean 是否可以下载nginx可用格式
APACHE Boolean 是否可以下载apache可用格式
TOMCAT Boolean 是否可以下载tomcat可用格式
IIS Boolean 是否可以下载iis可用格式
JKS Boolean 是否可以下载JKS可用格式
OTHER Boolean 是否可以下载其他格式
ROOT Boolean 是否可以下载根证书

SyncTaskBindResourceResult

异步任务证书关联云资源结果

被如下接口引用:DescribeCertificateBindResourceTaskResult。

名称 类型 描述
TaskId String 任务ID
BindResourceResult Array of BindResourceResult 关联云资源结果
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 关联云资源异步查询结果: 0表示查询中, 1表示查询成功。 2表示查询异常; 若状态为1,则查看BindResourceResult结果;若状态为2,则查看Error原因
Error Error 关联云资源错误信息
注意:此字段可能返回 null,表示取不到有效值。
CacheTime String 当前结果缓存时间

TCBAccessInstance

TCB访问服务实例

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 状态
注意:此字段可能返回 null,表示取不到有效值。
UnionStatus Integer 统一域名状态

注意:此字段可能返回 null,表示取不到有效值。
IsPreempted Boolean 是否被抢占, 被抢占表示域名被其他环境绑定了,需要解绑或者重新绑定。

注意:此字段可能返回 null,表示取不到有效值。
ICPStatus Integer icp黑名单封禁状态,0-未封禁,1-封禁

注意:此字段可能返回 null,表示取不到有效值。
OldCertificateId String 已绑定证书ID
注意:此字段可能返回 null,表示取不到有效值。

TCBAccessService

TCB访问服务列表

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
InstanceList Array of TCBAccessInstance 实例列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 数量
注意:此字段可能返回 null,表示取不到有效值。

TCBEnvironment

TCB环境

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
ID String 唯一ID
注意:此字段可能返回 null,表示取不到有效值。
Source String 来源
注意:此字段可能返回 null,表示取不到有效值。
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。

TCBEnvironments

tcb环境实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Environment TCBEnvironment tcb环境
注意:此字段可能返回 null,表示取不到有效值。
AccessService TCBAccessService 访问服务
注意:此字段可能返回 null,表示取不到有效值。
HostService TCBHostService 静态托管
注意:此字段可能返回 null,表示取不到有效值。

TCBHostInstance

TCB静态托管服务实例

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Domain String 域名
注意:此字段可能返回 null,表示取不到有效值。
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
DNSStatus String 解析状态
注意:此字段可能返回 null,表示取不到有效值。
OldCertificateId String 已绑定证书ID
注意:此字段可能返回 null,表示取不到有效值。

TCBHostService

TCB静态托管服务列表

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
InstanceList Array of TCBHostInstance 实例列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 数量
注意:此字段可能返回 null,表示取不到有效值。

TCBInstanceList

tcb地域实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
Environments Array of TCBEnvironments tcb环境实例详情
注意:此字段可能返回 null,表示取不到有效值。
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

TSEInstanceDetail

tse实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
GatewayId String 网关ID
注意:此字段可能返回 null,表示取不到有效值。
GatewayName String 网关名称
注意:此字段可能返回 null,表示取不到有效值。
CertificateList Array of GatewayCertificate 网关证书列表
注意:此字段可能返回 null,表示取不到有效值。

TSEInstanceList

TSE实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
InstanceList Array of TSEInstanceDetail TSE实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下TSE实例总数
Region String 地域
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

Tags

标签

被如下接口引用:CreateCertificate, CreateCertificateByPackage, DescribeCertificate, DescribeCertificateDetail, DescribeCertificates, DescribeCompanies, DescribeManagerDetail, DescribeManagers, UpdateCertificateInstance, UploadCertificate。

名称 类型 必选 描述
TagKey String 标签键
TagValue String 标签值

TeoInstanceDetail

teo实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostTeoInstanceList。

名称 类型 描述
Host String 域名
CertId String 证书ID
ZoneId String 区域ID
注意:此字段可能返回 null,表示取不到有效值。
Status String 域名状态

TeoInstanceList

edgeone实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
InstanceList Array of TeoInstanceDetail edgeone实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer edgeone实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

TkeIngressDetail

tke ingress实例详情

被如下接口引用:DescribeHostTkeInstanceList。

名称 类型 描述
IngressName String ingress名称
TlsDomains Array of String tls域名列表
Domains Array of String ingress域名列表

TkeInstanceDetail

tke实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostTkeInstanceList。

名称 类型 描述
ClusterId String 集群ID
ClusterName String 集群名称
NamespaceList Array of TkeNameSpaceDetail 集群命名空间列表
ClusterType String 集群类型
ClusterVersion String 集群版本

TkeInstanceList

tke实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
InstanceList Array of TkeInstanceDetail tke实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下tke实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

TkeNameSpaceDetail

tke namespace详情

被如下接口引用:DescribeHostTkeInstanceList。

名称 类型 描述
Name String namespace名称
SecretList Array of TkeSecretDetail secret列表

TkeSecretDetail

tke secret详情

被如下接口引用:DescribeHostTkeInstanceList。

名称 类型 描述
Name String secret名称
CertId String 证书ID
IngressList Array of TkeIngressDetail ingress列表
NoMatchDomains Array of String 和新证书不匹配的域名列表
注意:此字段可能返回 null,表示取不到有效值。

UpdateRecordDetail

更新记录详情

被如下接口引用:DescribeHostUpdateRecordDetail。

名称 类型 描述
Id Integer 详情记录id
CertId String 新证书ID
OldCertId String 旧证书ID
Domains Array of String 部署域名列表
注意:此字段可能返回 null,表示取不到有效值。
ResourceType String 部署资源类型
Region String 部署地域
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 部署状态
ErrorMsg String 部署错误信息
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 部署时间
UpdateTime String 最后一次更新时间
InstanceId String 部署实例ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 部署实例名称
注意:此字段可能返回 null,表示取不到有效值。
ListenerId String 部署监听器ID(CLB专用)
注意:此字段可能返回 null,表示取不到有效值。
ListenerName String 部署监听器名称(CLB专用)
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 协议
注意:此字段可能返回 null,表示取不到有效值。
SniSwitch Integer 是否开启SNI(CLB专用)
注意:此字段可能返回 null,表示取不到有效值。
Bucket String bucket名称(COS专用)
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 端口
注意:此字段可能返回 null,表示取不到有效值。
Namespace String 命名空间(TKE专用)
注意:此字段可能返回 null,表示取不到有效值。
SecretName String secret名称(TKE专用)
注意:此字段可能返回 null,表示取不到有效值。
EnvId String 环境ID
注意:此字段可能返回 null,表示取不到有效值。
TCBType String TCB部署类型
注意:此字段可能返回 null,表示取不到有效值。
Url String 监听器Url(clb专属)
注意:此字段可能返回 null,表示取不到有效值。

UpdateRecordDetails

更新记录详情列表

被如下接口引用:DescribeHostUpdateRecordDetail。

名称 类型 描述
ResourceType String 部署资源类型
List Array of UpdateRecordDetail 部署资源详情列表
TotalCount Integer 该部署资源总数

UpdateRecordInfo

部署记录信息

被如下接口引用:DescribeHostUpdateRecord。

名称 类型 描述
Id Integer 记录ID
CertId String 新证书ID
OldCertId String 原证书ID
ResourceTypes Array of String 部署资源类型列表
Regions Array of String 部署地域列表
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 部署状态
CreateTime String 部署时间
UpdateTime String 最后一次更新时间

UpdateSyncProgress

更新异步任务进度

被如下接口引用:UpdateCertificateInstance。

名称 类型 描述
ResourceType String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
UpdateSyncProgressRegions Array of UpdateSyncProgressRegion 地域结果列表
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 异步更新进度状态:0, 待处理, 1 已处理, 3 处理中
注意:此字段可能返回 null,表示取不到有效值。

UpdateSyncProgressRegion

更新异步任务进度

被如下接口引用:UpdateCertificateInstance。

名称 类型 描述
Region String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:地域
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:总数
OffsetCount Integer 执行完成数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:偏移量
Status Integer 异步更新进度状态:0, 待处理, 1 已处理, 3 处理中
注意:此字段可能返回 null,表示取不到有效值。

VODInstanceList

vod实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
InstanceList Array of VodInstanceDetail vod实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下vod实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。

VodInstanceDetail

Vod实例

被如下接口引用:DescribeCertificateBindResourceTaskDetail, DescribeHostVodInstanceList。

名称 类型 描述
Domain String 域名
示例值:qq.com
CertId String 证书ID
示例值:asdasd

WafInstanceDetail

waf实例详情

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Domain String 域名
CertId String 证书ID
注意:此字段可能返回 null,表示取不到有效值。
Keepalive Integer 是否保持长连接,1是,0 否
注意:此字段可能返回 null,表示取不到有效值。

WafInstanceList

waf实例详情 - 异步关联云资源数据结构

被如下接口引用:DescribeCertificateBindResourceTaskDetail。

名称 类型 描述
Region String 地域
InstanceList Array of WafInstanceDetail waf实例详情
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 该地域下waf实例总数
Error String 是否查询异常
注意:此字段可能返回 null,表示取不到有效值。