AddLiveDomain

Last updated: 2020-05-09 14:27:02

1. API Description

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

This API is used to add a domain name. Only one domain name can be submitted at a time, and it must have an ICP filing.

A maximum of 100 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: AddLiveDomain.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
DomainName Yes String Domain name.
DomainType Yes Integer Domain name type.
0: push domain name.
1: playback domain name.
PlayType No Integer Pull domain name type:
1: Mainland China.
2: global.
3: outside Mainland China.
Default value: 1.
IsDelayLive No Integer Whether it is LCB:
0: LVB,
1: LCB.
Default value: 0.
IsMiniProgramLive No Integer Whether it is LVB on Mini Program.
0: LVB.
1: LVB on Mini Program.
Default value: 0.

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 Adding domain name

Input Example

https://live.tencentcloudapi.com/?Action=AddLiveDomain
&DomainName=www.test.com
&DomainType=0
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

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.

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
FailedOperation.DeleteDomainInLockedTime The domain name cannot be deleted because it incurred traffic in the last 2 days and is in locked state.
InternalError Internal error.
InternalError.ChineseCharacterDetected Chinese domain names are not supported currently. Please check the domain name format.
InternalError.ConnectDbError Database connection error.
InternalError.DBError DB execution error.
InternalError.DomainAlreadyExist The domain name is already connected elsewhere. Please check whether the entered domain name is correct, and if yes, you can add it again after successful ownership verification.
InternalError.DomainFormatError The domain name format is incorrect. Please enter a valid one.
InternalError.DomainGslbFail Failed to add the GSLB rule.
InternalError.DomainIsFamous The domain name is already connected elsewhere. Please check whether the entered domain name is correct, and if yes, you can add it again after successful ownership verification.
InternalError.DomainIsLimited Your domain name is unavailable. Please enter a correct domain name.
InternalError.DomainNoRecord The domain name has no ICP filing.
InternalError.DomainTooLong The domain name length exceeds the limit.
InternalError.InvalidInput Parameter check failed.
InternalError.InvalidUser Account information error.
InvalidParameter.DomainFormatError The domain name format is incorrect. Please enter a valid one.
InvalidParameter.DomainIsFamous A blacklisted domain name is used.
InvalidParameter.DomainIsLimited The domain name is restricted. Please submit a ticket for application to remove the restrictions.
InvalidParameter.MpHostDelete It is not allowed to add a Mini Program domain name deleted in the same month.
ResourceNotFound.DomainNoRecord The domain name has no ICP filing.
ResourceNotFound.InvalidUser This API is not supported for the user.
ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.