查询独享模式域名列表
功能介绍
查询独享模式域名列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/premium-waf/host
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围:
默认取值: 0 |
page |
否 |
String |
参数解释: 分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
pagesize |
否 |
String |
参数解释: 分页查询时,每页包含多少条结果 约束限制: 不涉及 取值范围: 范围1-100,默认值为10,表示每页包含10条结果。如果需要一次查全部域名,该参数值填-1。 默认取值: 10 |
hostname |
否 |
String |
参数解释: 域名 约束限制: 不涉及 取值范围: 域名只能由字母、数字、-和.组成,单段不能超过63个字符长度,如:www.domain.com。 默认取值: 不涉及 |
policyname |
否 |
String |
参数解释: 防护策略名,用于查询指定防护策略下的域名,可不传 约束限制: 不涉及 取值范围: 策略名称只能由中文、字母、数字、下划线、连字符、冒号和英文句号组成,且不能超过64个字符长度。 默认取值: 不涉及 |
protect_status |
否 |
Integer |
参数解释: 域名防护状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
全部防护域名的数量 |
items |
Array of SimplePremiumWafHost objects |
详细的防护域名信息数组 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 域名id 取值范围: 不涉及 |
hostname |
String |
参数解释: 域名 取值范围: 不涉及 |
extend |
Map<String,String> |
参数解释: 扩展字段,用于保存防护域名的一些配置信息 取值范围: 不涉及 |
region |
String |
参数解释: 区域ID,控制台创建的域名会携带此参数,api调用创建的域名此参数为空,可以通过地区和终端节点文档查询区域ID对应的中文名称 取值范围: 不涉及 |
flag |
Flag object |
特殊标识,用于前端使用 |
description |
String |
参数解释: 域名描述 取值范围: 不涉及 |
policyid |
String |
参数解释: 防护域名初始绑定的防护策略ID,可以通过策略名称调用查询防护策略列表(ListPolicy)接口查询到对应的策略id 取值范围: 不涉及 |
protect_status |
Integer |
参数解释: 域名防护状态 取值范围:
|
access_status |
Integer |
参数解释: 域名接入状态 取值范围:
|
web_tag |
String |
参数解释: 网站名称,对应WAF控制台域名详情中的网站名称 取值范围: 不涉及 |
hostid |
String |
参数解释: 域名id,和id的值是一样的,属于冗余字段 取值范围: 不涉及 |
enterprise_project_id |
String |
参数解释: 企业项目id 取值范围: 不涉及 |
pool_ids |
Array of strings |
参数解释: 云模式elb接入域名返回此字段,表示域名所属独享引擎组 取值范围: 不涉及 |
loadbalancer_id |
String |
参数解释: 云模式elb接入域名返回此字段,表示负载均衡器(ELB)id 取值范围: 不涉及 |
protocol_port |
Integer |
参数解释: 云模式elb接入域名返回此字段,表示业务端口 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
错误信息 |
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的独享模式域名列表
GET https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0
响应示例
状态码:200
OK
{ "total" : 1, "items" : [ { "id" : "ee896796e1a84f3f85865ae0853d8974", "hostname" : "www.demo.com", "extend" : { }, "region" : "cn-north-4", "flag" : { "pci_3ds" : "false", "pci_dss" : "false" }, "description" : "", "policyid" : "df15d0eb84194950a8fdc615b6c012dc", "protect_status" : 1, "access_status" : 0, "hostid" : "ee896796e1a84f3f85865ae0853d8974" } ] }
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 |
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 ListPremiumHostSolution { 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(); ListPremiumHostRequest request = new ListPremiumHostRequest(); try { ListPremiumHostResponse response = client.listPremiumHost(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 |
# 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 = ListPremiumHostRequest() response = client.list_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 |
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.ListPremiumHostRequest{} response, err := client.ListPremiumHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
非法请求 |
401 |
Token无权限 |
500 |
服务器内部错误 |
错误码
请参见错误码。