1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to create a CSR.
A maximum of 10 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common Params. The value used for this API: CreateCSR. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2019-12-05. |
| Region |
No |
String |
Common Params. This parameter is not required for this API. |
| Domain |
Yes |
String |
The domain. |
| Organization |
Yes |
String |
The organization name. |
| Department |
Yes |
String |
The department. |
| Email |
Yes |
String |
The email address. |
| Province |
Yes |
String |
The province. |
| City |
Yes |
String |
The city. |
| Country |
Yes |
String |
The country or region code that complies with ISO 3166, such as CN and US. |
| EncryptAlgo |
Yes |
String |
The encryption algorithm. RSA and ECC are supported. |
| KeyParameter |
Yes |
String |
The key pair parameter. For RSA, only the 2048-bit and 4096-bit key pairs are supported. For ECC, only prime256v1 is supported. |
| Generate |
Yes |
Boolean |
Whether to generate the CSR content. Once the CSR content is generated, the CSR record cannot be modified. |
| KeyPassword |
No |
String |
The password of the private key. |
| Remark |
No |
String |
The remarks. |
| Tags.N |
No |
Array of Tags |
Tag List |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Id |
Integer |
The CSR ID. |
| RequestId |
String |
The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Creating a CSR
This example show you how to create a CSR.
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCSR
{
"Domain": "www.***.com",
"Organization": "Tencent",
"Department": "It",
"Email": "abc@qq.com",
"Province": "Hunan",
"City": "Changsha",
"Country": "China",
"EncryptAlgo": "ECC",
"KeyParameter": "prime256v1",
"Generate": false
}
Output Example
{
"Response": {
"Id": 733,
"RequestId": "f00f136b-c0c8-476a-8097-b1bdfc9d330f"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| FailedOperation |
Operation failed. |
| FailedOperation.CAMAuthorizedFail |
A CAM authentication error occurred. |
| FailedOperation.InvalidParam |
Incorrect parameters. |
| FailedOperation.SystemError |
A system error occurred. |