CreateDomain
Last updated: 2019-12-05 17:22:42
Contents：
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.
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 parameter. The value used for this API: CreateDomain |
| Version | Yes | String | Common parameter. The value used for this API: 2018-05-29 |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| 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. |
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
https://gaap.tencentcloudapi.com/?Action=CreateDomain
&ListenerId=0
&Domain=a.a.com
&CertificateId=abc
&<Common request parameters>Output Example
{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| FailedOperation | Operation failed |
| FailedOperation.DomainAlreadyExisted | The domain name is used by a listener. |
| FailedOperation.InvalidListenerProtocol | Invalid listener protocol. |
| FailedOperation.LimitNumofDomains | Limit on the number of domain names exceeded. |
| FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
| FailedOperation.ProxyVersionNotSupport | This version of connection is not supported. |
| InternalError | Internal error |
| InvalidParameter | Parameter error |
| InvalidParameterValue | Parameter value error |
| ResourceNotFound | Resource does not exist |
