Querying the List of Domain Names Protected in Cloud Mode
Function
This API is used to query the list of domain names protected in cloud mode.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/waf/instance
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list. Constraints N/A Range Enter 32 characters. Only letters and digits are allowed. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To obtain the resource details in all enterprise projects of a user, set this parameter to all_granted_eps. Constraints N/A Range
Default Value 0 |
page |
No |
Integer |
Definition Start position of the pagination query. This parameter specifies from which record you want to retrieve (counting starts from 1). Constraints N/A Range N/A Default Value 1 |
pagesize |
No |
Integer |
Definition Number of results on each page in a pagination query. Constraints N/A Range The value range is 1 to 100. The default value is 10, indicating that each page contains 10 results. To query all domain names at a time, set this parameter to -1. Default Value 10 |
hostname |
No |
String |
Definition Domain name to be queried. If this parameter is not specified, all protected domain names in cloud mode are queried by default. Constraints N/A Range Enter a maximum of 63 characters. Only letters, digits, hyphens (-), and periods (.) are allowed, for example, www.domain com. Default Value N/A |
policyname |
No |
String |
Definition Protection policy name, which is used to query the domain names using a specified protection policy. This parameter is optional. Constraints N/A Range Enter a maximum of 64 characters.Only letters, digits, underscores (_), hyphens (-), colons (:), and periods (.) are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Number of domain names protected with cloud WAF |
items |
Array of CloudWafHostItem objects |
Array of details about the protected domain names protected with cloud WAF. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Domain name ID. Range N/A |
hostid |
String |
Definition Domain name ID. Range N/A |
region |
String |
Definition Region ID. This parameter is carried when a domain name is added to WAF on the management console. This parameter is left blank when a domain name is added to WAF using an API. Range N/A |
description |
String |
Definition Domain name description. This parameter is optional. Range N/A |
server |
Array of CloudWafServer objects |
Origin server configuration of the protected domain name |
type |
Integer |
Definition WAF deployment mode. The default value is 1. Currently, only the reverse proxy is supported. Range N/A |
proxy |
Boolean |
Definition Whether the protected domain name uses a proxy.
Range
|
hostname |
String |
Definition Domain name added to cloud WAF. Range N/A |
access_code |
String |
Definition CNAME prefix. The CNAME suffix is .vip1.huaweicloudwaf.com. Range N/A |
policyid |
String |
Definition Protection policy ID. Range N/A |
timestamp |
Long |
Definition Time a domain name is added to WAF. Range 13-bit millisecond timestamp. |
protect_status |
Integer |
Definition Domain protection status. Range
|
access_status |
Integer |
Definition Domain name access status. Range
|
exclusive_ip |
Boolean |
Definition Whether to use the dedicated public IP address. This parameter is reserved for future function expansion and can be ignored. Range
|
paid_type |
String |
Definition Package payment mode. The default value is prePaid. Range
|
web_tag |
String |
Definition Website name, which is the website name displayed on the domain name details page on the WAF console. Range N/A |
flag |
Flag object |
Special identifier, which is used on the console. |
enterprise_project_id |
String |
Definition Enterprise project ID. Range N/A |
Parameter |
Type |
Description |
---|---|---|
front_protocol |
String |
Definition Protocol used by the client to access the origin server of the protected domain name. Constraints N/A Range
Default Value N/A |
back_protocol |
String |
Definition Protocol used by WAF to forward client requests to the origin server of the protected domain name. Constraints N/A Range
Default Value N/A |
weight |
Integer |
Definition Weight: Requests are distributed across backend origin servers based on the load balancing algorithm you select and the weight you assign to each server. Constraints N/A Range The default value is 1, which is a redundant field in cloud mode. Default Value N/A |
address |
String |
Definition IP address of origin server accessed by the client. Constraints N/A Range N/A Default Value N/A |
port |
Integer |
Definition Port used by WAF to forward client requests to the origin server. Constraints N/A Range N/A Default Value N/A |
type |
String |
Definition Type of the origin server address: IPv4 or IPv6 Constraints N/A Range
Default Value N/A |
Parameter |
Type |
Description |
---|---|---|
pci_3ds |
String |
Definition Whether to enable PCI 3DS compliance authentication. Constraints N/A Range
Default Value N/A |
pci_dss |
String |
Definition Whether to enable PCI_DSS compliance authentication. Constraints N/A Range
Default Value N/A |
cname |
String |
Definition old: The old CNAME record is used. new: new CNAME record is used. Constraints N/A Range
Default Value N/A |
is_dual_az |
String |
Definition Whether the dual-AZ mode is supported Constraints N/A Range
Default Value N/A |
ipv6 |
String |
Definition Whether IPv6 is enabled for the domain name. Constraints N/A Range
Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
The following example shows how to obtain all domain names protected with cloud WAF in a specific project. The project ID is specified by project_id.
GET https://{Endpoint}/v1/{project_id}/waf/instance?enterprise_project_id=0
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
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 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"); 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(); ListHostRequest request = new ListHostRequest(); 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 |
# 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 = ListHostRequest() 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 |
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.ListHostRequest{} response, err := client.ListHost(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot