tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDomain

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

1. API Description

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

This API (CreateDomain) is used to create the access domain name for the HTTP/HTTPS listener. Clients request the backend data by accessing this domain.
This API only supports connections of version 3.0.

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: CreateDomain.
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 to be created. Each listener supports up to 100 domain names.
CertificateId No String Server certificate, which is used for the HTTPS interaction between client and GAAP.
ClientCertificateId No String Client CA certificate, which is used for the HTTPS interaction between client and GAAP.
This field is required only when the mutual authentication method is adopted.
PolyClientCertificateIds.N No Array of String Client CA certificate, which is used for the HTTPS interaction between the client and GAAP.
This field or the ClientCertificateId field is required for mutual authentication only.
Http3Supported No Integer Specifies whether to enable HTTP3. Valid values:
0: disable HTTP3;
1: enable HTTP3.
HTTP3 is not enabled by default. You can enable it with this field SetDomainHttp3.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 CreateDomain

Input Example

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

{
    "Domain": "a.a.com",
    "CertificateId": "abc",
    "ListenerId": "0"
}

Output Example

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
    }
}

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.DomainAlreadyExisted The domain name is used by a listener.
FailedOperation.GroupStatusNotInRuning Unable to operate: the connection group is not running.
FailedOperation.InstanceStatusNotInRuning Unable to operate: the connection is not running.
FailedOperation.InvalidListenerProtocol Invalid listener protocol.
FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
FailedOperation.NonStandardProxy This connection is non-standard and write operations are not allowed.
FailedOperation.ProxyVersionNotSupport This version of connection is not supported.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.CertificateNotMatchDomain The HTTP certificate does not match the domain name.
InvalidParameterValue.DomainInIcpBlacklist The domain name is blocked for ICP issues.
InvalidParameterValue.DomainNotRegister The domain name does not have an ICP filing.
InvalidParameterValue.L7DomainHitBanBlacklist The domain name has been blocked and cannot be added.
ResourceNotFound The resource does not exist.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy