1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
提交证书资料。输入参数信息可以分多次提交,但提交的证书资料应最低限度保持完整。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitCertificateInformation。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CertificateId | 是 | String | 证书 ID。 示例值:heysh**hehs |
CsrType | 否 | String | CSR 生成方式:online = 在线生成, parse = 手动上传。 示例值:online |
CsrContent | 否 | String | 上传的 CSR 内容。 示例值:hey***jjsj |
CertificateDomain | 否 | String | 绑定证书的域名。 示例值:www.hh***.com |
DomainList.N | 否 | Array of String | 上传的域名数组(多域名证书可以上传)。 示例值:["www.hh***.com"] |
KeyPassword | 否 | String | 私钥密码(非必填)。 示例值:password |
OrganizationName | 否 | String | 公司名称。 示例值:Tencent |
OrganizationDivision | 否 | String | 部门名称。 示例值:IT |
OrganizationAddress | 否 | String | 公司详细地址。 示例值:Shenzhen |
OrganizationCountry | 否 | String | 国家名称,如中国:CN 。 示例值:China |
OrganizationCity | 否 | String | 公司所在城市。 示例值:Shenzhen |
OrganizationRegion | 否 | String | 公司所在省份。 示例值:Guangdong |
PostalCode | 否 | String | 公司邮编。 示例值:137000 |
PhoneAreaCode | 否 | String | 公司座机区号。 示例值:021 |
PhoneNumber | 否 | String | 公司座机号码。 示例值:021-1382344 |
VerifyType | 否 | String | 证书验证方式。验证类型:DNS_AUTO = 自动DNS验证(仅支持在腾讯云解析且解析状态正常的域名使用该验证类型),DNS = 手动DNS验证,FILE = 文件验证。 示例值:DNS |
AdminFirstName | 否 | String | 管理人名。 示例值:Luke |
AdminLastName | 否 | String | 管理人姓。 示例值:SKy |
AdminPhoneNum | 否 | String | 管理人手机号码。 示例值:183****663 |
AdminEmail | 否 | String | 管理人邮箱地址。 示例值:hhhy@qq.com |
AdminPosition | 否 | String | 管理人职位。 示例值:IT |
ContactFirstName | 否 | String | 联系人名。 示例值:Luke |
ContactLastName | 否 | String | 联系人姓。 示例值:SKy |
ContactEmail | 否 | String | 联系人邮箱地址。 示例值:hhhy@qq.com |
ContactNumber | 否 | String | 联系人手机号码。 示例值:183****663 |
ContactPosition | 否 | String | 联系人职位。 示例值:IT |
IsDV | 否 | Boolean | 是否DV证书。默认false 示例值:fasle |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CertificateId | String | 证书 ID。 示例值:sada12 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交证书资料
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitCertificateInformation
<公共请求参数>
{
"CertificateId": "abcb1234",
"CsrType": "online",
"CertificateDomain": "*.test-dq342da.com",
"OrganizationName": "Tencent",
"OrganizationDivision": "Qcloud",
"OrganizationAddress": "南山区腾讯大厦1000号",
"OrganizationCountry": "CN",
"OrganizationCity": "深圳市",
"OrganizationRegion": "广东省",
"PhoneAreaCode": "0755",
"PhoneNumber": "86013388",
"AdminFirstName": "luke",
"AdminLastName": "sky",
"AdminPhoneNum": "12345678901",
"AdminEmail": "test@tencent.com",
"AdminPosition": "developer",
"ContactFirstName": "luke",
"ContactLastName": "sky",
"ContactEmail": "test@tencent.com",
"ContactNumber": "12345678901",
"ContactPosition": "developer"
}
输出示例
{
"Response": {
"CertificateId": "abcb1234",
"RequestId": "9b397ac6-7d01-4fbc-8acc-52dd6ff0877b"
}
}
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.AuthError | 请检查是否有权限。 |
FailedOperation.CertificateNotFound | 证书不存在。 |
FailedOperation.ExceedsFreeLimit | 免费证书数量超出限制。 |
FailedOperation.InvalidCertificateStatusCode | 证书状态不正确。 |
FailedOperation.InvalidParam | 参数有误。 |
FailedOperation.NoProjectPermission | 您没有该项目的操作权限。 |
FailedOperation.NoRealNameAuth | 尚未通过实名认证。 |
InternalError | 内部错误。 |