本产品(
数字证书管理服务(原SSL证书)/2020-04-07
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
资源组
API | 标题 | API概述 |
---|---|---|
MoveResourceGroup | 修改资源所属的资源组 | 修改证书或证书订单资源所属的资源组。 |
部署任务
API | 标题 | API概述 |
---|---|---|
ListDeploymentJob | 获取部署任务列表 | 创建部署任务后,您可以通过该接口获取部署任务列表。 |
DescribeDeploymentJob | 获取部署任务详情 | 通过CreateDeploymentJob创建部署任务后会获取任务ID,您可以通过该任务ID调用本接口获取部署任务详情。 |
ListWorkerResource | 获取部署任务下的Worker任务列表 | 阿里云支持批量部署证书,因此一个部署任务中可能对应多个云产品子任务(Worker),对应每个产品中的资源实例,您可通过该接口查看Worker任务详细信息。 |
DescribeDeploymentJobStatus | 获取部署任务下的Worker任务数 | 获取部署任务下的Worker任务数。 |
UpdateDeploymentJob | 更新部署任务 | 更新部署任务。 |
ListDeploymentJobResource | 获取部署任务的云产品资源列表 | 获取部署任务的云产品资源列表。 |
UpdateDeploymentJobStatus | 更新部署任务状态 | 更新部署任务状态。 |
ListContact | 获取联系人列表 | 获取联系人列表。 |
DescribeCloudResourceStatus | 获取多云部署的云产品资源数 | 您可通过本接口获取通过多云部署任务,部署证书到三方云产品的资源数。 |
ListCloudResources | 获取云厂商及对应云产品的资源列表 | 您可以通过本接口获取云厂商及对应云产品的资源列表。 |
ListDeploymentJobCert | 获取部署任务的证书详情 | 创建部署任务后,可通过本接口获取部署到云产品的证书基本信息,例如证书实例ID、证书类型、证书名称等。 |
UpdateWorkerResourceStatus | 更新部署任务下的Worker任务状态 | 您可以通过该接口立即回滚或执行部署任务下的Worker任务。 |
DeleteWorkerResource | 删除部署任务下的Worker任务 | 删除部署任务worker(预览)。 |
DeleteDeploymentJob | 删除部署任务 | 删除部署任务。 |
ListCloudAccess | 获取多云部署任务AK列表 | 多云部署获取AK列表。 |
CreateDeploymentJob | 创建部署任务 | SSL证书签发完成后,您可以通过该接口创建不同类型的证书部署任务,立即或手动指定任务部署时间,将SSL证书部署到阿里云产品或三方云产品,为您的业务网站提供可信身份认证和安全数据传输。 |
证书请求
API | 标题 | API概述 |
---|---|---|
DescribeCertificateState | 查询DV证书的申请状态 | 查询指定的证书申请订单的状态。 |
CreateCertificateWithCsrRequest | 购买、申请和签发自带CSR文件的DV证书 | 购买、申请和签发自带CSR文件的DV证书。证书扩展服务可通过一步完成DV证书的购买和申请。 |
CreateCertificateRequest | 完成DV证书购买申请和签发流程 | 完成扩展服务DV证书的购买、申请和签发流程。 |
DeleteCertificateRequest | 删除DV证书申请失败的订单 | 删除DV证书申请失败的订单。 |
UploadUserCertificate | 上传证书 | 本接口一般用于上传证书,包括标准国密证书或非国密证书。 |
GetUserCertificateDetail | 获取证书详情 | 本接口一般用于获取证书详情。 |
订单
API | 标题 | API概述 |
---|---|---|
DescribePackageState | 查询已经购买的DV证书总数和使用情况 | 查询已经购买的DV证书总数和使用情况。 |
ListUserCertificateOrder | 查询用户证书或者订单列表 | 查询用户证书或者订单列表。 |
CreateCertificateForPackageRequest | 请求创建证书 | 提交证书申请。 |
CancelCertificateForPackageRequest | 取消包请求的证书 | 吊销已签发的证书(取消对应的证书申请订单)。 |
CancelOrderRequest | 取消未支付订单 | 撤回待验证、审核中的证书申请订单。 |
RenewCertificateOrderForPackageRequest | 续订证书订单 | 为已签发的证书申请订单续费。 |
证书仓库
API | 标题 | API概述 |
---|---|---|
GetCertWarehouseQuota | 证书仓库调用额度查询 | 调用证书应用仓库签名、验签、加密和解密API时,会消耗API调用次数,API调用次数消耗完时,您将无法再调用相应的API。本接口一般用于查询证书仓库额度。 |
ListCertWarehouse | 证书仓库列表查询 | 本接口一般用于查询证书仓库列表。 |
ListCert | 证书仓库中证书列表 | 本接口一般用于查询证书仓库中的证书。 |
Sign | 证书仓库签名 | 本接口一般用于证书仓库中的PCA证书签名。 |
Verify | 证书仓库签名验签 | 本接口一般用于证书仓库中PCA证书的签名校验。 |
Encrypt | 证书仓库中证书加密 | 本接口一般用于证书仓库中证书加密。 |
Decrypt | 证书仓库中证书解密 | 本接口一般用于证书仓库中证书解密。 |
DeletePCACert | 删除证书仓库中上传的pca证书 | 本接口一般用于删除证书仓库中PCA证书。 |
CSR管理
API | 标题 | API概述 |
---|---|---|
ListCsr | 查询CSR列表 | 查询CSR列表信息及CSR详细信息。 |
CreateCsr | 创建CSR | CSR是证书请求文件,包含您的SSL证书信息,例如,证书绑定的域名、证书持有主体的名称及地理位置信息等。您向CA中心提交证书申请时,必须提供CSR。CA中心审核通过您的证书申请后,将使用其根CA私钥为您提供的CSR签名,生成SSL证书公钥(即签发给您的SSL证书)。SSL证书的私钥即您在生成CSR时同时生成的私钥。 |
UploadCsr | 上传CSR | 阿里云数字证书管理服务支持上传已有的CSR,以便申请证书时使用,同时也可对上传的CSR进行统一管理。 |
GetCsrDetail | 获取CSR | 通过CreateCsr接口创建CSR后会返回CsrId,您可以通过CsrId直接获取CSR内容。 |
UpdateCsr | 上传或更新CSR私钥 | 如果您在上传本地CSR时未传入CSR私钥,您可以通过该接口上传或更新CSR对应的私钥。 |
DeleteCsr | 删除CSR | 如果您不再需要某个CSR,可以将其删除。 |
其他
API | 标题 | API概述 |
---|---|---|
DeleteUserCertificate | 删除证书 | 删除已过期或上传的证书。 |