1. 接口描述
接口请求域名: domain.tencentcloudapi.com 。
本接口 ( CreateTemplate ) 用于添加域名信息模板 。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ContactInfo | 是 | ContactInfo | 联系人信息 |
CertificateInfo | 否 | CertificateInfo | 证件信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Template | TemplateInfo | 模板信息 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建模板
创建模板
输入示例
POST / HTTP/1.1
Host:domain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTemplate
<公共请求参数>
{
"ContactInfo": {
"Province": "sheng",
"OrganizationNameCN": "xx企业",
"OrganizationName": "xx企业",
"City": "abc",
"CityCN": "abc",
"RegistrantName": "张三",
"Telephone": "13788888888",
"ZipCode": "qweqwe",
"RegistrantNameCN": "qweqwe",
"StreetCN": "asdqw",
"Street": "sdqw",
"ProvinceCN": "sdw",
"Country": "CN",
"RegistrantType": "E",
"CountryCN": "abc",
"Email": "23124@qq.com"
},
"CertificateInfo": {
"CertificateType": "SFZ",
"CertificateCode": "430234123",
"ImgUrl": "--"
}
}
输出示例
{
"Response": {
"Template": {
"TemplateId": "abc",
"AuditStatus": "abc",
"CreatedOn": "abc",
"UpdatedOn": "abc",
"UserUin": "abc",
"IsDefault": "abc",
"AuditReason": "abc",
"CertificateInfo": {
"CertificateCode": "abc",
"CertificateType": "abc",
"ImgUrl": "abc",
"OriginImgUrl": "abc",
"RegistrantCertificateCode": "abc",
"RegistrantCertificateType": "abc",
"RegistrantImgUrl": "abc"
},
"ContactInfo": {
"OrganizationNameCN": "abc",
"OrganizationName": "abc",
"RegistrantNameCN": "abc",
"RegistrantName": "abc",
"ProvinceCN": "abc",
"Province": "abc",
"CityCN": "abc",
"City": "abc",
"StreetCN": "abc",
"Street": "abc",
"CountryCN": "abc",
"Country": "abc",
"Telephone": "abc",
"Email": "abc",
"ZipCode": "abc",
"RegistrantType": "abc"
},
"IsValidTemplate": 0,
"InvalidReason": "abc",
"IsBlack": true
},
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CreateTemplateFailed | 创建模板操作失败。 |
FailedOperation.DescribeDomainListFailed | 获取域名信息操作失败,请稍后重试。 |
FailedOperation.DescribeTemplateFailed | 查询模板操作失败。 |
FailedOperation.ProhibitPhoneEmail | 禁止的手机或邮箱。 |
FailedOperation.TemplateMaxNumFailed | 信息模板超过可用数量上限,建议删除已有模板后重试。 |
InternalError | 内部错误。 |
InternalError.DomainInternalError | 网络报错,请稍后重试。 |
InvalidParameter | 参数错误。 |
InvalidParameter.CertificateCodeIsInvalid | 资质信息输入不正确。 |
InvalidParameter.CertificateImageIsInvalid | 资质照片输入不正确。 |
InvalidParameter.CityCnInvalid | 地区城市填写有误,长度错误长度必须地址长度必须大于2并小于100,或包含非中文字符,或存在空格 |
InvalidParameter.CountryCnInvalid | 地区国家填写有误,长度错误长度必须地址长度必须大于2并小于100,或包含非中文字符,或存在空格 |
InvalidParameter.EmailIsInvalid | 邮箱为空或者不正确。 |
InvalidParameter.EmailIsUnverified | 仅支持已验证的电子邮箱,请先在控制台创建后使用 |
InvalidParameter.NameCnIsInvalid | 联系人(中文)不能包含英文以及空格 |
InvalidParameter.NameCnXmlInvalid | 联系人(中文)不能包含XML保留字符 |
InvalidParameter.NameEnASCIIInvalid | 联系人(英文)不符合ASCII规范 |
InvalidParameter.NameEnCnIsInvalid | 联系人(英文)不能包含中文 |
InvalidParameter.NameEnIsInvalid | 联系人(英文)字符长度不能小于2位且不能大于64位 |
InvalidParameter.NameEnIsKeyword | 联系人(英文)填写有误,或因其他原因无法使用,请更换其他联系人。 |
InvalidParameter.NameEnXmlInvalid | 联系人(英文)不能包含XML保留字符 |
InvalidParameter.NameIsInvalid | 联系人为空或者不合法。 |
InvalidParameter.NameIsKeyword | 联系人填写有误,或因其他原因无法使用,请更换其他联系人。 |
InvalidParameter.OrgASCIIInvalid | 域名所有者(英文)不符合ASCII规范 |
InvalidParameter.OrgCnNotSpaceCN | 域名所有者(中文)不能包含空格与英文 |
InvalidParameter.OrgCnXmlInvalid | 域名所有者(中文)不能包含XML保留字符 |
InvalidParameter.OrgInCNInvalid | 域名所有者(英文)不能包含中文字符 |
InvalidParameter.OrgIsInvalid | 注册人为空或者不合法。 |
InvalidParameter.OrgIsKeyword | 域名所有者填写有误,或因其他原因无法使用,请更换其他域名所有者。 |
InvalidParameter.OrgXMLInvalid | 域名所有者(英文)不能包含XML保留字符 |
InvalidParameter.ProvinceCnInvalid | 地区省份填写有误,长度错误长度必须地址长度必须大于2并小于100,或包含非中文字符,或存在空格 |
InvalidParameter.RepTypeIsInvalid | 请求类型错误。 |
InvalidParameter.StreetIsInvalid | 地址有误,请传入正确的地址。 |
InvalidParameter.TelephoneIsInvalid | 电话为空或者不合法。 |
InvalidParameter.TelephoneIsUnverified | 仅支持已验证的手机号码,请先在控制台创建后使用。 |
InvalidParameter.UserTypeIsInvalid | 用户类型为空或者不合法。 |
InvalidParameter.ZipCodeIsInvalid | 邮编为空或者不合法。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.DomainIsEmpty | 域名不能为空。 |
MissingParameter.RepDataIsNone | 请求数据不能为空。 |
MissingParameter.TemplateIdIsEmpty | 模板ID为空或者不合法。 |
MissingParameter.TemplateIdIsExist | 模板已存在。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.TemplateNotFound | 模板信息有误,请输入正确的信息。 |
UnsupportedOperation.AccountRealName | 账户实名认证未通过。 |