tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeHosts

Last updated: 2024-09-25 10:13:26

1. API Description

Domain name for API request: waf.tencentcloudapi.com.

Obtain protection domain list in CLB-WAF

A maximum of 50 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeHosts.
Version Yes String Common Params. The value used for this API: 2018-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo.
Domain No String Protection domain. If a specific protection domain is to be queried, this parameter should be input. It requires an accurate domain and does not support fuzzy search.
DomainId No String Protection domain ID. If it is to query a specific protection domain, this parameter is input, requiring the accurate domain ID. This parameter does not support fuzzy search.
Search No String Searching criteria, fuzzy search on domain based on this parameter
Item No SearchItem Complex search criteria
InstanceID No String Instance ID

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Length of a protection domain list
HostList Array of HostRecord List of protection domains

Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining the List of Protected Domain Names

Input Example

https://waf.tencentcloudapi.com/?Action=DescribeHosts
&Domain=www.qcloudwaf.com
&DomainId=waf-u23yt9Hj
&Search=aaaa
&InstanceID=aaaa
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "HostList": [
            {
                "Domain": "abc",
                "DomainId": "abc",
                "MainDomain": "abc",
                "Mode": 1,
                "Status": 1,
                "State": 1,
                "Engine": 1,
                "IsCdn": 1,
                "LoadBalancerSet": [
                    {
                        "LoadBalancerId": "abc",
                        "LoadBalancerName": "abc",
                        "ListenerId": "abc",
                        "ListenerName": "abc",
                        "Vip": "abc",
                        "Vport": 1,
                        "Region": "abc",
                        "Protocol": "abc",
                        "Zone": "abc",
                        "NumericalVpcId": 0,
                        "LoadBalancerType": "abc",
                        "LoadBalancerDomain": "abc"
                    }
                ],
                "Region": "abc",
                "Edition": "abc",
                "FlowMode": 1,
                "ClsStatus": 1,
                "Level": 1,
                "CdcClusters": [
                    "abc"
                ],
                "AlbType": "abc",
                "IpHeaders": [
                    "abc"
                ],
                "EngineType": 0,
                "CloudType": "abc",
                "Note": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing
ResourceInUse Resources are occupied.
ResourceInsufficient Insufficient resources.
ResourceNotFound Resources do not exist.
ResourceUnavailable Resources are unavailable.
ResourcesSoldOut Resources are sold out.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy