获取模板信息

最近更新时间:2024-03-12 01:26:54

我的收藏

1. 接口描述

接口请求域名: domain.tencentcloudapi.com 。

本接口 (DescribeTemplate) 用于获取模板信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTemplate。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,本接口不需要传递此参数。
TemplateId String 模板ID

3. 输出参数

参数名称 类型 描述
Template TemplateInfo 模板信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取模板信息

输入示例

https://domain.tencentcloudapi.com/?Action=DescribeTemplate
&TemplateId=模板ID
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "0c209d0e-f244-435f-8222-d86741c3edbd",
        "Template": {
            "AuditReason": "",
            "ContactInfo": {
                "Province": "hu nan sheng",
                "RegistrantType": "I",
                "OrganizationName": "ce shi",
                "OrganizationNameCN": "测试",
                "Country": "CN",
                "RegistrantName": "ce shi",
                "ZipCode": "425000",
                "Telephone": "155*********",
                "City": "ce shi",
                "RegistrantNameCN": "测试",
                "StreetCN": "咸嘉湖街道",
                "Street": "xian jia hu jie dao",
                "ProvinceCN": "湖南省",
                "CityCN": "长沙市",
                "CountryCN": "中国",
                "Email": "dnspod@dnspod.com"
            },
            "UpdatedOn": "2020-07-28 13:33:55",
            "AuditStatus": "InAudit",
            "CreatedOn": "2020-07-28 12:50:23",
            "UserUin": "12334********",
            "IsDefault": "no",
            "TemplateId": "tmpl-dgmgwpe2",
            "InvalidReason": "",
            "IsValidTemplate": 1,
            "CertificateInfo": {
                "CertificateType": "SFZ",
                "CertificateCode": "12345679",
                "ImgUrl": "https://tencentyun.com/******"
            }
        }
    },
    "ResultStatus": true
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.DescribeTemplateFailed 查询模板操作失败。
InternalError 内部错误。
InternalError.DomainInternalError 网络报错,请稍后重试。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
MissingParameter.TemplateIdIsEmpty 模板ID为空或者不合法。
ResourceNotFound 资源不存在。
ResourceNotFound.TemplateNotFound 模板信息有误,请输入正确的信息。