1. 接口描述
接口请求域名: cfg.tencentcloudapi.com 。
查询经验库列表
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTemplateList。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Limit | 是 | Integer | 分页Limit, 最大值100 示例值:10 |
Offset | 是 | Integer | 分页Offset 示例值:0 |
Title | 否 | String | 演练名称 示例值:"1" |
Tag.N | 否 | Array of String | 标签键 示例值:"1" |
IsUsed | 否 | Integer | 状态,1---使用中, 2---停用 示例值:1 |
Tags.N | 否 | Array of TagWithDescribe | 标签对 |
TemplateSource | 否 | Integer | 经验来源 0-自建 1-专家推荐 示例值:0 |
TemplateIdList.N | 否 | Array of Integer | 经验ID 示例值:1870 |
Filters.N | 否 | Array of ActionFilter | 过滤参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TemplateList | Array of TemplateListItem | 经验库列表 |
Total | Integer | 列表数量 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 经验库列表
查询经验库列表
输入示例
POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateList
<公共请求参数>
{
"Limit": "10",
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "0c06dc9d-1e90-4062-a038-74abf2bbd43d",
"TemplateList": [
{
"TemplateId": 511,
"TemplateTitle": "测试经验",
"TemplateDescription": "测试",
"TemplateTag": null,
"TemplateIsUsed": 1,
"TemplateCreateTime": "2021-10-12 17:28:13",
"TemplateUpdateTime": "2021-10-12 17:48:16",
"TemplateUsedNum": 0
},
{
"TemplateId": 509,
"TemplateTitle": "test",
"TemplateDescription": "test",
"TemplateTag": "test",
"TemplateIsUsed": 2,
"TemplateCreateTime": "2021-09-28 15:38:00",
"TemplateUpdateTime": "2021-10-11 16:26:45",
"TemplateUsedNum": 0
}
],
"Total": 2
}
}
示例2 查询经验列表
查询经验列表
输入示例
POST / HTTP/1.1
Host: cfg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateList
<公共请求参数>
{
"Limit": 10,
"Offset": 1
}
输出示例
{
"Response": {
"RequestId": "6775138e-92c5-40cb-ab0e-a61a5c63b5fa",
"TemplateList": [
{
"TemplateCreateTime": "2023-06-06 15:05:18",
"TemplateDescription": "3",
"TemplateId": 914,
"TemplateIsUsed": 1,
"TemplateSource": 0,
"TemplateTag": "",
"TemplateTitle": "3",
"TemplateUpdateTime": "2023-06-06 15:05:18",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-05 14:43:42",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 913,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-05 14:43:42",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-05 14:42:31",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 912,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-05 14:42:31",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-05 11:48:02",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 910,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-05 11:48:02",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-05 11:48:02",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 911,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-05 11:48:02",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-02 17:38:34",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 904,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-02 17:38:34",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-02 17:38:34",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 905,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-02 17:38:34",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-02 17:38:34",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 906,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-02 17:38:34",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-02 17:38:34",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 907,
"TemplateIsUsed": 1,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-02 17:38:34",
"TemplateUsedNum": 0
},
{
"TemplateCreateTime": "2023-06-02 17:38:34",
"TemplateDescription": "从接入层、逻辑层、数据层模拟单AZ故障,进而验证架构跨可用区容灾的有效性",
"TemplateId": 908,
"TemplateIsUsed": 2,
"TemplateSource": 1,
"TemplateTag": "",
"TemplateTitle": "跨可用区容灾演练",
"TemplateUpdateTime": "2023-06-13 16:30:37",
"TemplateUsedNum": 0
}
],
"Total": 43
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |