导入证书 - ImportCertificate
功能介绍
导入证书到CCM服务管理。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
scm:cert:import
Write
cert *
-
- scm:cert:upload
-
-
g:EnterpriseProjectId
URI
POST /v3/scm/certificates/import
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
证书名称。字符长度为3~63位, 请输入英文字符,数字,下划线,中划线,英文句点。 最小长度:3 最大长度:63 |
|
certificate |
是 |
String |
证书内容,可包含中间证书及根证书。若certificate_chain字段传入证书链,则该字段只取证书本身。回车换行需要使用转义字符\n或者\r\n替换。 最小长度:0 最大长度:4096 |
|
certificate_chain |
否 |
String |
证书链,非必填,可通过certificate字段传入。回车换行需要使用转义字符\n或者\r\n替换。 最小长度:0 最大长度:8192 |
|
private_key |
是 |
String |
证书私钥。 不能上传带有口令保护的私钥,回车换行需要使用转义字符\n或者\r\n替换。 最小长度:0 最大长度:4096 |
|
duplicate_check |
否 |
Boolean |
是否允许上传相同证书。 |
|
enterprise_project_id |
否 |
String |
企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件。 最小长度:0 最大长度:64 |
|
enc_certificate |
否 |
String |
可选参数,国密证书的加密证书内容。回车换行需要使用转义字符\n或者\r\n替换。 最小长度:0 最大长度:4096 |
|
enc_private_key |
否 |
String |
可选参数,国密证书的加密私钥。 不能上传带有口令保护的私钥,回车换行需要使用转义字符\n或者\r\n替换。 最小长度:0 最大长度:4096 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
certificate_id |
String |
证书id。 最小长度:16 最大长度:16 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
请求示例
{
"name" : "test_cert",
"certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----",
"private_key" : "-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----"
}
响应示例
状态码:200
正常返回。
{
"certificate_id" : "scs1600313391074"
}
状态码: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 |
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 ImportCertificateSolution { 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(); ImportCertificateRequest request = new ImportCertificateRequest(); ImportCertificateRequestBody body = new ImportCertificateRequestBody(); body.withPrivateKey("-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----"); body.withCertificate("-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----"); body.withName("test_cert"); request.withBody(body); try { ImportCertificateResponse response = client.importCertificate(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 |
# 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 = ImportCertificateRequest() request.body = ImportCertificateRequestBody( private_key="-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----", certificate="-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----", name="test_cert" ) response = client.import_certificate(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 |
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.ImportCertificateRequest{} request.Body = &model.ImportCertificateRequestBody{ PrivateKey: "-----BEGIN RSA PRIVATE KEY-----*********-----END RSA PRIVATE KEY-----", Certificate: "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----", Name: "test_cert", } response, err := client.ImportCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回。 |
|
401 |
认证失败。 |
|
403 |
禁止访问。 |
|
404 |
访问页面未找到。 |
|
500 |
请求未完成,服务器内部异常。 |
错误码
请参见错误码。