文档首页/ Web应用防火墙 WAF/ API参考/ API/ 独享模式防护网站管理/ 查看独享模式域名配置
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查看独享模式域名配置

功能介绍

查看独享模式域名配置

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/premium-waf/host/{host_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

host_id

是

String

参数解释：

独享模式域名ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。

约束限制：

不涉及

取值范围：

  • 0：代表default企业项目

  • all_granted_eps：代表所有企业项目

  • 其它企业项目ID：长度为36个字符

默认取值：

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

域名id

取值范围：

不涉及

hostname

String

参数解释：

创建的独享模式域名

取值范围：

不涉及

protocol

String

参数解释：

对外协议，客户端（例如浏览器）请求访问网站的协议类型

取值范围：

  • HTTPS

  • HTTP

  • HTTP&HTTPS

server

Array of PremiumWafServer objects

防护域名的源站服务器配置信息

proxy

Boolean

参数解释：

是否使用代理

取值范围：

  • true：代表使用代理

  • false：代表未使用代理

locked

Integer

预留参数，用于后期设计冻结域名，解锁域名功能，目前暂不支持

timestamp

Long

创建防护域名的时间

tls

String

配置的最低TLS版本（TLS v1.0/TLS v1.1/TLS v1.2）,默认为TLS v1.0版本，对外协议为https时才有tls参数

cipher

String

对外协议为https时才有cipher参数，加密套件（cipher_1，cipher_2，cipher_3，cipher_4，cipher_5，cipher_6，cipher_default）：

  • cipher_1： 加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2：加密算法为EECDH+AESGCM:EDH+AESGCM

  • cipher_3：加密算法为ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4：加密算法为ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_5：加密算法为AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH

  • cipher_6：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256

  • cipher_default: 加密算法为ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM

extend

Map<String,String>

扩展字段，用于保存防护域名的一些配置信息。

flag

Flag object

特殊标识，用于前端使用

mode

String

云模式elb接入域名返回此字段：elb-shared

loadbalancer_id

String

云模式elb接入域名返回此字段，表示负载均衡器（ELB）id

listener_id

String

云模式elb接入域名返回此字段，表示监听器id

protocol_port

Integer

云模式elb接入域名返回此字段， 表示业务端口

description

String

域名描述

policyid

String

防护域名初始绑定的策略ID,可以通过策略名称调用查询防护策略列表（ListPolicy）接口查询到对应的策略id

domainid

String

账号ID,对应控制台用户名->我的凭证->账号ID

projectid

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

enterprise_project_id

String

企业项目ID，对应控制台用户名->企业->项目管理->点击项目名称->ID

certificateid

String

https证书id

certificatename

String

证书名称

protect_status

Integer

域名防护状态：

  • 0：暂停防护，WAF只转发该域名的请求，不做攻击检测

  • 1：开启防护，WAF根据您配置的策略进行攻击检测

access_status

Integer

域名接入状态，0表示未接入，1表示已接入

web_tag

String

网站名称，对应WAF控制台域名详情中的网站名称

block_page

BlockPage object

告警页面配置

traffic_mark

TrafficMark object

流量标识

timeout_config

TimeoutConfig object

超时配置

forward_header_map

Map<String,String>

字段转发配置，WAF会将添加的字段插到header中，转给源站；Key不能跟nginx原生字段重复。Value支持的值包括:

  • $time_local

  • $request_id

  • $connection_requests

  • $tenant_id

  • $project_id

  • $remote_addr

  • $remote_port

  • $scheme

  • $request_method

  • $http_host

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

-$origin_uri

access_progress

Array of Access_progress objects

接入进度，仅用于新版console(前端)使用
表5 PremiumWafServer

参数

参数类型

描述

front_protocol

String

参数解释：

客户端请求访问防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • HTTPS

默认取值：

不涉及

back_protocol

String

参数解释：

WAF转发客户端请求到防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • 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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表6 Flag

参数

参数类型

描述

pci_3ds

String

参数解释：

是否开启pci_3ds合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

pci_dss

String

参数解释：

是否开启pci_dss合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

cname

String

参数解释：

old：代表域名使用的老的cname，new：代表域名使用新的cname

约束限制：

不涉及

取值范围：

  • old：域名使用的老的cname

  • new：域名使用新的cname

默认取值：

不涉及

is_dual_az

String

参数解释：

是否支持双AZ模式

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及

ipv6

String

参数解释：

域名是否开启ipv6

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及
表7 BlockPage

参数

参数类型

描述

template

String

参数解释：

模板名称，默认页面请输入default，自定义告警页面时请输入custom，重定向请输入redirect

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_page

CustomPage object

自定义告警页面

redirect_url

String

参数解释：

“重定向”页面URL

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表8 CustomPage

参数

参数类型

描述

status_code

String

参数解释：

返回状态码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content_type

String

参数解释：

“自定义”告警页面内容类型，可选择text/html、text/xml和application/json三种类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content

String

参数解释：

根据选择的“页面类型”配置对应的页面内容，具体示例可以参考“Web应用防火墙 WAF”用户手册

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表9 TrafficMark

参数

参数类型

描述

sip

Array of strings

参数解释：

IP标记，客户端最原始的IP地址的HTTP请求头字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cookie

String

参数解释：

Session标记，用于Cookie恶意请求的攻击惩罚功能。在选择Cookie拦截的攻击惩罚功能前，必须配置该标识

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

params

String

参数解释：

User标记，用于Params恶意请求的攻击惩罚功能。在选择Params拦截的攻击惩罚功能前，必须配置该标识。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表10 TimeoutConfig

参数

参数类型

描述

connect_timeout

Integer

参数解释：

WAF连接源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

send_timeout

Integer

参数解释：

WAF发送请求到源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

read_timeout

Integer

参数解释：

WAF接收源站响应超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表11 Access_progress

参数

参数类型

描述

step

Integer

参数解释：

步骤

取值范围：

  • 1: 指回源IP加白

  • 2: 指本地验证

  • 3：指修改DNS解析

status

Integer

参数解释：

状态

取值范围：

  • 0：未完成这个步骤

  • 1：已完成这个状态

状态码：400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：401

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表15 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：500

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表17 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查看项目id为project_id，独享模式域名id为host_id的独享域名配置。

GET https://{Endpoint}/v1/{project_id}/premium-waf/host/{host_id}?enterprise_project_id=0

响应示例

状态码：200

OK

{
  "id" : "ee896796e1a84f3f85865ae0853d8974",
  "hostname" : "www.demo.com",
  "protocol" : "HTTPS",
  "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"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650593801380,
  "tls" : "TLS v1.0",
  "cipher" : "cipher_1",
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false"
  },
  "description" : "",
  "policyid" : "df15d0eb84194950a8fdc615b6c012dc",
  "domainid" : "0ee78615ca08419f81f539d97c9ee353",
  "projectid" : "550500b49078408682d0d4f7d923f3e1",
  "protect_status" : 1,
  "access_status" : 0,
  "certificateid" : "360f992501a64de0a65c50a64d1ca7b3",
  "certificatename" : "certificatename75315"
}

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 ShowPremiumHostSolution {

    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();
        ShowPremiumHostRequest request = new ShowPremiumHostRequest();
        request.withHostId("{host_id}");
        try {
            ShowPremiumHostResponse response = client.showPremiumHost(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 = ShowPremiumHostRequest()
        request.host_id = "{host_id}"
        response = client.show_premium_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.ShowPremiumHostRequest{}
	request.HostId = "{host_id}"
	response, err := client.ShowPremiumHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

非法请求

401

Token无权限

500

服务器内部错误

错误码

请参见错误码。

父主题： 独享模式防护网站管理

相关文档