绑定证书到域名
功能介绍
绑定证书到域名
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/certificate/{certificate_id}/apply-to-hosts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
certificate_id |
是 |
String |
https证书id,您可以通过调用查询证书列表(ListCertificates)接口获取证书id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cloud_host_ids |
否 |
Array of strings |
云模式HTTPS域名id,通过查询云模式防护域名列表(ListHost)接口获取 |
premium_host_ids |
否 |
Array of strings |
独享模式HTTPS域名id,通过独享模式域名列表(ListPremiumHost)接口获取 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
证书id |
name |
String |
证书名 |
timestamp |
Long |
时间戳 |
expire_time |
Long |
过期时间 |
bind_host |
Array of CertificateBundingHostBody objects |
绑定域名列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名id |
hostname |
String |
域名 |
waf_type |
String |
waf模式(分为云模式:cloud,独享模式:premium) |
状态码: 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和证书id为certificate_id的证书到两个域名,分别为域名id为“85e554189d494c0f97789e93531c9f90”的云模式域名和域名id为“4e9e97c425fc463c8f374b90124e8392”的独享模式域名。
POST https://{Endpoint}/v1/{project_id}/waf/certificate/{certificate_id}/apply-to-hosts?enterprise_project_id=0 { "cloud_host_ids" : [ "85e554189d494c0f97789e93531c9f90" ], "premium_host_ids" : [ "4e9e97c425fc463c8f374b90124e8392" ] }
响应示例
状态码: 200
OK
{ "id" : "3ac1402300374a63a05be68c641e92c8", "name" : "www.abc.com", "timestamp" : 1636343349139, "expire_time" : 1650794100000, "bind_host" : [ { "id" : "e350cf556da34adab1f017523d1c05ed", "hostname" : "www.demo.com", "waf_type" : "cloud" } ] }
SDK代码示例
SDK代码示例如下。
绑定项目id为project_id和证书id为certificate_id的证书到两个域名,分别为域名id为“85e554189d494c0f97789e93531c9f90”的云模式域名和域名id为“4e9e97c425fc463c8f374b90124e8392”的独享模式域名。
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 55 56 57 58 |
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.*; import java.util.List; import java.util.ArrayList; public class ApplyCertificateToHostSolution { 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(); ApplyCertificateToHostRequest request = new ApplyCertificateToHostRequest(); request.withCertificateId("{certificate_id}"); ApplyCertificateToHostRequestBody body = new ApplyCertificateToHostRequestBody(); List<String> listbodyPremiumHostIds = new ArrayList<>(); listbodyPremiumHostIds.add("4e9e97c425fc463c8f374b90124e8392"); List<String> listbodyCloudHostIds = new ArrayList<>(); listbodyCloudHostIds.add("85e554189d494c0f97789e93531c9f90"); body.withPremiumHostIds(listbodyPremiumHostIds); body.withCloudHostIds(listbodyCloudHostIds); request.withBody(body); try { ApplyCertificateToHostResponse response = client.applyCertificateToHost(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和证书id为certificate_id的证书到两个域名,分别为域名id为“85e554189d494c0f97789e93531c9f90”的云模式域名和域名id为“4e9e97c425fc463c8f374b90124e8392”的独享模式域名。
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 |
# 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 = ApplyCertificateToHostRequest() request.certificate_id = "{certificate_id}" listPremiumHostIdsbody = [ "4e9e97c425fc463c8f374b90124e8392" ] listCloudHostIdsbody = [ "85e554189d494c0f97789e93531c9f90" ] request.body = ApplyCertificateToHostRequestBody( premium_host_ids=listPremiumHostIdsbody, cloud_host_ids=listCloudHostIdsbody ) response = client.apply_certificate_to_host(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和证书id为certificate_id的证书到两个域名,分别为域名id为“85e554189d494c0f97789e93531c9f90”的云模式域名和域名id为“4e9e97c425fc463c8f374b90124e8392”的独享模式域名。
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 |
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.ApplyCertificateToHostRequest{} request.CertificateId = "{certificate_id}" var listPremiumHostIdsbody = []string{ "4e9e97c425fc463c8f374b90124e8392", } var listCloudHostIdsbody = []string{ "85e554189d494c0f97789e93531c9f90", } request.Body = &model.ApplyCertificateToHostRequestBody{ PremiumHostIds: &listPremiumHostIdsbody, CloudHostIds: &listCloudHostIdsbody, } response, err := client.ApplyCertificateToHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。