Domain name for API request: tse.intl.tencentcloudapi.com.
Query WAF protection status
A maximum of 20 requests can be initiated per second for this API.
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: DescribeWafProtection. |
| Version | Yes | String | Common Params. The value used for this API: 2020-12-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GatewayId | Yes | String | gateway ID |
| TypeList.N | No | Array of String | Resource type list for protection supports querying multiple types (Global, Service, Route, Object). If left empty, it defaults to querying the Global type. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | DescribeWafProtectionResult | Protection status |
| 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. |
Query WAF protection status
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWafProtection
<Common request parameters>
{
"GatewayId": "gateway-0f7c158e",
"Type": "Global"
}
{
"Response": {
"Result": {
"GlobalStatus": "Open"
},
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.FailedOperation | Operation failed. |
| FailedOperation.InternalError | Operation failed. Internal error. |
| FailedOperation.Role | Failed to get temporary key |
| FailedOperation.Vpc | Failed to call the VPC service |
| InternalError | Internal error. |
| InternalError.QueryError | Query internal error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameterValue.BadRequestFormat | Request format incorrect. |
| InvalidParameterValue.InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.OperationFailed | Invalid request parameter caused operation failure. |
| InvalidParameterValue.Region | Invalid Region. |
| InvalidParameterValue.ResourceAlreadyExist | The resource already exists. |
| InvalidParameterValue.Specification | Gateway specification parameter content error |
| InvalidParameterValue.Type | Gateway type parameter content error |
| MissingParameter | Parameters are missing. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceNotFound.ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation.CamNoAuth | Authentication fail. |
| UnauthorizedOperation.CamPassRoleNotExist | The sub-account lacks passRole permission. |
| UnauthorizedOperation.Uin | Unauthorized Uin |
| UnauthorizedOperation.UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback