1. API Description
Domain name for API request: waf.intl.tencentcloudapi.com.
View protected object list
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.
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: DescribeObjects. |
| 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. |
| Filters.N |
No |
Array of FiltersItemNew |
Supported filters: ObjectId: CLB instance ID VIP: public IP address of the CLB instance InstanceId: WAF instance ID Domain: precise domain name Status: WAF protection switch status. 0: disabled; 1: enabled ClsStatus: WAF log switch. 0: disabled; 1: enabled |
3. Output Parameters
| Parameter Name |
Type |
Description |
| ClbObjects |
Array of ClbObject |
Object list |
| 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 Viewing the Object List
POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeObjects
<Common request parameters>
{
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
],
"ExactMatch": true
}
]
}
Output Example
{
"Response": {
"ClbObjects": [
{
"ApiStatus": 0,
"BotStatus": 0,
"ClsStatus": 0,
"InstanceId": "waf_2kuil2ft02vqm7z3",
"InstanceLevel": 3,
"InstanceName": "gz-Default1",
"IpHeaders": [
"spheader",
"myheader"
],
"NumericalVpcId": -1,
"ObjectFlowMode": 1,
"ObjectId": "lb-70mdt3it",
"ObjectName": "zunhua-multi-test_pjk1",
"PostCKafkaStatus": 0,
"PostCLSStatus": 0,
"PreciseDomains": [],
"PrivateIp": [
"121.123.11.7"
],
"Proxy": 3,
"PublicIp": [
"139.186.100.71"
],
"Region": "ap-chongqing",
"Status": 1,
"Type": "CLB",
"VirtualDomain": "lb-70mdt3it.clb-default.qcloudwaf.com",
"Vpc": "vpc-jl1cw1e9",
"VpcName": "Default-VPC"
}
],
"RequestId": "6ceb784e-b440-4cac-81ee-0b87ffe81e6f"
}
}
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
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.