This product(
cas/2020-04-07) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Resource Group
| API | Title | Description |
|---|---|---|
| MoveResourceGroup | MoveResourceGroup | Changes the resource group to which a certificate or certificate order belongs. |
Deployment Tasks
| API | Title | Description |
|---|---|---|
| ListDeploymentJob | ListDeploymentJob | Queries a list of deployment tasks that are created. |
| DescribeDeploymentJob | DescribeDeploymentJob | Queries the details of a deployment task. You can call the CreateDeploymentJob operation to create a deployment task and obtain the ID of the task. |
| ListWorkerResource | ListWorkerResource | Queries the details about the worker tasks of a deployment task. Alibaba Cloud allows you to deploy multiple certificates at a time. Therefore, a deployment task may include multiple worker tasks in multiple cloud services. A worker task refers to a task that deploys a certificate to a cloud resource in a cloud service. |
| DescribeDeploymentJobStatus | DescribeDeploymentJobStatus | Queries the number of worker tasks in a deployment task. |
| UpdateDeploymentJob | UpdateDeploymentJob | Updates a deployment task. |
| ListDeploymentJobResource | ListDeploymentJobResource | Queries the cloud resources of cloud services in a deployment task. |
| UpdateDeploymentJobStatus | UpdateDeploymentJobStatus | Updates the status of a deployment task. |
| ListContact | ListContact | Queries a list of contacts. |
| DescribeCloudResourceStatus | DescribeCloudResourceStatus | Queries the number of third-party cloud resources on which you deployed certificates by using a multi-cloud deployment task. |
| ListCloudResources | ListCloudResources | Queries cloud service providers and the resources of the related cloud services. |
| ListDeploymentJobCert | ListDeploymentJobCert | Queries the basic information about a deployment task. After you create a deployment task, you can call this operation to obtain the basic information about the deployment task, including the instance ID, type, and name of the certificate. |
| UpdateWorkerResourceStatus | UpdateWorkerResourceStatus | Rolls back or executes a worker task in a deployment task. |
| DeleteWorkerResource | DeleteWorkerResource | Deletes the worker of a deployment task. |
| DeleteDeploymentJob | DeleteDeploymentJob | Deletes a deployment task. |
| ListCloudAccess | ListCloudAccess | Queries a list of AccessKey pairs for multi-cloud deployment. |
| CreateDeploymentJob | CreateDeploymentJob | Creates a deployment task. |
Certificate applications
| API | Title | Description |
|---|---|---|
| DescribeCertificateState | DescribeCertificateState | Queries the status of a specified certificate application order. |
| CreateCertificateWithCsrRequest | CreateCertificateWithCsrRequest | Purchases, applies for, and issues a domain validated (DV) certificate by using a custom certificate signing request (CSR) file. You can use extended certificate services to purchase and apply for a DV certificate with a few clicks. |
| CreateCertificateRequest | CreateCertificateRequest | Purchases, applies for, and issues a domain validated (DV) certificate by using extended certificate services. |
| DeleteCertificateRequest | DeleteCertificateRequest | Deletes an order in which the application for a domain validated (DV) certificate failed. |
| UploadUserCertificate | UploadUserCertificate | Uploads a certificate. |
| GetUserCertificateDetail | GetUserCertificateDetail | Queries the details of a certificate. |
Orders
| API | Title | Description |
|---|---|---|
| DescribePackageState | DescribePackageState | Queries the quota for domain validated (DV) certificates that you purchase and the quota usage. |
| ListUserCertificateOrder | ListUserCertificateOrder | Queries the certificates or certificate orders of users. |
| CreateCertificateForPackageRequest | CreateCertificateForPackageRequest | Submits a certificate application. |
| CancelCertificateForPackageRequest | CancelCertificateForPackageRequest | Revokes an issued certificate and cancels the application order of the certificate. |
| CancelOrderRequest | CancelOrderRequest | Cancels a certificate application order that is in the pending validation or being reviewed state. |
| RenewCertificateOrderForPackageRequest | RenewCertificateOrderForPackageRequest | Submits a renewal application for an issued certificate. |
Certificate Application Repository
| API | Title | Description |
|---|---|---|
| GetCertWarehouseQuota | GetCertWarehouseQuota | Queries the quota for certificate repositories. |
| ListCertWarehouse | ListCertWarehouse | Queries certificate repositories. |
| ListCert | ListCert | Queries the certificates in a certificate repository. |
| Sign | Sign | Signs a private certificate in a certificate application repository. |
| Verify | Verify | Verifies the signature of a private certificate in a certificate application repository. |
| Encrypt | Encrypt | Encrypts a certificate in a certificate repository. |
| Decrypt | Decrypt | Decrypts a certificate in a certificate repository. |
| DeletePCACert | DeletePCACert | Deletes a private certificate from a certificate application repository. |
CSR Management
| API | Title | Description |
|---|---|---|
| ListCsr | ListCsr | Queries certificate signing requests (CSRs). |
| CreateCsr | CreateCsr | Creates a certificate signing request (CSR). A CSR file contains the information about an SSL certificate that you want to apply for. The information includes the domain names that you want to bind to the certificate and the name and the geographical location of the certificate holder. When you submit a certificate application to a certificate authority (CA), you must provide a CSR. After the CA approves your certificate application, the CA uses the private key of the root CA to sign your CSR and generates a public key file. The public key file is the SSL certificate that the CA issues to you. The private key of the SSL certificate is generated when you create the CSR. |
| UploadCsr | UploadCsr | Uploads a certificate signing request (CSR) file |
| GetCsrDetail | GetCsrDetail | Queries the content of a certificate signing request (CSR). |
| UpdateCsr | UpdateCsr | Updates the private key of a certificate signing request (CSR). |
| DeleteCsr | DeleteCsr | Deletes a certificate signing request (CSR) file. |
Others
| API | Title | Description |
|---|---|---|
| DeleteUserCertificate | DeleteUserCertificate | Deletes an expired or uploaded certificate. |