tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateCustomizeErrorPage

Last updated: 2024-10-11 15:52:38

1. API Description

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

This API is used to create a custom response 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: CreateCustomizeErrorPage.
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.
Name Yes String Custom error page name. The name must be 2-30 characters long.
ContentType Yes String Custom error page type, with values:
  • text/html;
  • application/json;
  • text/plain;
  • text/xml.
    		•
    Description No String Custom error page description, not exceeding 60 characters.
    Content No String Custom error page content, not exceeding 2 KB.

    3. Output Parameters

    Parameter Name Type Description
    PageId String Page ID.
    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 Creating a custom response page

    This example shows you how to create a custom response page.

    Input Example

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

{
    "ZoneId": "zone-2kplomhisdcb",
    "Name": "Web Protection Custom Response Page",
    "Description": "web protection custom response page",
    "ContentType": "application/json",
    "Content": "{\"title\":\"Custom Response Page\", \"Content\":\"custom response page content\"}"
}

    Output Example

    {
    "Response": {
        "PageId": "p-2kplomhisdcb",
        "RequestId": "9bd9c732-8f9a-4cd3-a3e8-1c9db5e53631"
    }
}

    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
    InvalidParameterValue.ContentTypeNotMatch The page content does not match the Content-Type.
    InvalidParameterValue.PageNameAlreadyExist The page name already exists.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy