# 根据Id查询防护域名 - ShowCompositeHost #### 功能介绍 根据Id查询防护域名 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-waf/waf_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-waf/waf_02_0119.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | waf:host:get | Read | host \* | g:EnterpriseProjectId | waf:instance:get | - | #### URI GET /v1/{project_id}/composite-waf/host/{host_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，对应华为云控制台用户名-\>我的凭证-\>项目列表-\>项目ID | | host_id | 是 | String | 域名id，通过查询云模式防护域名列表（ListHost）获取域名id或者通过查询独享模式域名列表（ListPremiumHost）获取域名id | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | 内容类型 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 域名id | | hostid | String | 域名id | | hostname | String | 创建的云模式防护域名 | | policyid | String | 策略id | | access_code | String | cname前缀，完整的cname域名由access_code和cname后缀组成 | | protect_status | Integer | **参数解释：** 域名防护状态标识，用于指定域名在WAF中的防护运行状态 **取值范围：** - -1：bypass，该域名的请求直接到达其后端服务器，不再经过WAF - 0：暂停防护，WAF只转发该域名的请求，不做攻击检测 - 1：开启防护，WAF根据您配置的策略进行攻击检测 | | access_status | Integer | **参数解释：** 域名接入状态 **取值范围：** - 0: 未接入 - 1: 已接入 | | proxy | Boolean | 防护域名是否使用代理 - false：不使用代理 - true：使用代理 | | timestamp | Long | 创建防护域名的时间 | | paid_type | String | **参数解释：** 套餐付费模式标识，用于指定套餐的计费方式 **取值范围：** - 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 - true：使用独享ip - false：不使用独享ip | | region | String | 华为云区域ID，控制台创建的域名会携带此参数，api调用创建的域名此参数为空，可以通过华为云上地区和终端节点文档查询区域ID对应的中文名称 | | server | Array of [WafServer] objects | 防护域名的源站服务器配置信息，只有独享模式域名才返回vpc_id | | enterprise_project_id | String | 企业项目id | 表5Flag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pci_3ds | String | 是否开启pci_3ds合规认证 - true：开启 - false：不开启 | | pci_dss | String | 是否开启pci_dss合规认证 - true：开启 - false：不开启 | | cname | String | old：代表域名使用的老的cname，new：代表域名使用新的cname | | is_dual_az | String | 域名是否开启ipv6 - true：开启 - false：不开启 | | ipv6 | String | 域名是否开启ipv6 - true：开启 - false：不开启 | 表6Access_progress | 参数 | 参数类型 | 描述 | |:---|:---|:---| | step | Integer | 步骤 - 1: 指回源IP加白 - 2: 指本地验证 - 3：指修改DNS解析 | | status | Integer | **参数解释：** 步骤完成状态标识，用于指示对应步骤的完成情况 **取值范围：** - 0：未完成这个步骤 - 1：已完成这个步骤 | 表7Premium_waf_instances | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 引擎实例id | | name | String | 引擎实例名 | | accessed | Boolean | 引擎实例是否已接入，false：未接入；true：已接入 | 表8WafServer | 参数 | 参数类型 | 描述 | |:---|:---|:---| | front_protocol | String | **参数解释：** 客户端请求访问防护域名源站服务器的协议 **取值范围：** - HTTP: HTTP协议 - HTTPS: HTTPS协议 | | back_protocol | String | **参数解释：** WAF转发客户端请求到防护域名源站服务器的协议 **取值范围：** - HTTP: HTTP协议 - HTTPS: HTTPS协议 | | weight | Integer | 源站权重，负载均衡算法将按该权重将请求分配给源站，默认值是1，云模式的冗余字段 | | address | String | 客户端访问的源站服务器的IP地址 | | port | Integer | WAF转发客户端请求到源站服务的业务端口 | | type | String | **参数解释：** 源站地址类型，为ipv4或ipv6 **取值范围：** - ipv4 - ipv6 | | vpc_id | String | VPC id,通过以下步骤获取VPC id： - 1.找到独享引擎所在的虚拟私有云名称，VPC\\子网这一列就是VPC的名称：登录WAF的控制台-\>单击系统管理-\>独享引擎-\>VPC\\子网 - 2.登录虚拟私有云 VPC控制台-\>虚拟私有云-\>单击虚拟私有云的名称-\>基本信息的ID | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表10IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表12IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 下游服务错误码 | | error_msg | String | 下游服务报错信息 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 | | details | Array of [IAM5ErrorDetails] objects | 调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。 | 表14IAM5ErrorDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** ``` { "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代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := waf.WafClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := waf.NewWafClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/WAF/sdk?api=ShowCompositeHost)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 请求失败 | | 401 | token权限不足 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-waf/ErrorCode.html)。