文档

API概览

更新时间:
本产品(数字证书管理服务(原SSL证书)/2020-04-07)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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证书仓库中证书解密本接口一般用于证书仓库中证书解密。
UploadPCACert上传证书仓库pca证书本接口一般用于在证书仓库中上传PCA证书。
DeletePCACert删除证书仓库中上传的pca证书本接口一般用于删除证书仓库中PCA证书。
CreateWHClientCertificate申请证书仓库中客户端证书一般用户证书仓库中,申请签发单个客户端证书。
RevokeWHClientCertificate吊销证书仓库中客户端证书一般用于吊销证书仓库中客户端证书。

CSR管理

API标题API概述
ListCsr查询CSR列表查询CSR列表信息及CSR详细信息。
CreateCsr创建CSRCSR是证书请求文件,包含您的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删除证书删除已过期或上传的证书。