DescribeSecurityJSInjectionRule
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query JavaScript injection rules.
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: DescribeSecurityJSInjectionRule. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Zone ID. |
| Limit | No | Integer | Paginated query limit. default value: 20, maximum value: 100. |
| Offset | No | Integer | The offset of paginated query. Default value: 0. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Specifies the total rule count for JavaScript injection. |
| JSInjectionRules | Array of JSInjectionRule | JavaScript injection rule 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 Querying JavaScript Injection Rules
This example shows you how to query JavaScript injection rules on a site with paging.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityJSInjectionRule
<Common request parameters>
{
"ZoneId": "zone-123123232",
"Limit": 10,
"Offset": 0
}Output Example
{
"Response": {
"TotalCount": 1,
"JSInjectionRules": [
{
"RuleId": "injection-123219329",
"Name": "test",
"Condition": "${http.request.host} in ['www.test.com'] and ${http.request.uri.path} in ['/atteffa/geo-info']",
"InjectJS": "inject-sdk-only",
"Priority": 2
}
],
"RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.