创建证书 - CreateCertificate
功能介绍
创建证书
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/certificate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围:
默认取值: 0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
是 |
String |
内容类型 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
证书名称,证书名称只能由数字、字母、中划线、下划线和英文句点组成,长度不能超过256位字符 |
|
content |
是 |
String |
证书文件,仅支持PEM格式的证书和私钥文件,且文件中的换行符应以\n替换,如请求示例所示 |
|
key |
是 |
String |
证书私钥,仅支持PEM格式的证书和私钥文件,且文件中的换行符应以\n替换,如请求示例所示 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
证书ID |
|
name |
String |
证书名 |
|
content |
String |
证书文件,PEM编码 |
|
key |
String |
证书私钥,PEM编码 |
|
expire_time |
Long |
证书过期时间戳 |
|
exp_status |
Integer |
证书过期状态,0-未过期,1-已过期,2-即将过期 |
|
timestamp |
Long |
证书上传时间戳 |
|
bind_host |
Array of BindHost objects |
证书关联的域名信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
域名ID |
|
hostname |
String |
域名 |
|
waf_type |
String |
域名对应模式:cloud(云模式)/premium(独享模式) |
|
mode |
String |
仅独享模式涉及特殊域名模式 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
|
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
在项目id为project_id的项目中创建证书,证书名称为 "demo",证书内容为 "-----BEGIN CERTIFICATE----- ……“,证书密钥为"-----BEGIN PRIVATE KEY-----……”。
POST https://{Endpoint}/v1/{project_id}/waf/certificate?enterprise_project_id=0
{
"name" : "demo",
"content" : "-----BEGIN CERTIFICATE----- \\n******\\n -----END CERTIFICATE-----",
"key" : "-----BEGIN PRIVATE KEY----- \\n*******\\n -----END PRIVATE KEY-----"
}
响应示例
状态码:200
OK
{
"id" : "64af92e2087d49cbabc233e9bdc761b7",
"name" : "testly",
"timestamp" : 1658994431596,
"expire_time" : 1682394560000
}
SDK代码示例
SDK代码示例如下。
在项目id为project_id的项目中创建证书,证书名称为 "demo",证书内容为 "-----BEGIN CERTIFICATE----- ……“,证书密钥为"-----BEGIN PRIVATE KEY-----……”。
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 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.waf.v1.region.WafRegion; import com.huaweicloud.sdk.waf.v1.*; import com.huaweicloud.sdk.waf.v1.model.*; public class CreateCertificateSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); CreateCertificateRequest request = new CreateCertificateRequest(); CreateCertificateRequestBody body = new CreateCertificateRequestBody(); body.withKey("-----BEGIN PRIVATE KEY----- \n*******\n -----END PRIVATE KEY-----"); body.withContent("-----BEGIN CERTIFICATE----- \n******\n -----END CERTIFICATE-----"); body.withName("demo"); request.withBody(body); try { CreateCertificateResponse response = client.createCertificate(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()); } } } |
在项目id为project_id的项目中创建证书,证书名称为 "demo",证书内容为 "-----BEGIN CERTIFICATE----- ……“,证书密钥为"-----BEGIN PRIVATE KEY-----……”。
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 BasicCredentials from huaweicloudsdkwaf.v1.region.waf_region import WafRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkwaf.v1 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateCertificateRequest() request.body = CreateCertificateRequestBody( key="-----BEGIN PRIVATE KEY----- \n*******\n -----END PRIVATE KEY-----", content="-----BEGIN CERTIFICATE----- \n******\n -----END CERTIFICATE-----", name="demo" ) response = client.create_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) |
在项目id为project_id的项目中创建证书,证书名称为 "demo",证书内容为 "-----BEGIN CERTIFICATE----- ……“,证书密钥为"-----BEGIN PRIVATE KEY-----……”。
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateCertificateRequest{} request.Body = &model.CreateCertificateRequestBody{ Key: "-----BEGIN PRIVATE KEY----- \n*******\n -----END PRIVATE KEY-----", Content: "-----BEGIN CERTIFICATE----- \n******\n -----END CERTIFICATE-----", Name: "demo", } response, err := client.CreateCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。