根据Id查询防护域名
功能介绍
根据Id查询防护域名
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/composite-waf/host/{host_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
host_id |
是 |
String |
域名id,通过查询云模式防护域名列表(ListHost)获取域名id或者通过独享模式域名列表(ListPremiumHost)获取域名id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名id |
hostid |
String |
域名id |
hostname |
String |
创建的云模式防护域名 |
policyid |
String |
策略id |
access_code |
String |
cname前缀 |
protect_status |
Integer |
域名防护状态:
|
access_status |
Integer |
域名接入状态,0表示未接入,1表示已接入 |
proxy |
Boolean |
防护域名是否使用代理
|
timestamp |
Long |
创建防护域名的时间 |
paid_type |
String |
套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。 |
flag |
Flag object |
特殊标识,用于前端使用 |
waf_type |
String |
域名所属WAF模式,cloud为云模式,premium为独享模式 |
web_tag |
String |
网站名称,对应WAF控制台域名详情中的网站名称 |
access_progress |
Array of Access_progress objects |
接入进度,仅用于新版console(前端)使用 |
premium_waf_instances |
Array of Premium_waf_instances objects |
租户引擎实例信息列表 |
description |
String |
域名描述 |
exclusive_ip |
Boolean |
是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略
|
region |
String |
区域ID,控制台创建的域名会携带此参数,api调用创建的域名此参数为空,可以通过地区和终端节点文档查询区域ID对应的中文名称 |
server |
Array of WafServer objects |
防护域名的源站服务器配置信息,只有独享模式域名才返回vpc_id |
参数 |
参数类型 |
描述 |
---|---|---|
pci_3ds |
String |
是否开启pci_3ds合规认证
|
pci_dss |
String |
是否开启pci_dss合规认证
|
cname |
String |
old:代表域名使用的老的cname,new:代表域名使用新的cname |
is_dual_az |
String |
是否支持双AZ模式
|
ipv6 |
String |
域名是否开启ipv6
|
参数 |
参数类型 |
描述 |
---|---|---|
step |
Integer |
步骤
|
status |
Integer |
状态,0:未完成这个步骤;1:已完成这个状态” |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
引擎实例id |
name |
String |
引擎实例名 |
accessed |
Boolean |
引擎实例是否已接入,false:未接入;true:已接入 |
参数 |
参数类型 |
描述 |
---|---|---|
front_protocol |
String |
客户端请求访问防护域名源站服务器的协议 |
back_protocol |
String |
WAF转发客户端请求到防护域名源站服务器的协议 |
weight |
Integer |
源站权重,负载均衡算法将按该权重将请求分配给源站,默认值是1,云模式的冗余字段 |
address |
String |
客户端访问的源站服务器的IP地址 |
port |
Integer |
WAF转发客户端请求到源站服务的业务端口 |
type |
String |
源站地址为ipv4或ipv6 |
vpc_id |
String |
VPC id,通过以下步骤获取VPC id:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询项目id为project_id,域名id为host_id的域名信息。
GET https://{Endpoint}/v1/{project_id}/composite-waf/host/{host_id}?enterprise_project_id=0
响应示例
状态码: 200
OK
{ "id" : "31af669f567246c289771694f2112289", "hostid" : "31af669f567246c289771694f2112289", "description" : "", "proxy" : false, "flag" : { "pci_3ds" : "false", "pci_dss" : "false", "ipv6" : "false", "cname" : "new", "is_dual_az" : "true" }, "region" : "cn-north-4", "hostname" : "www.demo.com", "access_code" : "1b18879b9d064f8bbcbf8abce7294cac", "policyid" : "41cba8aee2e94bcdbf57460874205494", "timestamp" : 1650527546454, "protect_status" : 0, "access_status" : 0, "exclusive_ip" : false, "web_tag" : "", "paid_type" : "prePaid", "waf_type" : "cloud", "server" : [ { "address" : "1.2.3.4", "port" : 443, "type" : "ipv4", "weight" : 1, "front_protocol" : "HTTPS", "back_protocol" : "HTTPS", "vpc_id" : "ebfc553a-386d-4746-b0c2-18ff3f0e903d" } ] }
SDK代码示例
SDK代码示例如下。
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 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 ShowCompositeHostSolution { 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(); ShowCompositeHostRequest request = new ShowCompositeHostRequest(); request.withHostId("{host_id}"); try { ShowCompositeHostResponse response = client.showCompositeHost(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()); } } } |
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 |
# 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 = ShowCompositeHostRequest() request.host_id = "{host_id}" response = client.show_composite_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) |
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 |
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.ShowCompositeHostRequest{} request.HostId = "{host_id}" response, err := client.ShowCompositeHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。