有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口 (DescribeTemplateList) 用于获取信息模板列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTemplateList。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 偏移量,默认为0。
示例值:0
Limit Integer 返回数量,默认为20,最大值为100。
示例值:20
Type String 用户注册类型,默认:all , 个人:I ,企业: E
示例值:E
Status String 认证状态:未实名审核:NotUpload, 实名审核中:InAudit,已实名审核:Approved,实名审核失败:Reject,更新手机邮箱:NotVerified。
示例值:InAudit
Keyword String 关键字,用于域名所有者筛选
示例值:域名所有者

3. 输出参数

参数名称 类型 描述
TotalCount Integer 模板数量。
示例值:1
TemplateSet Array of TemplateInfo 模板详细信息列表。
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 信息模板列表

信息模板列表

输入示例

https://domain.tencentcloudapi.com/?Action=DescribeTemplateList
&Offset=0
&Limit=20
&Status=InAudit
&Type=E
&Keyword=abc
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "TemplateSet": [
            {
                "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。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.DescribeTemplateFailed 查询模板操作失败。
InternalError 内部错误。
InternalError.DomainInternalError 网络报错,请稍后重试。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。