Issues a single client certificate based on a system-generated certificate signing request (CSR).
Operation description
Before calling this operation, you must have called CreateRootCACertificate to create a root CA certificate and called CreateSubCACertificate to create a sub-CA certificate. Only sub-CA certificates can issue client certificates.
QPS limit
The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:CreateClientCertificate |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SanType |
integer |
No |
The Subject Alternative Name (SAN) type supported by the client certificate. Valid values:
|
1 |
| SanValue |
string |
No |
The specific SAN extension information of the client certificate. You can enter multiple SAN values separated by commas (,). |
somebody@example.com |
| Organization |
string |
No |
The organization name. Default value: Alibaba Inc. |
Alibaba Cloud |
| OrganizationUnit |
string |
No |
The department name. Default value: Aliyun CDN. |
IT |
| Country |
string |
No |
The country. Default value: CN. |
CN |
| CommonName |
string |
No |
The name of the certificate subject. The subject of a client authentication (ClientAuth) certificate is typically a person, company, organization, or application. Specify the common name of the subject. For example, John Doe, Alibaba, Alibaba Cloud Crypto Platform, or Tmall Genie. |
aliyun |
| State |
string |
No |
The name of the province or state where the certificate organization is located. Chinese and English characters are supported. Default value: the province or state of the sub-CA certificate that issues this certificate. |
Zhejiang |
| Locality |
string |
No |
The name of the city where the certificate organization is located. Chinese and English characters are supported. Default value: the city of the sub-CA certificate that issues this certificate. |
Hangzhou |
| Algorithm |
string |
No |
The key algorithm of the client certificate. The key algorithm is in the format of
The encryption algorithm of the client certificate must be the same as that of the sub-CA certificate, but the key length can be different. For example, if the key algorithm of the sub-CA certificate is RSA_2048, the key algorithm of the client certificate must be RSA_1024, RSA_2048, or RSA_4096. Note
You can call DescribeCACertificate to query the key algorithm of the sub-CA certificate. |
RSA_2048 |
| ParentIdentifier |
string |
No |
The unique identifier of the sub-CA certificate that issues this certificate. The Private Certificate Authority instance (PrivateCaInstanceId) bound to the sub-CA must be in a valid and unexpired state. Note
You can call [DescribeCACertificateList] to query the unique identifier of the sub-CA certificate. |
273ae6bb538d538c70c01f81jh2**** |
| Years |
integer |
No |
The validity period of the certificate. Unit: years. |
5 |
| Months |
integer |
No |
The validity period of the certificate. Unit: months. |
1 |
| Days |
integer |
No |
The validity period of the client certificate. Unit: days. The Days, BeforeTime, and AfterTime parameters cannot all be empty, and the BeforeTime and AfterTime parameters must both be empty or both be specified. The following rules apply:
Note
|
365 |
| BeforeTime |
integer |
No |
The issuance time of the client certificate in timestamp format. Default value: the time when you call this operation. Unit: seconds. Note
The BeforeTime and AfterTime parameters must both be empty or both be specified. |
1634283958 |
| AfterTime |
integer |
No |
The expiration time of the client certificate in timestamp format. Unit: seconds. Note
The BeforeTime and AfterTime parameters must both be empty or both be specified. |
1665819958 |
| Immediately |
integer |
No |
Specifies whether to immediately return the digital certificate. Valid values:
|
1 |
| EnableCrl |
integer |
No |
Specifies whether to include the Certificate Revocation List (CRL) address. Valid values:
|
1 |
| Tags |
array<object> |
No |
The tag list. |
|
|
object |
No |
The tag list. |
||
| Key |
string |
No |
The tag key. |
account |
| Value |
string |
No |
The tag value. |
1 |
| ResourceGroupId |
string |
No |
The resource group ID. |
rg-aek****wia |
| CustomIdentifier |
string |
No |
The custom identifier, which serves as a unique key. |
****6bb538d538c70c01f81jh2**** |
| AliasName |
string |
No |
The name of the issued certificate. |
cert-name |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can contain up to 64 ASCII characters and cannot contain non-ASCII characters. |
XXX |
| AsynchronousFlag |
boolean |
No |
The asynchronous processing flag. If the value is set to "true", the backend service issues the certificate asynchronously. After the request is submitted, you can call the ListClientCertificate operation to obtain the latest certificate. |
false |
When calling this operation, in addition to the request parameters described in this topic, you must also include Alibaba Cloud API common request parameters.
For the request format, refer to the request example in the Examples section of this topic.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
CreateCertificateResponse |
||
| X509Certificate |
string |
The content of the client certificate. |
-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE----- |
| CertificateChain |
string |
The CA certificate chain. |
-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n |
| Identifier |
string |
The unique identifier of the client certificate. |
190ae6bb538d538c70c01f81dcf2**** |
| SerialNumber |
string |
The certificate serial number. |
084bde9cd233f0ddae33adc438cfbbbd**** |
| RequestId |
string |
The request ID. Alibaba Cloud generates a unique identifier for each request, which can be used for troubleshooting and diagnostics. |
8C467B38-3910-447D-87BC-AC049166F216 |
Examples
Success response
JSON format
{
"X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
"CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
"Identifier": "190ae6bb538d538c70c01f81dcf2****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"RequestId": "8C467B38-3910-447D-87BC-AC049166F216"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.