有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

查询经验库

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTemplate。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
TemplateId Integer 经验库ID
示例值:1

3. 输出参数

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

4. 示例

示例1 查询经验

查询经验

输入示例

POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplate
<公共请求参数>

{
    "TemplateId": 1175
}

输出示例

{
    "Response": {
        "RequestId": "e5cf31b7-d530-4bce-8836-4c227b463b31",
        "Template": {
            "AlarmPolicy": [],
            "ApmServiceList": [],
            "Tags": [],
            "TemplateCreateTime": "2023-10-09 11:03:31",
            "TemplateDescription": "测试",
            "TemplateGroups": [
                {
                    "CreateTime": "2023-10-09 11:03:31",
                    "Description": "测试",
                    "Mode": 1,
                    "ObjectTypeId": 1,
                    "Order": 1,
                    "TemplateGroupActions": [
                        {
                            "ActionApiType": 1,
                            "ActionAttribute": 1,
                            "ActionId": 1,
                            "ActionTitle": "关机(测试)",
                            "ActionType": "平台",
                            "CreateTime": "2023-10-09 11:03:31",
                            "CustomConfiguration": "{}",
                            "ExecuteId": null,
                            "GeneralConfiguration": "{\"AliasTitle\": \"\", \"PreTimeWait\": 0, \"ActionTimeout\": 1800, \"AfterTimeWait\": 0}",
                            "Order": 1,
                            "RandomId": 368448,
                            "RecoverId": 232618,
                            "TemplateGroupActionId": 3982,
                            "UpdateTime": "2023-10-09 11:03:31"
                        },
                        {
                            "ActionApiType": 1,
                            "ActionAttribute": 2,
                            "ActionId": 2,
                            "ActionTitle": "开机",
                            "ActionType": "平台",
                            "CreateTime": "2023-10-09 11:03:31",
                            "CustomConfiguration": "{}",
                            "ExecuteId": 368448,
                            "GeneralConfiguration": "{\"PreTimeWait\": 0, \"ActionTimeout\": 1800, \"AfterTimeWait\": 0}",
                            "Order": 2,
                            "RandomId": 232618,
                            "RecoverId": null,
                            "TemplateGroupActionId": 3983,
                            "UpdateTime": "2023-10-09 11:03:31"
                        }
                    ],
                    "TemplateGroupId": 1659,
                    "Title": "测试",
                    "UpdateTime": "2023-10-09 11:03:31"
                }
            ],
            "TemplateId": 1175,
            "TemplateIsUsed": 1,
            "TemplateMode": 1,
            "TemplateMonitors": [
                {
                    "MetricChineseName": "CPU使用率",
                    "MetricId": 614,
                    "MetricName": "CpuUsage",
                    "MonitorId": 2173,
                    "ObjectTypeId": 1
                }
            ],
            "TemplateOwnerUin": "700000174829",
            "TemplatePauseDuration": 60,
            "TemplatePolicy": null,
            "TemplateRegionId": 1,
            "TemplateSource": 0,
            "TemplateTag": "",
            "TemplateTitle": "测试",
            "TemplateUpdateTime": "2023-10-09 11:03:31"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。