更新时间:2025-11-28 GMT+08:00

创建CSR - CreateCsr

功能介绍

创建CSR。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    scm::createCsr

    Write

    -

    -

    -

    -

URI

POST /v3/scm/csr

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:32

最大长度:2097152

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

自定义CSR名称。

最小长度:0

最大长度:63

domain_name

String

CSR绑定的域名。如果您想在提交证书申请时使用该CSR,必须确保证书绑定域名包含此处设置的域名。

最小长度:0

最大长度:63

sans

String

CSR绑定的附加域名。

最小长度:0

最大长度:255

private_key_algo

String

私钥算法。取值如下:

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

最小长度:0

最大长度:63

usage

String

CSR用途。取值如下:

  • PERSONAL:个人证书

  • ENTERPRISE:企业证书

最小长度:0

最大长度:255

company_country

String

国家,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:CN。

最小长度:0

最大长度:255

company_province

String

省份,当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。

最小长度:0

最大长度:255

company_city

String

城市。当“usage”取值为“ENTERPRISE”时,本参数必填。取值示例:北京市。

最小长度:0

最大长度:255

company_name

String

公司名称。当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

响应参数

状态码:201

表3 响应Body参数

参数

参数类型

描述

id

String

CSR的ID。

最小长度:0

最大长度:63

name

String

自定义CSR名称。

最小长度:0

最大长度:63

domain_name

String

域名。

最小长度:0

最大长度:63

sans

String

CSR绑定的附加域名。

最小长度:0

最大长度:255

private_key_algo

String

密钥算法的类型。取值如下

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • EC_P256

  • EC_P384

  • SM2

最小长度:0

最大长度:63

usage

String

CSR用途。取值如下:

  • PERSONAL:个人证书

  • ENTERPRISE:企业证书

最小长度:0

最大长度:255

company_country

String

国家,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_province

String

省份,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_city

String

城市,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

company_name

String

公司名称,当“usage”取值为“ENTERPRISE”时,本参数必填。

最小长度:0

最大长度:255

create_time

Long

CSR创建时间。

最小值:13

最大值:20

update_time

Long

CSR更新时间。

最小值:13

最大值:20

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

请求示例

{
  "name" : "CSRxxxx",
  "domain_name" : "xxx.com",
  "private_key_algo" : "RSA_2048",
  "usage" : "ENTERPRISE"
}

响应示例

状态码:201

正常返回。

{
  "id" : "48e392628b0f47769e47d91acc7654a5",
  "name" : "xxxx",
  "domain_name" : "xxx.com",
  "sans" : "",
  "private_key_algo" : "RSA_2048",
  "usage" : "ENTERPRISE",
  "company_country" : "CN",
  "company_province" : "北京市",
  "company_city" : "北京市",
  "company_name" : "company",
  "create_time" : 1735804566545,
  "update_time" : 1735804566545
}

状态码:401

认证失败。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码:403

禁止访问。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

状态码:500

请求未完成,服务器内部异常。

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

SDK代码示例

SDK代码示例如下。

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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

正常返回。

401

认证失败。

403

禁止访问。

404

访问页面未找到。

500

请求未完成,服务器内部异常。

错误码

请参见错误码