1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
使用权益点创建证书
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCertificateByPackage。 |
Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ProductPid | 是 | Integer | 证书产品PID。 |
PackageIds.N | 是 | Array of String | 要消耗的权益包ID。 |
DomainCount | 是 | String | 证书域名数量。 |
Period | 是 | Integer | 多年期证书年限。 |
OldCertificateId | 否 | String | 要续费的原证书ID(续费时填写)。 |
RenewGenCsrMethod | 否 | String | 续费时CSR生成方式(original、upload、online)。 |
RenewCsr | 否 | String | 续费时选择上传CSR时填写CSR。 |
RenewAlgorithmType | 否 | String | 续费证书CSR的算法类型。 |
RenewAlgorithmParam | 否 | String | 续费证书CSR的算法参数。 |
ProjectId | 否 | Integer | 项目ID。 |
Tags.N | 否 | Array of Tags | 标签。 |
RenewKeyPass | 否 | String | 续费证书的私钥密码。 |
DomainNames | 否 | String | 批量购买证书时预填写的域名。 示例值:a.com,b.com,c.com |
CertificateCount | 否 | Integer | 批量购买证书数量。 |
ManagerId | 否 | Integer | 预填写的管理人ID。 |
CompanyId | 否 | Integer | 预填写的公司ID。 |
VerifyType | 否 | String | 验证方式 |
PriceKey | 否 | String | 询价参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CertificateId | String | 证书ID。 |
CertificateIds | Array of String | 批量购买证书时返回多个证书ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用权益点创建证书
使用权益点创建证书
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCertificateByPackage
<公共请求参数>
{
"PackageIds": [
"xx123"
],
"Tags": [
{
"TagKey": "xx123",
"TagValue": "xx123"
}
],
"ProjectId": 1,
"RenewAlgorithmParam": "xx123",
"RenewKeyPass": "xx123",
"Period": 1,
"OldCertificateId": "xx123",
"ProductPid": 1,
"RenewGenCsrMethod": "xx123",
"RenewCsr": "xx123",
"DomainCount": "xx123",
"RenewAlgorithmType": "xx123",
"VerifyType": "DNS"
}
输出示例
{
"Response": {
"CertificateId": "xx123",
"RequestId": "xx123",
"CertificateIds": [
"xx123"
]
}
}
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.TradeError | 计费中心错误。 |
InvalidParameter.DomainCountInvalid | 域名数量无效。 |
InvalidParameter.DomainInvalid | 域名无效,请重新输入。 |
InvalidParameter.PackageIdsInvalid | 权益点ID列表无效。 |
InvalidParameter.PeriodInvalid | 证书期限无效。 |
InvalidParameter.ProductPidInvalid | 产品PID无效。 |
InvalidParameter.RenewAlgorithmInvalid | 算法无效。 |
InvalidParameter.RenewCsrInvalid | CSR无效。 |
InvalidParameter.RenewGenCsrMethodInvalid | 生成CSR方式无效。 |