{ "name": "ssl", "display_name": "SSL 证书", "description": "介绍如何使用 API对证书进行操作，包括提交证书资料、提交证书订单，重颁发证书等。", "domain": "security", "api_version": "2019-12-05", "endpoint": "ssl.tencentcloudapi.com", "actions": [ { "name": "ApplyCertificate", "description": "本接口（ApplyCertificate）用于免费证书申请。", "status": "online", "parameters": [ { "name": "DvAuthMethod", "type": "string", "required": true, "description": "证书域名验证方式： DNS_AUTO： 自动添加域名DNS验证， 需用户域名解析托管在『[云解析DNS](https://console.cloud.tencent.com/cns)』，且与申请证书归属同一个腾讯云账号 DNS：手动添加域名DNS验证，需用户手动去域名解析服务商添加验证值 FILE：手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证， http\u0026https任一通过即可；且域名站点需海外CA机构能\ufffd\ufffd...", "example": "DNS_AUTO" }, { "name": "DomainName", "type": "string", "required": true, "description": "证书绑定的域名。", "example": "tencent.com" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "证书关联的项目 ID。 默认为0（默认项目）", "example": "0" }, { "name": "PackageType", "type": "string", "required": false, "description": "证书类型， 可不传，目前仅支持类型83。83 = TrustAsia C1 DV Free。", "example": "83" }, { "name": "ContactEmail", "type": "string", "required": false, "description": "证书订单关联邮箱。默认为腾讯云账号邮箱， 不存在则关联固定邮箱", "example": "ssl@tencent.com" }, { "name": "ContactPhone", "type": "string", "required": false, "description": "证书关联手机号码， 不存在则关联固定手机号码", "example": "188******778" }, { "name": "ValidityPeriod", "type": "string", "required": false, "description": "证书有效期，默认3（月），目前仅支持3个月。", "example": "3" }, { "name": "CsrEncryptAlgo", "type": "string", "required": false, "description": "加密算法，取值为ECC、RSA， 默认为RSA", "example": "RSA" }, { "name": "CsrKeyParameter", "type": "string", "required": false, "description": "密钥对参数，RSA仅支持2048。ECC仅支持prime256v1。加密算法选择ECC时，此参数必填", "example": "2048" }, { "name": "CsrKeyPassword", "type": "string", "required": false, "description": "私钥密码， 目前仅使用在生成jks、pfx格式证书时密码； 其他格式私钥证书未加密", "example": "******" }, { "name": "Alias", "type": "string", "required": false, "description": "证书别名", "example": "******" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "旧证书 ID，用于证书续费（证书有效期在30天内，且未过期），会建立续费关系， 可用于托管； 不传则表示新申请证书", "example": "LqQxgqUe" }, { "name": "PackageId", "type": "string", "required": false, "description": "权益包ID，用于免费证书扩容包使用， 免费证书扩容包已下线", "example": "pid****xsj" }, { "name": "DeleteDnsAutoRecord", "type": "boolean", "required": false, "description": "签发后是否删除自动域名验证记录， 默认为否；仅域名为DNS_AUTO验证类型支持传参", "example": "true" }, { "name": "DnsNames", "type": "array", "required": false, "description": "证书绑定的其他域名，待开放。目前不支持此参数", "example": "[\"www.tencent.com\"]", "item_type": "string" } ], "required": [ "DvAuthMethod", "DomainName" ] }, { "name": "CancelAuditCertificate", "description": "取消证书审核", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID", "example": "hehk**js" } ], "required": [ "CertificateId" ] }, { "name": "CancelCertificateOrder", "description": "取消证书订单。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "heh**jsj" } ], "required": [ "CertificateId" ] }, { "name": "CertificateInfoSubmit", "description": "付费提交证书资料", "status": "online", "parameters": [ { "name": "CertId", "type": "string", "required": true, "description": "待提交资料的付费证书 ID。", "example": "LrmeMvQr" }, { "name": "GenCsrType", "type": "string", "required": true, "description": "此字段必传。 CSR 生成方式， 取值为： - online：腾讯云提交的填写的参数信息生成CSR和私钥，并由腾讯云加密存储 - parse：自行生成CSR和私钥，并通过上传CSR申请证书", "example": "parse" }, { "name": "CertCommonName", "type": "string", "required": true, "description": "证书绑定的通用名称， 若是上传的CSR，则该域名需与CSR解析的通用名称一致", "example": "tencent.com" }, { "name": "CompanyType", "type": "integer", "required": true, "description": "组织信息类型， 取值范围： 1（个人）：仅DV类型证书可设置为1， 个人类型证书组织信息字段可不传：Org开头，Admin开头，Tech开头 2（公司）：所有类型证书都可设置为2， 按需传组织信息字段", "example": "2" }, { "name": "CompanyId", "type": "string", "required": true, "description": "公司ID，在 [腾讯云控制台](https://console.cloud.tencent.com/ssl/info) 可进行查看，若无满足的公司信息， 则本参数传0 ； 若存在满足当前订单的公司信息， 可以根据 [DescribeCompanies](https://cloud.tencent.com/document/product/400/90375) 查看公司ID； 若传了公司ID，则Org开头的参数可不传", "example": "11772" }, { "name": "OrgIdType", "type": "string", "required": false, "description": "公司证件类型，取值范围： TYDMZ（统一社会信用代码 ）：仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段 OTHERS（其他）", "example": "TYDMZ" }, { "name": "OrgIdNumber", "type": "string", "required": false, "description": "公司证件号码，取值范围： TYDMZ（统一社会信用代码 ）：11532xxxxxxxx24820", "example": "914400002111711112" }, { "name": "AdminIdType", "type": "string", "required": false, "description": "管理人证件类型，取值范围： SFZ（身份证）：仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段 HZ（护照）：仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段", "example": "SFZ" }, { "name": "AdminIdNumber", "type": "string", "required": false, "description": "管理人证件号码，仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段， 取值范围： SFZ（身份证）：110000xxxxxxxx1242 HZ（护照）:EFxxxxxxx", "example": "110000199101011001" }, { "name": "TechIdType", "type": "string", "required": false, "description": "联系人证件类型，取值范围： SFZ（身份证）：仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段 HZ（护照）：仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段", "example": "SFZ" }, { "name": "TechIdNumber", "type": "string", "required": false, "description": "联系人证件号码，仅CFCA类型证书需要使用本字段， 其他类型证书不需要使用本字段，取值范围： SFZ（身份证）：110000xxxxxxxx1242 HZ（护照）:EFxxxxxxx", "example": "110000199101011001" }, { "name": "Csr", "type": "string", "required": false, "description": "上传的 CSR 内容。 若GenCsrType为parse， 则此字段必传。", "example": "-----BEGIN CERTIFICATE REQUEST-----\\nxxxxxxxxx\\n-----END CERTIFICATE REQUEST-----" }, { "name": "DnsNames", "type": "array", "required": false, "description": "证书绑定的其他域名， 单域名、泛域名证书无需提供。 多域名、多泛域名必填", "example": "[\"test.tencent.com\"]", "item_type": "string" }, { "name": "KeyPass", "type": "string", "required": false, "description": "私钥密码， 目前仅使用在生成jks、pfx格式证书时密码； 其他格式私钥证书未加密", "example": "1234aaa5678" }, { "name": "OrgOrganization", "type": "string", "required": false, "description": "公司名称。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "腾讯云SSL证书测试" }, { "name": "OrgDivision", "type": "string", "required": false, "description": "部门名称。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "研发部门" }, { "name": "OrgAddress", "type": "string", "required": false, "description": "公司详细地址。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "腾讯云SSL证书测试地址" }, { "name": "OrgCountry", "type": "string", "required": false, "description": "国家名称，如中国：CN 。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "CN" }, { "name": "OrgCity", "type": "string", "required": false, "description": "公司所在城市。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "北京市" }, { "name": "OrgRegion", "type": "string", "required": false, "description": "公司所在省份。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "北京市" }, { "name": "OrgPhoneArea", "type": "string", "required": false, "description": "公司所属区号。若没有传CompanyId或者ManagerId， 则此字段必传 如：021。 手机号码传 86", "example": "010" }, { "name": "OrgPhoneNumber", "type": "string", "required": false, "description": "公司所属号码。若没有传CompanyId或者ManagerId， 则此字段必传", "example": "8423102" }, { "name": "VerifyType", "type": "string", "required": false, "description": "证书域名验证方式： DNS_AUTO： 自动添加域名DNS验证， 需用户域名解析托管在『[云解析DNS](https://console.cloud.tencent.com/cns)』，且与申请证书归属同一个腾讯云账号 DNS：手动添加域名DNS验证，需用户手动去域名解析服务商添加验证值 FILE：手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证， http\u0026https任一通过即可；且域名站点需海外CA机构能\ufffd\ufffd...", "example": "DNS" }, { "name": "AdminFirstName", "type": "string", "required": false, "description": "管理人名。若没有传ManagerId， 则此字段必传", "example": "宁" }, { "name": "AdminLastName", "type": "string", "required": false, "description": "管理人姓。若没有传ManagerId， 则此字段必传", "example": "黄" }, { "name": "AdminPhone", "type": "string", "required": false, "description": "管理人手机号码。若没有传ManagerId， 则此字段必传", "example": "13120934321" }, { "name": "AdminEmail", "type": "string", "required": false, "description": "管理人邮箱地址。若没有传ManagerId， 则此字段必传", "example": "ssl@tencent.com" }, { "name": "AdminTitle", "type": "string", "required": false, "description": "管理人职位。若没有传ManagerId， 则此字段必传", "example": "研发" }, { "name": "TechFirstName", "type": "string", "required": false, "description": "联系人名。若没有传ManagerId， 则此字段必传", "example": "宁" }, { "name": "TechLastName", "type": "string", "required": false, "description": "联系人姓。若没有传ManagerId， 则此字段必传", "example": "黄" }, { "name": "ContactEmail", "type": "string", "required": false, "description": "联系人邮箱地址。CompanyType为1时， 此字段必传", "example": "ssl@tencent.com" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "是否开启自动续费： 0， 不开启； 1， 开启； 默认为0", "example": "1" }, { "name": "CsrKeyParameter", "type": "string", "required": false, "description": "密钥对参数，RSA支持2048，4096。ECC仅支持prime256v1。当 CSR 生成方式为online的时候，此参数必填。", "example": "2048" }, { "name": "CsrEncryptAlgo", "type": "string", "required": false, "description": "加密算法，取值为ECC、RSA， 默认为RSA。当 CSR 生成方式为online的时候，此参数必填。", "example": "RSA" }, { "name": "ManagerId", "type": "string", "required": false, "description": "管理人ID，在 [腾讯云控制台](https://console.cloud.tencent.com/ssl/info) 可进行查看，若无满足的管理人信息， 则本参数传0 ； 若存在满足当前订单的管理人信息， 可以根据 [DescribeManagers](https://cloud.tencent.com/document/product/400/52672) 查看管理人ID； 若传了管理人ID，则Org开头、Admin开头、Tech开头的参数可不传； 管理人ID会包含公司信息", "example": "12895" }, { "name": "TechPhone", "type": "string", "required": false, "description": "联系人电话。若没有传ManagerId， 则此字段必传", "example": "13120934321" }, { "name": "TechEmail", "type": "string", "required": false, "description": "联系人邮箱", "example": "ssl@tencent.com" }, { "name": "TechTitle", "type": "string", "required": false, "description": "联系人职位。若没有传ManagerId， 则此字段必传", "example": "研发" }, { "name": "Type", "type": "integer", "required": false, "description": "证书类型", "example": "81" }, { "name": "CaType", "type": "string", "required": false, "description": "只针对Dnspod系列证书有效，ca机构类型可为sectigo和digicert", "example": "sectigo" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法", "example": "SHA256" }, { "name": "UseCrossSignRoot", "type": "boolean", "required": false, "description": "是否使用交叉根证书", "example": "true" } ], "required": [ "CertId", "GenCsrType", "CertCommonName", "CompanyType", "CompanyId" ] }, { "name": "CertificateOrderSubmit", "description": "提交付费证书订单", "status": "online", "parameters": [ { "name": "CertId", "type": "string", "required": true, "description": "待提交资料的付费证书 ID。", "example": "Lr1eMvQr" }, { "name": "DeleteDnsAutoRecord", "type": "integer", "required": false, "description": "是否删除自动DNS验证值：0，不删除； 1，删除； 默认不删除", "example": "0" }, { "name": "VerifyType", "type": "string", "required": false, "description": "证书域名验证方式： DNS_AUTO： 自动添加域名DNS验证， 需用户域名解析托管在『[云解析DNS](https://console.cloud.tencent.com/cns)』，且与申请证书归属同一个腾讯云账号 DNS：手动添加域名DNS验证，需用户手动去域名解析服务商添加验证值 FILE：手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证， http\u0026https任一通过即可；且域名站点需海外CA机构能\ufffd\ufffd...", "example": "DNS" } ], "required": [ "CertId" ] }, { "name": "CheckCertificateChain", "description": "本接口（CheckCertificateChain）用于检查证书链是否完整。", "status": "online", "parameters": [ { "name": "CertificateChain", "type": "string", "required": true, "description": "待检查的证书链", "example": "hehys**hsh" } ], "required": [ "CertificateChain" ] }, { "name": "CheckCertificateDomainVerification", "description": "检查证书域名验证结果", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID。", "example": "Lmvo5PJy" } ], "required": [ "CertificateId" ] }, { "name": "CheckCertificateExist", "description": "根据证书内容检测当前账号下是否存在一致的证书， 存在则返回证书ID， 不存在则返回空", "status": "online", "parameters": [ { "name": "CertificatePublicKey", "type": "string", "required": true, "description": "证书公钥内容， 包含证书链", "example": "-----BEGIN CERTIFICATE-----\\nMIIFGDCCBACgAwIBAgISBPCgHOEnsbZ-----END CERTIFICATE-----" } ], "required": [ "CertificatePublicKey" ] }, { "name": "CommitCertificateInformation", "description": "付费证书提交订单； 本接口不维护新功能， 可使用新接口进行提交， [CertificateOrderSubmit](https://cloud.tencent.com/document/product/400/116032)", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "待提交资料的付费证书 ID。", "example": "LqQxgqUe" }, { "name": "VerifyType", "type": "string", "required": false, "description": "证书域名验证方式： DNS_AUTO： 自动添加域名DNS验证， 需用户域名解析托管在『[云解析DNS](https://console.cloud.tencent.com/cns)』，且与申请证书归属同一个腾讯云账号 DNS：手动添加域名DNS验证，需用户手动去域名解析服务商添加验证值 FILE：手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证， http\u0026https任一通过即可；且域名站点需海外CA机构能\ufffd\ufffd...", "example": "DNS" } ], "required": [ "CertificateId" ] }, { "name": "CompleteCertificate", "description": "本接口（CompleteCertificate）用于主动触发证书验证。DNSPod和Wotrus品牌的证书不支持使用此接口。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID", "example": "hey**js" } ], "required": [ "CertificateId" ] }, { "name": "CreateCertificate", "description": "本接口（CreateCertificate）用于创建付费证书。", "status": "online", "parameters": [ { "name": "ProductId", "type": "integer", "required": true, "description": "证书套餐类型：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：Tr...", "example": "25" }, { "name": "DomainNum", "type": "integer", "required": true, "description": "证书包含的域名数量。 多域名或者多泛域名证书类型必须大于1", "example": "1" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "证书年限。 支持多年期的证书才可以大于1年", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券：1是，0否；默认为1", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签， 生成证书打标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "ProductId", "DomainNum", "TimeSpan" ] }, { "name": "CreateCertificateBindResourceSyncTask", "description": "创建证书绑定关联云资源异步任务， 该接口用于查询证书关联云资源。 若证书ID已存在查询云资源任务，则结果返回该任务ID。关联云资源类型，支持以下云资源：clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo（edgeOne）、cos。查询关联云资源结果使用DescribeCertificateBindResourceTaskResult接口", "status": "online", "parameters": [ { "name": "CertificateIds", "type": "array", "required": true, "description": "证书ID列表，总数不能超过100", "example": "[\"heyxsh**jjs\"]", "item_type": "string" }, { "name": "IsCache", "type": "integer", "required": true, "description": "是否使用缓存， 1使用缓存，0不使用缓存； 默认为1使用缓存； 若当前证书ID存在半小时已完成的任务， 则使用缓存的情况下， 会读取半小时内离当前时间最近的查询结果", "example": "1" } ], "required": [ "CertificateIds", "IsCache" ] }, { "name": "CreateCertificateByPackage", "description": "使用权益点创建证书", "status": "online", "parameters": [ { "name": "ProductPid", "type": "integer", "required": true, "description": "证书产品PID，以下是对每个PID及其对应的证书文字说明： 1. 1022451 - CFCA-增强型(EV)SSL证书 2. 1022449 - CFCA-企业型(OV) SSL证书(通配符) 3. 1022447 - CFCA-企业型(OV)SSL证书 4. 1014028 - DNSPod亚信国密-企业型(OV)通配符证书 5. 1014030 - DNSPod亚信国密-企业型(OV)多域名证书 6. 1014026 - DNSPod亚信国密-企业型(OV)证书 7. 1014022 - DNSPod亚信国密-域名型(DV)通配符证书 8. 1014024 - DNSPod亚信国密-域名型(DV)多域名...", "example": "1022451" }, { "name": "PackageIds", "type": "array", "required": true, "description": "要消耗的权益包ID。", "example": "[\"Z21120315430001\"]", "item_type": "string" }, { "name": "DomainCount", "type": "string", "required": true, "description": "证书域名数量。", "example": "4" }, { "name": "Period", "type": "integer", "required": true, "description": "多年期证书年限。", "example": "2" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "要续费的原证书ID（续费时填写）。", "example": "heh**hsh" }, { "name": "RenewGenCsrMethod", "type": "string", "required": false, "description": "续费时CSR生成方式（original、upload、online）。", "example": "original" }, { "name": "RenewCsr", "type": "string", "required": false, "description": "续费时选择上传CSR时填写CSR。", "example": "CSR" }, { "name": "RenewAlgorithmType", "type": "string", "required": false, "description": "续费证书CSR的算法类型：RSA,ECC,SM2", "example": "RSA" }, { "name": "RenewAlgorithmParam", "type": "string", "required": false, "description": "续费证书CSR的算法参数:2048,4096,prime256v1", "example": "2048" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。", "example": "6737992" }, { "name": "Tags", "type": "array", "required": false, "description": "标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "RenewKeyPass", "type": "string", "required": false, "description": "续费证书的私钥密码。", "example": "hehy**hwhwh" }, { "name": "DomainNames", "type": "string", "required": false, "description": "批量购买证书时预填写的域名。", "example": "a.com,b.com,c.com" }, { "name": "CertificateCount", "type": "integer", "required": false, "description": "批量购买证书数量。", "example": "2" }, { "name": "ManagerId", "type": "integer", "required": false, "description": "预填写的管理人ID。", "example": "197382" }, { "name": "CompanyId", "type": "integer", "required": false, "description": "预填写的公司ID。", "example": "6782" }, { "name": "VerifyType", "type": "string", "required": false, "description": "验证方式", "example": "DNS" }, { "name": "PriceKey", "type": "string", "required": false, "description": "询价参数，以下是对每个询价参数及其对应的证书文字说明： 1. sv_ssl_cost_cfca_ca_ev - CFCA-增强型(EV)SSL证书 2. sv_ssl_cost_cfca_ca_ovwildcard - CFCA-企业型(OV) SSL证书(通配符) 3. sv_ssl_cost_cfca_ca_ov - CFCA-企业型(OV)SSL证书 4. sv_ssl_cost_dnspod_ca_sm2_ovwildcard - DNSPod亚信国密-企业型(OV)通配符证书 5. sv_ssl_cost_dnspod_ca_sm2_ovmultidomain - DNSPod亚信国密-企业型(OV)多域名证书 6. sv_ssl_cost_dnspod_ca_sm2_ov - DNSPod亚信\ufffd...", "example": "sv_ssl_cost_cfca_ca_ev" } ], "required": [ "ProductPid", "PackageIds", "DomainCount", "Period" ] }, { "name": "DeleteCertificate", "description": "本接口（DeleteCertificate）用于删除证书。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "qwrqwr1" }, { "name": "IsCheckResource", "type": "boolean", "required": false, "description": "删除时是否检查证书关联了云资源。默认不检查。如选择检查(需要授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate)删除将变成异步,接口会返回异步任务ID。需使用DescribeDeleteCertificatesTaskResult接口查询删除是否成功。", "example": "true" } ], "required": [ "CertificateId" ] }, { "name": "DeleteCertificates", "description": "批量删除证书，删除证书前支持查询证书是否关联了腾讯云云资源 （需自定义配置参数，参数名称：IsSync）", "status": "online", "parameters": [ { "name": "CertificateIds", "type": "array", "required": true, "description": "要删除的证书ID。单次最多100个", "example": "[\"jej**hh\",\"jhshx\"]", "item_type": "string" }, { "name": "IsSync", "type": "boolean", "required": false, "description": "删除时是否检查证书关联了云资源。默认不检查。如需要检查关联云资源 (需授权服务角色SSL_QCSLinkedRoleInReplaceLoadCertificate)，完成授权后且该参数传true，删除将变成异步任务，接口会返回异步任务ID。需搭配 DescribeDeleteCertificatesTaskResult接口使用，查询删除任务是否成功。", "example": "true" } ], "required": [ "CertificateIds" ] }, { "name": "DeleteManager", "description": "删除管理人", "status": "online", "parameters": [ { "name": "ManagerId", "type": "integer", "required": true, "description": "管理人ID", "example": "677838" } ], "required": [ "ManagerId" ] }, { "name": "DeployCertificateInstance", "description": "证书部署到云资源实例列表，本接口只会创建部署任务， 部署任务结果可通过DescribeHostDeployRecordDetail查询。本接口创建部署任务时，会校验证书和部署实例的匹配关系，存在不匹配的则会创建部署任务失败。以下为匹配关系校验规则： - 若待部署的证书和传入实例域名的当前绑定的证书一致， 则不会创建成功 - 若待部署的证书和传入域名不匹配， 则不会创建成功 - 若部署clb\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "待部署的证书ID", "example": "FvuXExOA" }, { "name": "InstanceIdList", "type": "array", "required": true, "description": "证书部署的实例列表，不同云资源类型如下 - clb：若监听器开启了SNI，则需要指定到域名LoadBalancerId|ListenerId|Domain，例：[\"lb-bid2fs4g|lbl-a8af11gs|tencent.com\"]，若监听器未开启SNI或者为四层监听器，则指定到监听器，例：[\"lb-bid2fs4g|lbl-1c6rp5eo\"] - cdn：Domain|计费开关，例：[\"cdn2.tencent.com|off\", \"cdn.tencent.com|on\"] - ddos：InsId|Domain|VirtualPort，例：[\"bgpip-000001ms|tencent.com|443\"] - live：Domain，例：[\"liv...", "example": "[\"lb-bid2fs4g|lbl-1c6rp5eo\", \"lb-bid2fs4g|lbl-a8af11gs|tencent.com\"]", "item_type": "string" }, { "name": "ResourceType", "type": "string", "required": false, "description": "证书部署云资源支持的云资源类型， 不传则默认部署clb： - clb - cdn - ddos - live - vod - waf - apigateway - teo - tke - cos - lighthouse - tse - tcb - mqtt 当云资源类型传入clb、waf、apigateway、cos、lighthouse、tke、tse、tcb、mqtt 时，公共参数Region必传。", "example": "clb" }, { "name": "Status", "type": "integer", "required": false, "description": "部署云资源状态： 云直播： -1：域名未关联证书。 1： 域名https已开启。 0： 域名https已关闭。", "example": "0" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，默认缓存半小时", "example": "1" } ], "required": [ "CertificateId", "InstanceIdList" ] }, { "name": "DeployCertificateRecordRetry", "description": "云资源部署重试部署记录", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": false, "description": "待重试部署记录ID，通过DeployCertificateInstance获得", "example": "83838" }, { "name": "DeployRecordDetailId", "type": "integer", "required": false, "description": "待重试部署记录详情ID，通过DescribeHostDeployRecordDetail获得", "example": "848822" } ], "required": [] }, { "name": "DeployCertificateRecordRollback", "description": "云资源部署成功记录回滚， 部署失败的记录不会回滚； 接口调用成功后， 会创建一个用于回滚的部署任务， 并返回该任务的ID", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": false, "description": "待重试部署记录ID, 就是通过DeployCertificateInstance返回的DeployRecordId", "example": "7474" } ], "required": [] }, { "name": "DescribeCertificate", "description": "本接口（DescribeCertificate）用于获取证书信息。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "heysh**hh" } ], "required": [ "CertificateId" ] }, { "name": "DescribeCertificateBindResourceTaskDetail", "description": "查询CreateCertificateBindResourceSyncTask任务结果， 返回证书关联云资源异步任务结果， 支持以下云资源：clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo（edgeOne）、cos、gaap、mqtt、scf、tdmq", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，根据CreateCertificateBindResourceSyncTask得到的任务ID查询绑定云资源结果", "example": "178883" }, { "name": "Limit", "type": "string", "required": false, "description": "每页展示数量， 默认10，最大值100; 分页总数为云资源地域下实例总数， 即第一页会拉群每个云资源的地域下面Limit数量实例", "example": "0" }, { "name": "Offset", "type": "string", "required": false, "description": "当前偏移量，默认为0", "example": "10" }, { "name": "ResourceTypes", "type": "array", "required": false, "description": "查询资源类型的结果详情， 不传则查询所有，取值支持：- clb- cdn- ddos- live- vod- waf- apigateway- teo- tke- cos- tse- tcb", "example": "[\"clb\"]", "item_type": "string" }, { "name": "Regions", "type": "array", "required": false, "description": "查询地域列表的数据，clb、tke、waf、apigateway、tcb、cos、tse支持地域查询， 其他资源类型不支持", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ], "required": [ "TaskId" ] }, { "name": "DescribeCertificateBindResourceTaskResult", "description": "查询CreateCertificateBindResourceSyncTask任务结果， 返回证书关联云资源异步任务结果， 支持以下云资源：clb、cdn、waf、live、vod、ddos、tke、apigateway、tcb、teo（edgeOne）、cos", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": true, "description": "任务ID，根据CreateCertificateBindResourceSyncTask得到的任务ID查询绑定云资源结果， 最大支持100个", "example": "[\"1783883\"]", "item_type": "string" } ], "required": [ "TaskIds" ] }, { "name": "DescribeCertificateDetail", "description": "获取证书详情。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "heysh**he" } ], "required": [ "CertificateId" ] }, { "name": "DescribeCertificateOperateLogs", "description": "获取用户账号下有关证书的操作日志。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求日志数量，默认为20, 最大值为1000，如超过1000按照1000处理。", "example": "10" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间，默认15天前。", "example": "2024-11-27 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，默认现在时间。", "example": "2024-12-26 23:59:59" } ], "required": [] }, { "name": "DescribeCertificates", "description": "本接口（DescribeCertificates）用于获取证书列表。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。 默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。最大值1000，如超过1000按1000处理", "example": "11" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键词，模糊匹配证书 ID、备注名称、证书域名", "example": "string" }, { "name": "CertificateType", "type": "string", "required": false, "description": "证书类型：CA = 客户端证书，SVR = 服务器证书。", "example": "CA" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。", "example": "1" }, { "name": "ExpirationSort", "type": "string", "required": false, "description": "默认按照证书申请时间降序； 若传排序则按到期时间排序：DESC = 证书到期时间降序， ASC = 证书到期时间升序。", "example": "DESC" }, { "name": "CertificateStatus", "type": "array", "required": false, "description": "证书状态：0 = 审核中，1 = 已通过，2 = 审核失败，3 = 已过期，4 = 已添加DNS记录，5 = 企业证书，待提交，6 = 订单取消中，7 = 已取消，8 = 已提交资料， 待上传确认函，9 = 证书吊销中，10 = 已吊销，11 = 重颁发中，12 = 待上传吊销确认函，13 = 免费证书待提交资料。14 = 已退款。 15 = 证书迁移中", "example": "[1]", "item_type": "integer" }, { "name": "Deployable", "type": "integer", "required": false, "description": "是否可部署，可选值：1 = 可部署，0 = 不可部署。", "example": "1" }, { "name": "Upload", "type": "integer", "required": false, "description": "是否筛选上传托管的 1筛选，0不筛选", "example": "1" }, { "name": "Renew", "type": "integer", "required": false, "description": "是否筛选可续期证书 1筛选 0不筛选", "example": "1" }, { "name": "FilterSource", "type": "string", "required": false, "description": "筛选来源， upload：上传证书， buy：腾讯云证书， 不传默认全部", "example": "upload" }, { "name": "IsSM", "type": "integer", "required": false, "description": "是否筛选国密证书。1:筛选 0:不筛选", "example": "1" }, { "name": "FilterExpiring", "type": "integer", "required": false, "description": "筛选证书是否即将过期，传1是筛选，0不筛选", "example": "0" }, { "name": "Hostable", "type": "integer", "required": false, "description": "是否可托管，可选值：1 = 可托管，0 = 不可托管。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "筛选指定标签的证书", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "IsPendingIssue", "type": "integer", "required": false, "description": "是否筛选等待签发的证书，传1是筛选，0和null不筛选", "example": "1" }, { "name": "CertIds", "type": "array", "required": false, "description": "筛选指定证书ID的证书，只支持有权限的证书ID", "example": "[\"FxG06njc\"]", "item_type": "string" }, { "name": "ServiceId", "type": "string", "required": false, "description": "订阅服务ID", "example": "DY20257827810" } ], "required": [] }, { "name": "DescribeCompanies", "description": "查询公司列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值为0.", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页每页限制数，默认值为0，最大值1000.", "example": "10" }, { "name": "CompanyId", "type": "integer", "required": false, "description": "公司ID", "example": "17633" } ], "required": [] }, { "name": "DescribeDeleteCertificatesTaskResult", "description": "查询批量删除任务结果", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": true, "description": "DeleteCertificates接口返回的任务ID， 最大支持100个", "example": "[\"19999\",\"18888\"]", "item_type": "string" } ], "required": [ "TaskIds" ] }, { "name": "DescribeDeployedResources", "description": "证书查询关联资源， 最新查询接口请使用CreateCertificateBindResourceSyncTask， 可以查询更多支持的云资源", "status": "online", "parameters": [ { "name": "CertificateIds", "type": "array", "required": true, "description": "证书ID", "example": "[\"hehysh\"]", "item_type": "string" }, { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型:clb,cdn,live,vod,waf,antiddos,teo", "example": "clb" } ], "required": [ "CertificateIds", "ResourceType" ] }, { "name": "DescribeDownloadCertificateUrl", "description": "获取下载证书链接", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID", "example": "s2dyw1" }, { "name": "ServiceType", "type": "string", "required": false, "description": "下载的服务类型: nginx tomcat apache iis jks other root， 不传则默认下载nginx格式", "example": "nginx" } ], "required": [ "CertificateId" ] }, { "name": "DescribeHostApiGatewayInstanceList", "description": "查询证书apiGateway云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heh**jjj" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "heyy**jjs" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10，最大值为200。", "example": "10" }, { "name": "Offset", "type": "string", "required": false, "description": "分页偏移量，默认值为0。", "example": "0" } ], "required": [] }, { "name": "DescribeHostCdnInstanceList", "description": "查询证书cdn云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heys*jj" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "hshe**jsjs" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10，最大值为200。", "example": "10" }, { "name": "AsyncCache", "type": "integer", "required": false, "description": "是否异步,0表示否，1表示是，默认为0", "example": "1" } ], "required": [] }, { "name": "DescribeHostClbInstanceList", "description": "查询证书clb云资源部署实例列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heys**hhs" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "AsyncCache", "type": "integer", "required": false, "description": "是否异步缓存,0表示否,1表示是", "example": "0" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "hhehs**hh" } ], "required": [] }, { "name": "DescribeHostCosInstanceList", "description": "查询证书cos云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heysy**hsj" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "ResourceType", "type": "string", "required": false, "description": "部署资源类型 cos", "example": "cos" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "heys**hhj" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "AsyncCache", "type": "integer", "required": false, "description": "是否异步，0表示否，1表示是", "example": "0" } ], "required": [] }, { "name": "DescribeHostDdosInstanceList", "description": "查询证书ddos云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heysy**heh" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "ResourceType", "type": "string", "required": false, "description": "部署资源类型ddos", "example": "ddos" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "heys*he" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" } ], "required": [] }, { "name": "DescribeHostDeployRecord", "description": "查询证书云资源部署记录列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "待部署的证书ID", "example": "heh**hs" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "ResourceType", "type": "string", "required": false, "description": "支持的资源类型如下,clb,cdn,ddos,waf,apigateway,teo,tke,cos,lighthouse,vod,tcb,tse,live", "example": "clb" } ], "required": [ "CertificateId" ] }, { "name": "DescribeHostDeployRecordDetail", "description": "查询证书云资源部署记录详情列表", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "string", "required": true, "description": "部署记录ID，通过调用DeployCertificateInstance接口返回的记录ID， 或者通过DeployCertificateRecordRollback回滚接口返回的记录ID", "example": "17993" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。最大值为200", "example": "10" } ], "required": [ "DeployRecordId" ] }, { "name": "DescribeHostLighthouseInstanceList", "description": "查询证书Lighthouse云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "ejuh**hj" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] } ], "required": [] }, { "name": "DescribeHostLiveInstanceList", "description": "查询证书live云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heys**hesh" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "heys**hsh" } ], "required": [] }, { "name": "DescribeHostTeoInstanceList", "description": "查询证书EdgeOne云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "hye**hsh" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "heys**ks" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值为0.", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10，最大值为200。", "example": "10" }, { "name": "AsyncCache", "type": "integer", "required": false, "description": "是否异步，1表示是，0表示否，默认为0", "example": "1" } ], "required": [] }, { "name": "DescribeHostTkeInstanceList", "description": "查询证书tke云资源部署实例列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heyst**hj" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "AsyncCache", "type": "integer", "required": false, "description": "是否异步缓存，0表示否，1表示是，默认为0", "example": "0" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "ehys**heh" } ], "required": [] }, { "name": "DescribeHostUpdateRecord", "description": "查询证书云资源更新记录列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "CertificateId", "type": "string", "required": false, "description": "新证书ID", "example": "heys**hehs" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "egts**hehsy" } ], "required": [] }, { "name": "DescribeHostUpdateRecordDetail", "description": "查询证书云资源更新记录详情", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "string", "required": true, "description": "部署记录ID，通过调用UpdateCertificateInstance接口返回的记录ID， 或者通过UpdateCertificateRecordRollback回滚接口返回的记录ID", "example": "177999" }, { "name": "Limit", "type": "string", "required": false, "description": "每页数量，默认10。最大值为200", "example": "10" }, { "name": "Offset", "type": "string", "required": false, "description": "分页偏移量，从0开始。默认为0", "example": "0" } ], "required": [ "DeployRecordId" ] }, { "name": "DescribeHostUploadUpdateRecord", "description": "查询证书云资源更新（证书ID不变）记录列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，从0开始。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认10。", "example": "10" }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "原证书ID", "example": "egts**hehsy" } ], "required": [] }, { "name": "DescribeHostUploadUpdateRecordDetail", "description": "查询证书更新（证书ID不变）部署记录详情", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": true, "description": "托管记录ID", "example": "1001" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量，默认为10，最大为200， 超过200则为200", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" } ], "required": [ "DeployRecordId" ] }, { "name": "DescribeHostVodInstanceList", "description": "查询证书Vod云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID,必填选项", "example": "heyst**hs" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "ehsy**heh" } ], "required": [] }, { "name": "DescribeHostWafInstanceList", "description": "查询证书waf云资源部署实例列表", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": false, "description": "待部署的证书ID", "example": "heys**heh" }, { "name": "IsCache", "type": "integer", "required": false, "description": "是否查询缓存，1：是； 0：否， 默认为查询缓存，缓存半小时", "example": "1" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数列表； FilterKey：domainMatch（查询域名是否匹配的实例列表） FilterValue：1，表示查询匹配； 0，表示查询不匹配； 默认查询匹配", "example": "无", "item_type": "object", "children": [ { "name": "FilterKey", "type": "string", "required": true, "description": "过滤参数key", "example": "DomainMatch" }, { "name": "FilterValue", "type": "string", "required": true, "description": "过滤参数值", "example": "1" } ] }, { "name": "OldCertificateId", "type": "string", "required": false, "description": "已部署的证书ID", "example": "getst**heh" } ], "required": [] }, { "name": "DescribeManagerDetail", "description": "查询管理人详情", "status": "online", "parameters": [ { "name": "ManagerId", "type": "integer", "required": true, "description": "管理人ID,可以从describeManagers接口获得", "example": "17939" } ], "required": [ "ManagerId" ] }, { "name": "DescribeManagers", "description": "查询管理人列表", "status": "online", "parameters": [ { "name": "CompanyId", "type": "integer", "required": true, "description": "公司ID,可以从DescribeCompanies接口获取", "example": "12" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，如果不传默认值为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页每页数量，如果不传默认值为10，最大值为1000", "example": "10" }, { "name": "ManagerName", "type": "string", "required": false, "description": "管理人姓名（将废弃），请使用SearchKey", "example": "腾讯" }, { "name": "ManagerMail", "type": "string", "required": false, "description": "模糊查询管理人邮箱（将废弃），请使用SearchKey", "example": "tencent@tencent.com" }, { "name": "Status", "type": "string", "required": false, "description": "根据管理人状态进行筛选，取值有 'none' 未提交审核 'audit', 亚信审核中 'CAaudit' CA审核中 'ok' 已审核 'invalid' 审核失败 'expiring' 即将过期 'expired' 已过期", "example": "audit" }, { "name": "SearchKey", "type": "string", "required": false, "description": "根据这样的格式:管理人姓|管理人名|邮箱|部门 ,进行精准匹配", "example": "luke|sky|tencent@tencent.com|开发一部" } ], "required": [ "CompanyId" ] }, { "name": "DescribePackages", "description": "获得权益包列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数目，默认20。", "example": "20" }, { "name": "Status", "type": "string", "required": false, "description": "按状态筛选。状态值包括usable(可用)，used(已用)，expired(已过期)，refund(已退款)", "example": "refund" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "按过期时间升序或降序排列，可选值为asc(升序)和desc(降序)", "example": "asc" }, { "name": "PackageId", "type": "string", "required": false, "description": "按权益包ID搜索。", "example": "X22080117530008" }, { "name": "Type", "type": "string", "required": false, "description": "按权益包类型搜索。类型包括：ssl_100(证书批量权益100点)，ssl_500(证书批量权益500点），ssl_2000(证书批量权益2000点）", "example": "ssl_100" }, { "name": "Pid", "type": "integer", "required": false, "description": "子产品编号", "example": "10078" } ], "required": [] }, { "name": "DownloadCertificate", "description": "本接口（DownloadCertificate）用于下载证书。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "\"hehs**jjsj\"" } ], "required": [ "CertificateId" ] }, { "name": "ModifyCertificateAlias", "description": "用户传入证书id和备注来修改证书备注。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "abcb1234" }, { "name": "Alias", "type": "string", "required": false, "description": "备注名称。", "example": "others" } ], "required": [ "CertificateId" ] }, { "name": "ModifyCertificateProject", "description": "批量修改证书所属项目。", "status": "online", "parameters": [ { "name": "CertificateIdList", "type": "array", "required": true, "description": "需要修改所属项目的证书 ID 集合，最多100个证书。", "example": "[\"he**heys\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目 ID。", "example": "10778" } ], "required": [ "CertificateIdList", "ProjectId" ] }, { "name": "ModifyCertificateResubmit", "description": "针对审核失败或审核取消的付费证书，重新发起审核", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID。", "example": "heys**sjd" } ], "required": [ "CertificateId" ] }, { "name": "ModifyCertificatesExpiringNotificationSwitch", "description": "修改忽略证书到期通知。打开或关闭证书到期通知。", "status": "online", "parameters": [ { "name": "CertificateIds", "type": "array", "required": true, "description": "证书ID列表。最多50个", "example": "[\"heh***js\"]", "item_type": "string" }, { "name": "SwitchStatus", "type": "integer", "required": true, "description": "0:不忽略通知。1:忽略通知", "example": "0" } ], "required": [ "CertificateIds", "SwitchStatus" ] }, { "name": "ReplaceCertificate", "description": "本接口（ReplaceCertificate）用于重颁发证书。已申请的免费证书仅支持 RSA 算法、密钥对参数为2048的证书重颁发，并且目前仅支持1次重颁发。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "heysh**heh" }, { "name": "ValidType", "type": "string", "required": true, "description": "验证类型：DNS_AUTO = 自动DNS验证（仅支持在腾讯云解析且解析状态正常的域名使用该验证类型），DNS = 手动DNS验证，FILE = 文件验证。", "example": "DNS" }, { "name": "CsrType", "type": "string", "required": false, "description": "类型，默认 original。可选项：original = 原证书 CSR，upload = 手动上传，online = 在线生成。", "example": "Upload" }, { "name": "CsrContent", "type": "string", "required": false, "description": "CSR 内容，手动上传的时候需要。", "example": "-----BEGIN CERTIFICATE REQUEST-----\\\\nMIIBajCCARECAQAwga4xCzAJBgNVBAYTAkNOMRswGQYDVQQIDBLDp8Kmwo/DpcK7\\\\n-----END CERTIFICATE REQUEST-----" }, { "name": "CsrkeyPassword", "type": "string", "required": false, "description": "KEY 密码。", "example": "password" }, { "name": "Reason", "type": "string", "required": false, "description": "重颁发原因。", "example": "不想要了" }, { "name": "CertCSREncryptAlgo", "type": "string", "required": false, "description": "CSR加密方式，可选：RSA、ECC、SM2 （CsrType为Online才可选）， 默认为RSA", "example": "RSA" }, { "name": "CertCSRKeyParameter", "type": "string", "required": false, "description": "CSR加密参数，CsrEncryptAlgo为RSA时， 可选2048、4096等默认为2048；CsrEncryptAlgo为ECC时，可选prime256v1，secp384r1等，默认为prime256v1;", "example": "2048" }, { "name": "SignAlgo", "type": "string", "required": false, "description": "签名算法", "example": "SHA256" }, { "name": "UseCrossSignRoot", "type": "boolean", "required": false, "description": "是否使用交叉根证书，默认为true", "example": "true" } ], "required": [ "CertificateId", "ValidType" ] }, { "name": "RevokeCertificate", "description": "本接口（RevokeCertificate）用于吊销证书。", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "hey**hes" }, { "name": "Reason", "type": "string", "required": false, "description": "吊销证书原因。", "example": "不想要了" } ], "required": [ "CertificateId" ] }, { "name": "SubmitAuditManager", "description": "重新提交审核管理人", "status": "online", "parameters": [ { "name": "ManagerId", "type": "integer", "required": true, "description": "管理人ID", "example": "17839" } ], "required": [ "ManagerId" ] }, { "name": "SubmitCertificateInformation", "description": "付费证书提交资料； 本接口不维护新功能， 可使用新接口进行资料提交， [CertificateInfoSubmit](https://cloud.tencent.com/document/product/400/116033)", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "待提交资料的付费证书 ID。", "example": "LqQxgqUe" }, { "name": "CsrType", "type": "string", "required": false, "description": "此字段必传。 CSR 生成方式， 取值为： online：腾讯云提交的填写的参数信息生成CSR和私钥， 并由腾讯云加密存储 parse：自行生成CSR和私钥， 并通过上传CSR申请证书", "example": "online" }, { "name": "CsrContent", "type": "string", "required": false, "description": "上传的 CSR 内容。 若CstType为parse， 则此字段必传。", "example": "-----BEGIN CERTIFICATE REQUEST-----\\nxxxxxxx\\n-----END CERTIFICATE REQUEST-----" }, { "name": "CertificateDomain", "type": "string", "required": false, "description": "证书绑定的通用名称， 若是上传的CSR，则该域名需与CSR解析的通用名称一致", "example": "tencent.com" }, { "name": "DomainList", "type": "array", "required": false, "description": "证书绑定的其他域名， 单域名、泛域名证书无需提供。 多域名、多泛域名必填", "example": "[\"www.tencent.com\"]", "item_type": "string" }, { "name": "KeyPassword", "type": "string", "required": false, "description": "私钥密码， 目前仅使用在生成jks、pfx格式证书时密码； 其他格式私钥证书未加密", "example": "1234aaa5678" }, { "name": "OrganizationName", "type": "string", "required": false, "description": "字段必传， 公司名称。", "example": "Tencent" }, { "name": "OrganizationDivision", "type": "string", "required": false, "description": "字段必传， 部门名称。", "example": "IT" }, { "name": "OrganizationAddress", "type": "string", "required": false, "description": "字段必传， 公司详细地址。", "example": "Shenzhen" }, { "name": "OrganizationCountry", "type": "string", "required": false, "description": "字段必传， 国家名称，传CN即可", "example": "China" }, { "name": "OrganizationCity", "type": "string", "required": false, "description": "字段必传， 公司所在城市。", "example": "Shenzhen" }, { "name": "OrganizationRegion", "type": "string", "required": false, "description": "字段必传， 公司所在省份。", "example": "Guangdong" }, { "name": "PostalCode", "type": "string", "required": false, "description": "公司邮编。", "example": "137000" }, { "name": "PhoneAreaCode", "type": "string", "required": false, "description": "字段必传， 公司座机区号。", "example": "021" }, { "name": "PhoneNumber", "type": "string", "required": false, "description": "字段必传， 公司座机号码。", "example": "1382344" }, { "name": "VerifyType", "type": "string", "required": false, "description": "证书验证方式。验证类型：DNS_AUTO = 自动DNS验证（仅支持在腾讯云解析且解析状态正常的域名使用该验证类型），DNS = 手动DNS验证，FILE = 文件验证。", "example": "DNS" }, { "name": "AdminFirstName", "type": "string", "required": false, "description": "字段必传，管理人名。", "example": "Luke" }, { "name": "AdminLastName", "type": "string", "required": false, "description": "字段必传，管理人姓。", "example": "SKy" }, { "name": "AdminPhoneNum", "type": "string", "required": false, "description": "字段必传，管理人手机号码。", "example": "183****663" }, { "name": "AdminEmail", "type": "string", "required": false, "description": "字段必传，管理人邮箱地址。", "example": "hhhy@qq.com" }, { "name": "AdminPosition", "type": "string", "required": false, "description": "字段必传，管理人职位。", "example": "IT" }, { "name": "ContactFirstName", "type": "string", "required": false, "description": "字段必传，联系人名。", "example": "Luke" }, { "name": "ContactLastName", "type": "string", "required": false, "description": "字段必传，联系人姓。", "example": "SKy" }, { "name": "ContactEmail", "type": "string", "required": false, "description": "字段必传，联系人邮箱地址。", "example": "hhhy@qq.com" }, { "name": "ContactNumber", "type": "string", "required": false, "description": "字段必传，联系人手机号码。", "example": "183****663" }, { "name": "ContactPosition", "type": "string", "required": false, "description": "字段必传，联系人职位。", "example": "IT" }, { "name": "IsDV", "type": "boolean", "required": false, "description": "是否DV证书。默认false", "example": "fasle" } ], "required": [ "CertificateId" ] }, { "name": "UpdateCertificateInstance", "description": "一键更新旧证书资源，本接口为异步接口， 调用之后DeployRecordId为0表示任务进行中， 重复请求这个接口， 当返回DeployRecordId大于0则表示任务创建成功。 未创建成功则会抛出异常", "status": "online", "parameters": [ { "name": "OldCertificateId", "type": "string", "required": true, "description": "一键更新的旧证书ID。 通过查询该证书ID绑定的云资源，然后使用新证书对这些云资源进行更新", "example": "hey**shje" }, { "name": "ResourceTypes", "type": "array", "required": true, "description": "需要部署的资源类型，参数值可选（小写）：clb、cdn、waf、live、ddos、teo、apigateway、vod、tke、tcb、tse、cos、mqtt、scf、tdmq、gaap", "example": "[\"clb\",\"tke\"]", "item_type": "string" }, { "name": "CertificateId", "type": "string", "required": false, "description": "一键更新的新证书ID。 不传该参数，则公钥证书和私钥证书必传", "example": "hey**shje" }, { "name": "ResourceTypesRegions", "type": "array", "required": false, "description": "云资源需要部署的地域列表，支持地域的云资源类型必传，取值：clb、tke、apigateway、waf、tcb、tse、cos、mqtt、scf、tdmq", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": false, "description": "云资源类型，支持clb、waf、apigateway、cos、tke、tse、tcb", "example": "clb" }, { "name": "Regions", "type": "array", "required": false, "description": "地域列表", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ] }, { "name": "CertificatePublicKey", "type": "string", "required": false, "description": "公钥证书， 若上传公钥证书，那么私钥证书必传。 则CertificateId不用传", "example": "-----BEGIN CERTIFICATE----****" }, { "name": "CertificatePrivateKey", "type": "string", "required": false, "description": "私钥证书，若上传私钥证书， 那么公钥证书必传； 则CertificateId不用传", "example": "-----BEGIN RSA PRIVATE KEY----***" }, { "name": "ExpiringNotificationSwitch", "type": "integer", "required": false, "description": "旧证书是否忽略到期提醒 0:不忽略通知。1:忽略通知，忽略OldCertificateId到期提醒", "example": "1" }, { "name": "Repeatable", "type": "boolean", "required": false, "description": "相同的证书是否允许重复上传，若选择上传公钥私钥证书， 则可以配置该参数。 若存在相同重复证书，则更新任务会失败", "example": "true" }, { "name": "AllowDownload", "type": "boolean", "required": false, "description": "是否允许下载，若选择上传公私钥证书， 则可以配置该参数", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表，若选择上传公私钥证书， 则可以配置该参数", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，若选择上传公私钥证书， 则可以配置该参数", "example": "1788" } ], "required": [ "OldCertificateId", "ResourceTypes" ] }, { "name": "UpdateCertificateRecordRetry", "description": "云资源更新重试部署记录", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": false, "description": "待重试部署记录ID,通过UpdateCertificateInstance得到部署记录ID。 本参数不传的话，则DeployRecordDetailId必传", "example": "748939" }, { "name": "DeployRecordDetailId", "type": "integer", "required": false, "description": "待重试部署记录详情ID,通过DescribeHostUpdateRecordDetail接口获得， 本参数不传的话， 则DeployRecordId必传", "example": "6637737" } ], "required": [] }, { "name": "UpdateCertificateRecordRollback", "description": "云资源更新成功记录回滚， 只对更新已成功的记录回滚", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": false, "description": "更新证书待回滚的记录ID, 通过UpdateCertificateInstance获得", "example": "7377374" } ], "required": [] }, { "name": "UploadCertificate", "description": "本接口（UploadCertificate）用于上传证书。", "status": "online", "parameters": [ { "name": "CertificatePublicKey", "type": "string", "required": true, "description": "证书内容。", "example": "-----BEGIN CERTIFICATE----****" }, { "name": "CertificatePrivateKey", "type": "string", "required": false, "description": "私钥内容，证书类型为 SVR 时必填，为 CA 时可不填。", "example": "-----BEGIN RSA PRIVATE KEY-----" }, { "name": "CertificateType", "type": "string", "required": false, "description": "证书类型，默认 SVR。CA = CA证书，SVR = 服务器证书。", "example": "SVR" }, { "name": "Alias", "type": "string", "required": false, "description": "备注名称。", "example": "hello" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。", "example": "175666" }, { "name": "CertificateUse", "type": "string", "required": false, "description": "证书用途/证书来源。“CLB，CDN，WAF，LIVE，DDOS”", "example": "CLB" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "tag:tagvalue", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "Repeatable", "type": "boolean", "required": false, "description": "相同的证书是否允许重复上传； true：允许上传相同指纹的证书； false：不允许上传相同指纹的证书； 默认值：true", "example": "true" }, { "name": "KeyPassword", "type": "string", "required": false, "description": "私钥密码", "example": "password" } ], "required": [ "CertificatePublicKey" ] }, { "name": "UploadConfirmLetter", "description": "本接口（UploadConfirmLetter）上传证书确认函，不再维护其功能，请用户前往腾讯云证书控制台上传证书确认函", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书ID", "example": "7hex***j" }, { "name": "ConfirmLetter", "type": "string", "required": true, "description": "base64编码后的证书确认函文件，格式应为jpg、jpeg、png、pdf，大小应在1kb与1.4M之间。", "example": "\"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkIC" } ], "required": [ "CertificateId", "ConfirmLetter" ] }, { "name": "UploadRevokeLetter", "description": "本接口（UploadRevokeLetter）上传证书吊销确认函，不再维护其功能，请用户前往腾讯云证书控制台上传证书吊销确认函", "status": "online", "parameters": [ { "name": "CertificateId", "type": "string", "required": true, "description": "证书 ID。", "example": "a91hoLqi" }, { "name": "RevokeLetter", "type": "string", "required": true, "description": "base64编码后的证书确认函文件，格式应为jpg、jpeg、png、pdf，大小应在1kb与1.4M之间。", "example": "base64content" } ], "required": [ "CertificateId", "RevokeLetter" ] }, { "name": "UploadUpdateCertificateInstance", "description": "当前接口需联系加白使用并且只支持更新证书的CLB资源，更新证书内容（证书ID不变）并更新关联的云资源，本接口为异步接口， 调用之后DeployRecordId为0表示任务进行中， 重复请求这个接口， 当返回DeployRecordId大于0则表示任务创建成功。 未创建成功则会抛出异常", "status": "online", "parameters": [ { "name": "OldCertificateId", "type": "string", "required": true, "description": "一键更新的旧证书ID。 通过查询该证书ID绑定的云资源，然后使用新证书对这些云资源进行更新", "example": "hey**shje" }, { "name": "ResourceTypes", "type": "array", "required": true, "description": "需要部署的资源类型，参数值可选（小写）：clb", "example": "[\"clb\"]", "item_type": "string" }, { "name": "CertificatePublicKey", "type": "string", "required": true, "description": "公钥证书", "example": "-----BEGIN CERTIFICATE----****" }, { "name": "CertificatePrivateKey", "type": "string", "required": true, "description": "私钥证书", "example": "-----BEGIN RSA PRIVATE KEY----***" }, { "name": "ResourceTypesRegions", "type": "array", "required": false, "description": "云资源需要部署的地域列表，支持地域的云资源类型必传，取值：clb", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": false, "description": "云资源类型，支持clb、waf、apigateway、cos、tke、tse、tcb", "example": "clb" }, { "name": "Regions", "type": "array", "required": false, "description": "地域列表", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ] } ], "required": [ "OldCertificateId", "ResourceTypes", "CertificatePublicKey", "CertificatePrivateKey" ] }, { "name": "UploadUpdateCertificateRecordRetry", "description": "云资源更新（证书ID不变）重试部署记录", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": false, "description": "待重试部署记录ID,通过UpdateCertificateInstance得到部署记录ID。 本参数不传的话，则DeployRecordDetailId必传", "example": "748939" }, { "name": "DeployRecordDetailId", "type": "integer", "required": false, "description": "待重试部署记录详情ID,通过DescribeHostUpdateRecordDetail接口获得， 本参数不传的话， 则DeployRecordId必传", "example": "6637737" } ], "required": [] }, { "name": "UploadUpdateCertificateRecordRollback", "description": "云资源更新成功（证书ID不变）记录回滚， 会对全量任务进行回滚", "status": "online", "parameters": [ { "name": "DeployRecordId", "type": "integer", "required": true, "description": "更新证书待回滚的记录ID, 通过UpdateCertificateInstance获得", "example": "7377374" } ], "required": [ "DeployRecordId" ] }, { "name": "VerifyManager", "description": "重新核验管理人", "status": "online", "parameters": [ { "name": "ManagerId", "type": "integer", "required": true, "description": "管理人ID", "example": "23" } ], "required": [ "ManagerId" ] } ] }