tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateSecurityDropPage

最后更新时间：2022-12-09 16:06:47
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to create a custom block page.

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: CreateSecurityDropPage.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ZoneId Yes String The site ID. You must specify either "ZoneId+Entity" or "TemplateId".
Entity Yes String The subdomain name/L4 proxy. You must specify either "ZoneId+Entity" or "TemplateId".
Name Yes String Name of the block page file.
Content Yes String The block page content, which is passed after being URL-encoded.
Type Yes String How to build the block page. Values:
  • file: Upload a file to be URL-encoded.
  • url: Upload a URL to be URL-encoded.
    		•
    Module Yes String The module that applies on the block page. Values:
  • waf: Managed rules
  • rate: Custom rules
    		•
    TemplateId No String The template ID. You must specify either this field or "ZoneId+Entity".

    3. Output Parameters

    Parameter Name Type Description
    PageId Integer ID of the custom page.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a block page using a URL

    In this example:
    The URL is URL-encoded to create a block page.

    Input Example

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

{
    "Content": "https%3A%2F%2Fcloud.tencent.com%2Fabout",
    "Entity": "www.example.com",
    "Name": "hello.html",
    "ZoneId": "zone-abcdefg",
    "Type": "url",
    "Module": "waf"
}

    Output Example

    {
    "Response": {
        "PageId": 1234546,
        "RequestId": "13j90e13-kf204fk0-wf0k0af"
    }
}

    Example2 Creating a block page using a file

    In this example:
    The file is URL-encoded to create a block page.

    Input Example

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

{
    "Content": "%3Chtml%3E%0Ahello%20world%2C%20uuid%3A%20%3A%3AEO_REQ_ID%0A%3C%2Fhtml%3E",
    "Entity": "www.example.com",
    "Name": "hello.html",
    "ZoneId": "zone-abcdefg",
    "Type": "file",
    "Module": "waf"
}

    Output Example

    {
    "Response": {
        "PageId": 1234546,
        "RequestId": "wwefoj-ewij23rkf-34t98jrg"
    }
}

    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.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款