购买SSL证书 - SubscribeCertificate
功能介绍
购买SSL证书。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/scm/certificates/buy
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cert_brand |
是 |
String |
证书品牌,取值如下: 最小长度:0 最大长度:32 |
|
cert_type |
是 |
String |
证书类型,取值如下: 最小长度:0 最大长度:32 |
|
domain_type |
是 |
String |
域名类型,取值如下: 最小长度:0 最大长度:32 |
|
effective_time |
是 |
Integer |
证书有效期(年)。 最小值:1 最大值:3 |
|
domain_numbers |
是 |
Integer |
域名数量。 最小值:1 最大值:100 |
|
order_number |
是 |
Integer |
购买的证书数量。取值范围为1~100。 最小值:1 最大值:100 |
|
agree_privacy_protection |
是 |
Boolean |
是否同意隐私协议,此处仅能设置为true才能成功购买证书。 |
|
primary_domain_type |
否 |
String |
多域名中的主域名类型。 最小长度:0 最大长度:63 |
|
single_domain_number |
否 |
Integer |
附加单域名数量。 最小值:1 最大值:100 |
|
wildcard_domain_number |
否 |
Integer |
附加泛域名数量。 最小值:1 最大值:100 |
|
is_auto_pay |
否 |
Boolean |
是否开启自动支付。 |
|
enterprise_project_id |
否 |
String |
企业多项目ID。用户未开通企业多项目时,不需要输入该字段。 用户开通企业多项目时,查询资源可以输入该字段。 若用户不输入该字段,默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段,取值满足以下任一条件。 最小长度:0 最大长度:36 |
|
order_id |
否 |
String |
订单号。仅组合购买场景使用。 最小长度:0 最大长度:63 |
|
tags |
否 |
Array of ScsResourceTag objects |
标签列表。 数组长度:0 - 10 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
order_id |
String |
订单号。 最小长度:0 最大长度:63 |
|
cert |
Array of CertDetail objects |
证书列表,详情请参见CertDetail字段数据结构说明。 数组长度:0 - 1000 |
状态码: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 |
请求示例
{
"cert_brand" : "GLOBALSIGN",
"cert_type" : "OV_SSL_CERT",
"domain_type" : "MULTI_DOMAIN",
"effective_time" : 1,
"domain_numbers" : 5,
"order_number" : 1,
"agree_privacy_protection" : true
}
响应示例
状态码:200
正常返回。
{
"order_id" : "CS1803192259ROA8U",
"cert" : [ {
"cert_id" : "scs1481110651012"
} ]
}
状态码: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 52 53 54 |
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 SubscribeCertificateSolution { 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(); SubscribeCertificateRequest request = new SubscribeCertificateRequest(); PurchaseCertificateRequestBody body = new PurchaseCertificateRequestBody(); body.withAgreePrivacyProtection(true); body.withOrderNumber(1); body.withDomainNumbers(5); body.withEffectiveTime(1); body.withDomainType("MULTI_DOMAIN"); body.withCertType("OV_SSL_CERT"); body.withCertBrand("GLOBALSIGN"); request.withBody(body); try { SubscribeCertificateResponse response = client.subscribeCertificate(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 37 38 39 |
# 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 = SubscribeCertificateRequest() request.body = PurchaseCertificateRequestBody( agree_privacy_protection=True, order_number=1, domain_numbers=5, effective_time=1, domain_type="MULTI_DOMAIN", cert_type="OV_SSL_CERT", cert_brand="GLOBALSIGN" ) response = client.subscribe_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 41 42 43 44 |
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.SubscribeCertificateRequest{} request.Body = &model.PurchaseCertificateRequestBody{ AgreePrivacyProtection: true, OrderNumber: int32(1), DomainNumbers: int32(5), EffectiveTime: int32(1), DomainType: "MULTI_DOMAIN", CertType: "OV_SSL_CERT", CertBrand: "GLOBALSIGN", } response, err := client.SubscribeCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回。 |
|
401 |
认证失败。 |
|
403 |
禁止访问。 |
|
404 |
访问页面未找到。 |
|
500 |
请求未完成,服务器内部异常。 |
错误码
请参见错误码。