API standards and multilingual preset SDKs
The OpenAPI of this product (cas/2020-06-30) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Private CA certificates
|
API |
Title |
Description |
| CreateRootCACertificate | Create a root CA certificate | Creates a root CA certificate. |
| CreateSubCACertificate | Create a subordinate CA certificate | Creates a subordinate CA certificate. |
| CreateExternalCACertificate | Create an external subordinate CA certificate | Creates and issues an external subordinate CA certificate based on a CSR and API parameters. |
| GetCAInstanceStatus | Query the status information of CA instances | Queries the status information of the private root CA instances or private subordinate CA instances that you purchased from the SSL Certificate Service console. |
| DescribeCACertificateCount | Query the number of created CA certificates | Queries the number of created CA certificates. |
| DescribeCACertificateList | Query information about all root CA certificates and subordinate CA certificates | Queries information about all root CA certificates and subordinate CA certificates. |
| DescribeCACertificate | Query the details of a single root CA certificate or subordinate CA certificate | Queries the details of a certificate authority (CA). |
| UpdateCACertificateStatus | Update CA certificate status | Changes the status of a root CA certificate or a subordinate CA certificate from issued to revoked. |
Client and server certificates
|
API |
Title |
Description |
| CreateCustomCertificate | Issue a custom certificate | Issues a digital certificate with the specified subject name, subject alternative names, key usage, and extended key usage. |
| CreateClientCertificate | Issue a single client certificate based on a system-generated CSR | Issues a single client certificate based on a system-generated certificate signing request (CSR). |
| CreateClientCertificateWithCsr | Issue a single client certificate based on a custom CSR | Issues a single client certificate based on a custom certificate signing request (CSR). |
| CreateServerCertificate | Issue a single server certificate based on a system-generated CSR | Issues a single server certificate based on a system-generated certificate signing request (CSR). |
| CreateServerCertificateWithCsr | Issue a single server certificate based on a custom CSR | Issues a single server certificate based on a custom CSR. |
| CreateRevokeClientCertificate | Revoke a certificate | Revokes a client certificate or a server certificate. |
| DeleteClientCertificate | Delete a certificate | Deletes a revoked client certificate or server certificate. |
| DescribeCertificatePrivateKey | Retrieve the private key of a certificate | Retrieves the private key (in encrypted format) of a single client certificate or server certificate. |
| DescribeClientCertificate | Query certificate details | Queries the details of a single client certificate or server certificate by using the unique identifier of the certificate. |
| DescribeClientCertificateStatus | Query certificate status information | Queries the status information of client certificates and server certificates by their unique identifiers. |
| ListClientCertificate | List certificates | Queries the details of all client certificates and server certificates. |
| ListRevokeCertificate | List revoked certificates | Queries the details of all revoked client certificates and server certificates. |
Other
|
API |
Title |
Description |
| ListPcaCaCertificate | List private cAs | Queries private CA certificates. |
| ListCert | List certificates issued by a CA | Retrieves a list of certificates. |
| UploadPcaCertToCas | Sync private certificates to certificate service | Uploads a Private Certificate Authority (PCA) certificate to Certificate Management Service. |
| DescribeClientCertificateForSerialNumber | Query certificates by serial number | Queries the details of client certificates or server certificates in batch by certificate serial number. |
| DescribeClientCertificateStatusForSerialNumber | Query certificate status by serial number | Queries the status of client certificates and server certificates by certificate serial number. |
| ListCACertificateLog | Query operation logs of a CA certificate | Queries the operation logs of a CA certificate. |
| DescribePcaAndExternalCACertificateList | Get IPA certificate list | Returns all CA certificates for the user, including certificates generated internally by PCA and imported external certificates. |
| UntagResources | UntagResources | Removes tags from one or more Certificate Management Service resources. |
| MoveResourceGroup | MoveResourceGroup | Moves a Certificate Management Service resource to a different resource group. |
| ListTagResources | Query the mapping between resources and tags | Queries the mapping between resources (SSL certificate instances) and tags. |
| TagResources | Attach tags to a specified resource (SSL certificate instance) | Attaches tags to a specified resource (SSL certificate instance). |
| UpdatePcaCertificate | UpdatePcaCertificate | Updates the properties of a private CA certificate, such as the export status. |
| AssignCertificateCount | Query allocated certificate count | Queries the number of allocated certificates. |
| ListAllEndEntityInstance | Retrieve terminal cAs that can issue certificates | Queries terminal instances. |
| GetCaInstanceCrlAddress | Get the CRL of a CA | Retrieves the certificate revocation list (CRL) URL of a certificate authority (CA). |