1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
付费提交证书资料
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CertificateInfoSubmit。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CertId | 是 | String | 待提交资料的付费证书 ID。 示例值:LrmeMvQr |
GenCsrType | 是 | String | 此字段必传。 CSR 生成方式, 取值为: - online:腾讯云提交的填写的参数信息生成CSR和私钥,并由腾讯云加密存储 - parse:自行生成CSR和私钥,并通过上传CSR申请证书 示例值:parse |
CertCommonName | 是 | String | 证书绑定的通用名称, 若是上传的CSR,则该域名需与CSR解析的通用名称一致 示例值:tencent.com |
CompanyType | 是 | Integer | 组织信息类型, 取值范围: 1(个人):仅DV类型证书可设置为1, 个人类型证书组织信息字段可不传:Org开头,Admin开头,Tech开头 2(公司):所有类型证书都可设置为2, 按需传组织信息字段 示例值:2 |
CompanyId | 是 | String | 公司ID,在 腾讯云控制台 可进行查看,若无满足的公司信息, 则本参数传0 ; 若存在满足当前订单的公司信息, 可以根据 DescribeCompanies 查看公司ID; 若传了公司ID,则Org开头的参数可不传 示例值:11772 |
OrgIdType | 否 | String | 公司证件类型,取值范围: TYDMZ(统一社会信用代码 ):仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段 OTHERS(其他) 示例值:TYDMZ |
OrgIdNumber | 否 | String | 公司证件号码,取值范围: TYDMZ(统一社会信用代码 ):11532xxxxxxxx24820 示例值:914400002111711112 |
AdminIdType | 否 | String | 管理人证件类型,取值范围: SFZ(身份证):仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段 HZ(护照):仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段 示例值:SFZ |
AdminIdNumber | 否 | String | 管理人证件号码,仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段, 取值范围: SFZ(身份证):110000xxxxxxxx1242 HZ(护照):EFxxxxxxx 示例值:110000199101011001 |
TechIdType | 否 | String | 联系人证件类型,取值范围: SFZ(身份证):仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段 HZ(护照):仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段 示例值:SFZ |
TechIdNumber | 否 | String | 联系人证件号码,仅CFCA类型证书需要使用本字段, 其他类型证书不需要使用本字段,取值范围: SFZ(身份证):110000xxxxxxxx1242 HZ(护照):EFxxxxxxx 示例值:110000199101011001 |
Csr | 否 | String | 上传的 CSR 内容。 若GenCsrType为parse, 则此字段必传。 示例值:-----BEGIN CERTIFICATE REQUEST-----\nxxxxxxxxx\n-----END CERTIFICATE REQUEST----- |
DnsNames.N | 否 | Array of String | 证书绑定的其他域名, 单域名、泛域名证书无需提供。 多域名、多泛域名必填 示例值:["test.tencent.com"] |
KeyPass | 否 | String | 私钥密码, 目前仅使用在生成jks、pfx格式证书时密码; 其他格式私钥证书未加密 示例值:1234aaa5678 |
OrgOrganization | 否 | String | 公司名称。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:腾讯云SSL证书测试 |
OrgDivision | 否 | String | 部门名称。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:研发部门 |
OrgAddress | 否 | String | 公司详细地址。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:腾讯云SSL证书测试地址 |
OrgCountry | 否 | String | 国家名称,如中国:CN 。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:CN |
OrgCity | 否 | String | 公司所在城市。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:北京市 |
OrgRegion | 否 | String | 公司所在省份。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:北京市 |
OrgPhoneArea | 否 | String | 公司所属区号。若没有传CompanyId或者ManagerId, 则此字段必传 如:021。 手机号码传 86 示例值:010 |
OrgPhoneNumber | 否 | String | 公司所属号码。若没有传CompanyId或者ManagerId, 则此字段必传 示例值:8423102 |
VerifyType | 否 | String | 证书域名验证方式: DNS_AUTO: 自动添加域名DNS验证, 需用户域名解析托管在『云解析DNS』,且与申请证书归属同一个腾讯云账号 DNS:手动添加域名DNS验证,需用户手动去域名解析服务商添加验证值 FILE:手动添加域名文件验证。 需要用户手动在域名站点根目录添加指定路径文件进行文件验证, http&https任一通过即可;且域名站点需海外CA机构能访问, 具体访问白名单为:64.78.193.238,216.168.247.9,216.168.249.9,54.189.196.217 示例值:DNS |
AdminFirstName | 否 | String | 管理人名。若没有传ManagerId, 则此字段必传 示例值:宁 |
AdminLastName | 否 | String | 管理人姓。若没有传ManagerId, 则此字段必传 示例值:黄 |
AdminPhone | 否 | String | 管理人手机号码。若没有传ManagerId, 则此字段必传 示例值:13120934321 |
AdminEmail | 否 | String | 管理人邮箱地址。若没有传ManagerId, 则此字段必传 示例值:ssl@tencent.com |
AdminTitle | 否 | String | 管理人职位。若没有传ManagerId, 则此字段必传 示例值:研发 |
TechFirstName | 否 | String | 联系人名。若没有传ManagerId, 则此字段必传 示例值:宁 |
TechLastName | 否 | String | 联系人姓。若没有传ManagerId, 则此字段必传 示例值:黄 |
ContactEmail | 否 | String | 联系人邮箱地址。CompanyType为1时, 此字段必传 示例值:ssl@tencent.com |
AutoRenewFlag | 否 | Integer | 是否开启自动续费: 0, 不开启; 1, 开启; 默认为0 示例值:1 |
CsrKeyParameter | 否 | String | 密钥对参数,RSA支持2048,4096。ECC仅支持prime256v1。加密算法选择ECC时,此参数必填 国密证书类型本字段不用传 示例值:2048 |
CsrEncryptAlgo | 否 | String | 加密算法,取值为ECC、RSA, 默认为RSA 国密证书类型本字段不用传 示例值:RSA |
ManagerId | 否 | String | 管理人ID,在 腾讯云控制台 可进行查看,若无满足的管理人信息, 则本参数传0 ; 若存在满足当前订单的管理人信息, 可以根据 DescribeManagers 查看管理人ID; 若传了管理人ID,则Org开头、Admin开头、Tech开头的参数可不传; 管理人ID会包含公司信息 示例值:12895 |
TechPhone | 否 | String | 联系人电话。若没有传ManagerId, 则此字段必传 示例值:13120934321 |
TechEmail | 否 | String | 联系人邮箱 示例值:ssl@tencent.com |
TechTitle | 否 | String | 联系人职位。若没有传ManagerId, 则此字段必传 示例值:研发 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 付费证书提交资料 - CFCA品牌证书
付费证书提交资料
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<公共请求参数>
{
"AdminEmail": "ssl@tencent.com",
"AdminFirstName": "宁",
"AdminIdNumber": "110000000000000001",
"AdminIdType": "SFZ",
"AdminLastName": "黄",
"AdminPhone": "13112341234",
"AdminTitle": "研发",
"CertCommonName": "tencent.com",
"CertId": "J2lX2maH",
"CompanyId": "134",
"CompanyType": 2,
"CsrEncryptAlgo": "RSA",
"CsrKeyParameter": "2048",
"GenCsrType": "online",
"ManagerId": "2345",
"OrgAddress": "广东省广州市xx区xxxxxx101号",
"OrgCity": "广州市",
"OrgCountry": "CN",
"OrgDivision": "研发部",
"OrgIdNumber": "111111111111110000",
"OrgIdType": "TYDMZ",
"OrgOrganization": "腾讯云SSL证书",
"OrgPhoneArea": "010",
"OrgPhoneNumber": "234123123",
"OrgRegion": "广东省",
"TechEmail": "ssl@tencent.com",
"TechFirstName": "宁",
"TechIdNumber": "110000000000000001",
"TechIdType": "SFZ",
"TechLastName": "黄",
"TechPhone": "13112341234",
"TechTitle": "研发",
"VerifyType": "FILE"
}
输出示例
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
示例2 付费证书提交资料 - 通用
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<公共请求参数>
{
"CertId": "LrmeMvQr",
"GenCsrType": "online",
"CertCommonName": "tencent.com",
"CompanyType": "2",
"OrgIdType": "",
"OrgIdNumber": "",
"AdminIdType": "",
"AdminIdNumber": "",
"TechIdType": "",
"TechIdNumber": "",
"CompanyId": "11772",
"Csr": "",
"KeyPass": "12345678",
"OrgOrganization": "腾讯云SSL证书测试",
"OrgDivision": "研发部门",
"OrgAddress": "腾讯云SSL证书测试地址",
"OrgCountry": "CN",
"OrgCity": "北京市",
"OrgRegion": "北京市",
"OrgPhoneArea": "010",
"OrgPhoneNumber": "123456789010",
"AdminFirstName": "宁",
"AdminLastName": "黄",
"AdminPhone": "18169239105",
"AdminEmail": "ssl@tencent.com",
"AdminTitle": "研发",
"TechFirstName": "试",
"TechLastName": "测",
"CsrKeyParameter": "2048",
"CsrEncryptAlgo": "RSA",
"TechEmail": "ssl@tencent.com",
"TechPhone": "18169239105",
"TechTitle": "研发",
"ManagerId": "12895"
}
输出示例
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
示例3 付费证书提交资料 - 上传CSR
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CertificateInfoSubmit
<公共请求参数>
{
"CertId": "LrmeMvQr",
"GenCsrType": "parse",
"CertCommonName": "tencent.com",
"CompanyType": "2",
"OrgIdType": "",
"OrgIdNumber": "",
"AdminIdType": "",
"AdminIdNumber": "",
"TechIdType": "",
"TechIdNumber": "",
"CompanyId": "11772",
"Csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC5zCCAc8CAQAweTELMAkGA1UEBhMCQ04xEjAQBgNVBAgMCea5luWNl+ecgTES\nMBAGA1UEBwwJ6ZW/5rKZ5biCMRswGQYDVQQKDBLohb7orq/kupFTU0zor4HkuaYx\nDzANBgNVBAsMBueglOWPkTEUMBIGA1UEAxMLdGVuY2VudC5jb20wggEiMA0GCSqG\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDWACnWh6gA1dGDi/pJtGZtp/Wp4ou6//JM\nEu4OpXQ5t/afvX4xPGm7laWE4aFItZpfhXc1SGVwOBwWsOArw9xwmdCDFY3Icbu9\n8O1mIAIYfMDuc8bWL5lQfuyBeGJw+9i++E/1SkYnx3sRD+vMNlJdkaueWW4qXVo+\nZnE7FX/6Mqi1PE53ccXU55iviLHAaSnztpmUmF4vcKIVbDTsI2TF1raHwdnmvQFx\nvifh7h49xRz3Jj3QWCJqdtGKAktFzofDCYPKcIKT4A52u7WsoBspLIds1H93dITD\nVxnZaE3oe4sHfQpnlHRbO72Cz1QEgGBQeOW/wH8/WygFiRIWHwZpAgMBAAGgKTAn\nBgkqhkiG9w0BCQ4xGjAYMBYGA1UdEQQPMA2CC3RlbmNlbnQuY29tMA0GCSqGSIb3\nDQEBCwUAA4IBAQAcr+Wy3uqr+PL+uUMwd1scB7x27/j2JDXTKBdZnsLnaEFCzz2f\ny4aqN7hWLHNEoqGGNSg5luKO6DCFXOnzu6/bI4Ziy/w003RD1wMPinpo0C0YIzwM\nW99sDPoI1qIxAoNEVLOP11EnPPdlq/D7T4UOMjPxjYSo4Ge2BcG5Bk1zTu/O8She\nxHc6lEWniExaYomIboULnLTdSI1Dx0g7segNMvhLGUjRyump3/0jANfk7qbS0Nnz\n6Q/i0NmiqUiA38iTdIBY57QAJBbXiJJ3HRF5wZyJESobTr9dHPuZH4ebJvfSaNBp\n4KqzUxjAe5GZJs/z5EuJkG/LC/h1L3rFT7AS\n-----END CERTIFICATE REQUEST-----\n",
"KeyPass": "12345678",
"OrgOrganization": "腾讯云SSL证书测试",
"OrgDivision": "研发部门",
"OrgAddress": "腾讯云SSL证书测试地址",
"OrgCountry": "CN",
"OrgCity": "北京市",
"OrgRegion": "北京市",
"OrgPhoneArea": "010",
"OrgPhoneNumber": "123456789010",
"AdminFirstName": "宁",
"AdminLastName": "黄",
"AdminPhone": "18162039301",
"AdminEmail": "ssl@tencent.com",
"AdminTitle": "研发",
"TechFirstName": "宁",
"TechLastName": "黄",
"CsrKeyParameter": "",
"CsrEncryptAlgo": "",
"TechEmail": "ssl@tencent.com",
"TechPhone": "18162039301",
"TechTitle": "研发",
"ManagerId": "12895"
}
输出示例
{
"Response": {
"RequestId": "54c73858-77a6-435c-addc-65919b550900"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.AuthError | 请检查是否有权限。 |
FailedOperation.CertificateInfoSubmitStatusInvalid | 当前证书状态不可以提交资料 |
FailedOperation.CertificateNotFound | 证书不存在。 |
FailedOperation.ExceedsFreeLimit | 免费证书数量超出限制。 |
FailedOperation.InvalidCertificateStatusCode | 证书状态不正确。 |
FailedOperation.InvalidParam | 参数有误。 |
FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
InternalError | 内部错误。 |
InvalidParameter.RenewAlgorithmInvalid | 算法无效。 |