Creating a CSR
Function
Create a CSR.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
scm::createCsr
Write
-
-
-
-
URI
POST /v3/scm/csr
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
Yes |
String |
User-defined CSR name. Minimum: 0 Maximum: 63 |
|
domain_name |
Yes |
String |
Domain name bound to the CSR. If you want to use the CSR, ensure the domain name bound to a certificate contains the domain name set here. Minimum: 0 Maximum: 63 |
|
sans |
No |
String |
Additional domain name bound to the CSR. Minimum: 0 Maximum: 255 |
|
private_key_algo |
Yes |
String |
Private key algorithm. The value can be: Minimum: 0 Maximum: 63 |
|
usage |
Yes |
String |
CSR usage. The value can be: Minimum: 0 Maximum: 255 |
|
company_country |
No |
String |
Country. This parameter is mandatory when usage is set to ENTERPRISE. Example value: CN. Minimum: 0 Maximum: 255 |
|
company_province |
No |
String |
Province. This parameter is mandatory when usage is set to ENTERPRISE. Example: Beijing. Minimum: 0 Maximum: 255 |
|
company_city |
No |
String |
City. This parameter is mandatory when usage is set to ENTERPRISE. Example: Beijing. Minimum: 0 Maximum: 255 |
|
company_name |
No |
String |
Company name. This parameter is mandatory when usage is set to ENTERPRISE. Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 201
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
CSR ID. Minimum: 0 Maximum: 63 |
|
name |
String |
User-defined CSR name. Minimum: 0 Maximum: 63 |
|
domain_name |
String |
Domain name. Minimum: 0 Maximum: 63 |
|
sans |
String |
Additional domain name bound to the CSR. Minimum: 0 Maximum: 255 |
|
private_key_algo |
String |
Key algorithm type. The options are as follows: Minimum: 0 Maximum: 63 |
|
usage |
String |
CSR usage. The value can be: Minimum: 0 Maximum: 255 |
|
company_country |
String |
Country. This parameter is mandatory when usage is set to ENTERPRISE. Minimum: 0 Maximum: 255 |
|
company_province |
String |
Province. This parameter is mandatory when usage is set to ENTERPRISE. Minimum: 0 Maximum: 255 |
|
company_city |
String |
City. This parameter is mandatory when usage is set to ENTERPRISE. Minimum: 0 Maximum: 255 |
|
company_name |
String |
Company name. This parameter is mandatory when usage is set to ENTERPRISE. Minimum: 0 Maximum: 255 |
|
create_time |
Long |
CSR creation time. Minimum: 13 Maximum: 20 |
|
update_time |
Long |
CSR update time. Minimum: 13 Maximum: 20 |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. Minimum: 3 Maximum: 36 |
|
error_msg |
String |
Error information returned for an error request. Minimum: 0 Maximum: 1024 |
Example Requests
{
"name" : "CSRxxxx",
"domain_name" : "xxx.com",
"private_key_algo" : "RSA_2048",
"usage" : "ENTERPRISE"
}
Example Responses
Status code: 201
Normal response.
{
"id" : "48e392628b0f47769e47d91acc7654a5",
"name" : "xxxx",
"domain_name" : "xxx.com",
"sans" : "",
"private_key_algo" : "RSA_2048",
"usage" : "ENTERPRISE",
"company_country" : "CN",
"company_province" : "Beijing",
"company_city" : "Beijing",
"company_name" : "company",
"create_time" : 1735804566545,
"update_time" : 1735804566545
}
Status code: 401
Authentication failed.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
Status code: 403
Access denied.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
Status code: 500
Failed to complete the request because of an internal server error.
{
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.scm.v3.region.ScmRegion; import com.huaweicloud.sdk.scm.v3.*; import com.huaweicloud.sdk.scm.v3.model.*; public class CreateCsrSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ScmClient client = ScmClient.newBuilder() .withCredential(auth) .withRegion(ScmRegion.valueOf("<YOUR REGION>")) .build(); CreateCsrRequest request = new CreateCsrRequest(); CreateCsrRequestBody body = new CreateCsrRequestBody(); body.withUsage("ENTERPRISE"); body.withPrivateKeyAlgo("RSA_2048"); body.withDomainName("xxx.com"); body.withName("CSRxxxx"); request.withBody(body); try { CreateCsrResponse response = client.createCsr(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkscm.v3.region.scm_region import ScmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkscm.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ScmClient.new_builder() \ .with_credentials(credentials) \ .with_region(ScmRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateCsrRequest() request.body = CreateCsrRequestBody( usage="ENTERPRISE", private_key_algo="RSA_2048", domain_name="xxx.com", name="CSRxxxx" ) response = client.create_csr(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" scm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/scm/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := scm.NewScmClient( scm.ScmClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateCsrRequest{} request.Body = &model.CreateCsrRequestBody{ Usage: "ENTERPRISE", PrivateKeyAlgo: "RSA_2048", DomainName: "xxx.com", Name: "CSRxxxx", } response, err := client.CreateCsr(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
201 |
Normal response. |
|
401 |
Authentication failed. |
|
403 |
Access denied. |
|
404 |
Access page not found. |
|
500 |
Failed to complete the request because of an internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot