1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
查询指定策略模板的绑定关系列表。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSecurityTemplateBindings。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 要查询的站点 ID。 |
TemplateId.N | 是 | Array of String | 要查询的策略模板 ID。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SecurityTemplate | Array of SecurityTemplateBinding | 指定策略模板的绑定关系列表。 当某个站点中的域名包含在指定策略模板的绑定关系中时,绑定关系列表 TemplateScope 中会包含该站点的 ZoneId ,和该站点下的和该策略模板有关的域名绑定关系。注意:当没有任何域名正在绑定或已经绑定到指定策略模板时,绑定关系为空。即:返回结构体中, TemplateScope 数组长度为 0。绑定关系中,同一域名可能在 EntityStatus 列表中重复出现,并标记为不同 Status 。例如,正在被绑定到其他策略模板的域名,会同时标记为 online 和 pending 。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询策略模板的绑定关系
此方法会输出策略模板的全部绑定关系,包括:
1)已经生效的绑定关系,标注的 “Status” 为 “online”;
2)正在绑定的绑定关系,标注的 “Status” 为 “pending”。
注意:一个域名可能在绑定关系列表中,出现多次,同时标记为多个状态。
例如:查询 example.com 站点(zone ID 为 zone-fdsjjkfsda)下,策略模板 "生产环境策略" (SecurityTemplate ID 为 temp-fjsoelx)的绑定关系,可以参考以下示例进行查询。
注意:输出示例中包含正在绑定 和绑定失败的绑定关系,策略模板已对该二域名生效。其中,abc.example.com 已绑定至入参指定的策略模板,策略正常生效,因此该绑定关系展示为 online 状态;xyz.example.com 正在被重新绑定至其他策略模板,但是尚未完成绑定,当前策略模板仍然生效,因此同时出现在已经生效和正在绑定的绑定关系列表中。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityTemplateBindings
<公共请求参数>
{
"ZoneId": "zone-fdsjjkfsda",
"TemplateId": [
"temp-fjsoelx"
]
}
输出示例
{
"Response": {
"SecurityTemplate": [
{
"TemplateId": "temp-fjsoelx",
"TemplateScope": [
{
"ZoneId": "zone-fdsjjkfsda",
"EntityStatus": [
{
"Entity": "abc.example.com",
"Status": "online",
"Message": ""
},
{
"Entity": "xyz.example.com",
"Status": "online",
"Message": ""
},
{
"Entity": "xyz.example.com",
"Status": "pending",
"Message": ""
}
]
}
]
}
],
"RequestId": "17d437bc-13a9-49bb-a6ac"
}
}
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.ProxyServer | 后端服务器发生未知错误。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |