tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDomainErrorPageInfo

Last updated: 2023-07-13 15:25:28

1. API Description

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

This API is used to customize the error code of an error response to the specified domain name.

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: CreateDomainErrorPageInfo.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
ListenerId Yes String Listener ID
Domain Yes String Domain name
ErrorNos.N Yes Array of Integer Original error code
Body Yes String New response packet
NewErrorNo No Integer New error code
ClearHeaders.N No Array of String Response header to be deleted
SetHeaders.N No Array of HttpHeaderParam Response header to be set

3. Output Parameters

Parameter Name Type Description
ErrorPageId String Configuration ID of a custom error response
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 CreateDomainErrorPageInfo

Input Example

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

{
    "Body": "helloword",
    "Domain": "a.com",
    "ListenerId": "0",
    "ErrorNos": [
        "502",
        "501"
    ],
    "NewErrorNo": "400"
}

Output Example

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8",
        "ErrorPageId": "errorPage-1fewf"
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.InvalidListenerProtocol Invalid listener protocol.
FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
FailedOperation.ProxyStatusNotInRuning Unable to add listeners: the connection is not running.
FailedOperation.ProxyVersionNotSupport This version of connection is not supported.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy