tencent cloud

Web Application Firewall

Release Notes and Announcements
Release Notes
Product Announcement
Security Advisory
Product Introduction
Overview
Product Category
Strengths
Scenarios
Plans and Editions
Supported Regions
Basic Concepts
Getting Started
Getting Started
FAQs for Beginners
Operation Guide
Overview
Connection Management
Security Operations
Protection Policies
Service Settings
사례 튜토리얼
WAF CCP Overview
Bot Management
API Security
Integration
Protection Configuration
FAQS
Product Consultation
Connection
Usage
Permissions
Sandbox Isolation Status
WAF 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
문서Web Application Firewall

DescribeHost

포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-30 22:08:48

1. API Description

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

Obtain protection domain details in CLB-WAF

A maximum of 20 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: DescribeHost.
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.
Domain Yes String Domain name
DomainId Yes String Domain ID
InstanceID No String Instance ID

3. Output Parameters

Parameter Name Type Description
Host HostRecord Domain name details
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 Protected Domain Name Details

Input Example

POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHost
<Common request parameters>



{
    "InstanceID": "",
    "Domain": "",
    "DomainId": ""
}

Output Example

{
    "Response": {
        "Host": {
            "AlbType": "clb",
            "CdcClusters": [
                "cluster-o41khj88"
            ],
            "CloudType": "public",
            "ClsStatus": 1,
            "Domain": "txcloudwaf.qcloudwaf.com",
            "DomainId": "waf-DhOzNw3D",
            "Edition": "clb-waf",
            "Engine": 1,
            "EngineType": 0,
            "FlowMode": 1,
            "IpHeaders": [
                "x-myreal-ip"
            ],
            "IsCdn": 1,
            "Level": 1,
            "LoadBalancerSet": [
                {
                    "ListenerId": "lbl-daskhe2",
                    "ListenerName": "80httpport",
                    "LoadBalancerId": "lb-daiu3grtd",
                    "LoadBalancerName": "txlb",
                    "LoadBalancerType": "open",
                    "NumericalVpcId": 3243,
                    "Protocol": "http",
                    "Region": "gz",
                    "Vip": "35.68.12.3",
                    "Vport": 1,
                    "Zone": "ap-guangzhou"
                }
            ],
            "MainDomain": "qcloudwaf.com",
            "Mode": 1,
            "Note": "Remarks",
            "Region": "gz",
            "State": 1,
            "Status": 1
        },
        "RequestId": "0ed6569e-f9b5-418d-8338-63eda4f2c0f7"
    }
}

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.
다음 주제: Release Notes

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백