查询云模式防护域名列表
功能介绍
查询云模式防护域名列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/waf/instance
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
page |
否 |
Integer |
分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。 缺省值:1 |
pagesize |
否 |
Integer |
分页查询时,每页包含多少条结果。范围1-100,默认值为10,表示每页包含10条结果。如果需要一次查全部域名,该参数值填-1。 缺省值:10 |
hostname |
否 |
String |
要查询的防护域名,用于查询指定防护域名信息;可不传,查询用户云模式下所有防护域名 |
policyname |
否 |
String |
防护策略名,用于查询指定防护策略下的域名,可不传 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 缺省值:application/json;charset=utf8 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
云模式防护域名的数量 |
items |
Array of CloudWafHostItem objects |
详细的云模式防护域名列表信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名id |
hostid |
String |
域名id |
region |
String |
华为云区域ID,控制台创建的域名会携带此参数,api调用创建的域名此参数为空,可以通过华为云上地区和终端节点文档查询区域ID对应的中文名称 |
description |
String |
域名描述信息,可选参数。 |
type |
Integer |
WAF部署模式,默认是1,目前仅支持反代模式,冗余参数 |
proxy |
Boolean |
防护域名是否使用代理
|
hostname |
String |
创建的云模式防护域名 |
access_code |
String |
cname前缀,cname后缀为.vip1.huaweicloudwaf.com |
policyid |
String |
防护策略id |
timestamp |
Long |
创建防护域名的时间 |
protect_status |
Integer |
域名防护状态:
|
access_status |
Integer |
域名接入状态,0表示未接入,1表示已接入 |
exclusive_ip |
Boolean |
是否使用用户独享的引擎公网ip,该参数为预留参数,用于后续功能扩展,用户可忽略
|
paid_type |
String |
套餐付费模式,默认值为prePaid。prePaid:包周期款模式;postPaid:按需模式。 |
web_tag |
String |
网站名称,对应WAF控制台域名详情中的网站名称 |
flag |
Flag object |
特殊标识,用于前端使用 |
参数 |
参数类型 |
描述 |
---|---|---|
pci_3ds |
String |
是否开启pci_3ds合规认证
枚举值:
|
pci_dss |
String |
是否开启pci_dss合规认证
枚举值:
|
cname |
String |
old:代表域名使用的老的cname,new:代表域名使用新的cname 枚举值:
|
is_dual_az |
String |
是否支持双AZ模式
枚举值:
|
ipv6 |
String |
域名是否开启ipv6
枚举值:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
获取项目id为project_id的项目中的所有云模式防护域名
GET https://{Endpoint}/v1/{project_id}/waf/instance?enterprise_project_id=0
响应示例
状态码: 200
OK
{ "total" : 1, "items" : [ { "id" : "d0a4bc2f74e3407388a50243af700305", "hostid" : "d0a4bc2f74e3407388a50243af700305", "description" : "e", "type" : 1, "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" : "7d06456ffaexxxxxxxxxxx281bc13b", "policyid" : "bb2124fabe6f42ff9fe4770eeccb2670", "timestamp" : 1642648030687, "protect_status" : 1, "access_status" : 0, "exclusive_ip" : false, "web_tag" : "iii", "paid_type" : "prePaid" } ] }
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 49 50 |
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 ListHostSolution { 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 BasicCredentials() .withAk(ak) .withSk(sk); WafClient client = WafClient.newBuilder() .withCredential(auth) .withRegion(WafRegion.valueOf("<YOUR REGION>")) .build(); ListHostRequest request = new ListHostRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withPage(<page>); request.withPagesize(<pagesize>); request.withHostname("<hostname>"); request.withPolicyname("<policyname>"); try { ListHostResponse response = client.listHost(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 33 34 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = WafClient.new_builder() \ .with_credentials(credentials) \ .with_region(WafRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListHostRequest() request.enterprise_project_id = "<enterprise_project_id>" request.page = <page> request.pagesize = <pagesize> request.hostname = "<hostname>" request.policyname = "<policyname>" response = client.list_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 39 40 41 42 43 44 45 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := waf.NewWafClient( waf.WafClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListHostRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest pageRequest:= int32(<page>) request.Page = &pageRequest pagesizeRequest:= int32(<pagesize>) request.Pagesize = &pagesizeRequest hostnameRequest:= "<hostname>" request.Hostname = &hostnameRequest policynameRequest:= "<policyname>" request.Policyname = &policynameRequest response, err := client.ListHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。