API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 边缘安全加速平台 EO > 安全配置相关接口 > 绑定或解绑安全策略模板

绑定或解绑安全策略模板

最近更新时间：2024-04-19 15:23:51

我的收藏

本页目录：

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

操作安全策略模板，支持将域名绑定或换绑到指定的策略模板，或者从指定的策略模板解绑。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：BindSecurityTemplateToEntity。
Version 是 String 公共参数，本接口取值：2022-09-01。
Region 否 String 公共参数，此参数为可选参数。
ZoneId 是 String 需要绑定或解绑的策略模板所属站点 ID。
Entities.N 是 Array of String 绑定至策略模板（或者从策略模板解绑）的域名列表。
Operate 是 String 绑定或解绑操作选项，取值有：
  • bind：绑定域名至策略模板；
  • unbind-keep-policy：将域名从策略模板解绑，解绑时保留当前策略；
  • unbind-use-default：将域名从策略模板解绑，并使用默认空白策略。
    • 注意：解绑操作当前仅支持单个域名解绑。即：当 Operate 参数取值为 unbind-keep-policy 或 unbind-use-default 时，Entities 参数列表仅支持填写一个域名。
    TemplateId 是 String 指定绑定或解绑的策略模板 ID 或站点全局策略
    - 如需绑定至策略模板，或从策略模板解绑，请指定策略模板 ID。
    - 如需绑定至站点全局策略，或从站点全局策略解绑，请使用 @ZoneLevel@domain 参数值。

    注意：解绑后，域名将使用独立策略，并单独计算规则配额，请确保解绑前套餐规则配额充足。
    OverWrite 否 Boolean 如指定的域名已经绑定了策略模板，是否替换该模板。支持下列取值：
  • true： 替换域名当前绑定的模板；
  • false：不替换域名当前绑定的模板。
    • 注意：当选择不替换已有策略模板时，若指定域名已经绑定策略模板，API 将返回错误。

    3. 输出参数

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

    4. 示例

    示例1 将指定域名从策略模板解绑

    此方法会把已经绑定策略模板的指定域名从策略模板解绑。目前仅支持同时解绑一个域名。解绑时，支持下列选项：

    1. 在规则配额允许情况下，保留当前策略。解绑时，将会为域名生成一条独立安全策略，该策略使用与当前策略模板相同的配置，其中的规则将额外占用规则配额。
    2. 使用空白安全策略。使用默认空白策略，预设规则将使用默认配置，自定义规则内容将不再生效。

    例如：将 a.test.com 从已有策略模板（策略模板 ID 为 temp-cuwg1hki，所属站点 ID 为 zone-2aq0e8rhu6jx ）解绑，可以参考以下示例进行解绑操作。

    注意：如您选择保留当前策略配置，请确保当前站点有足够安全规则配额。剩余配额不足以支持保留当前策略时，解绑失败，域名将仍然绑定于当前策略模板上。

    输入示例

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

{
    "ZoneId": "zone-2aq0e8rhu6jx",
    "Entities": [
        "a.test.com"
    ],
    "TemplateId": "temp-cuwg1hki",
    "Operate": "unbind-keep-policy"
}

    输出示例

    {
    "Response": {
        "RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669"
    }
}

    示例2 将策略模板应用到指定域名 （绑定域名至策略模板）

    此方法会把已有策略模板应用到指定域名。支持同时绑定至多个站点的域名。

    例如：将 a.test.com 和 b.example.com 域名绑定至已有策略模板（策略模板 ID 为 temp-cuwg1hki，所属站点 ID 为 zone-2aq0e8rhu6jx ），可以参考以下示例进行绑定操作。

    注意：您的账号需要具有指定域名列表所归属全部站点的操作权限。

    输入示例

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

{
    "ZoneId": "zone-2aq0e8rhu6jx",
    "Entities": [
        "a.test.com",
        "b.example.com"
    ],
    "TemplateId": "temp-cuwg1hki",
    "Operate": "bind",
    "OverWrite": true
}

    输出示例

    {
    "Response": {
        "RequestId": "09ce3d28-1119-49cd-xxxx-27cb34dac669"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ConfigLocked 配置已被锁定，请解除配置锁定之后在重试。
    InternalError.ProxyServer 后端服务器发生未知错误。
    InvalidParameter.Security 参数错误
    OperationDenied 操作被拒绝。
    ResourceInUse 资源被占用。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnsupportedOperation 操作不支持。
    中国站