关联模型路由 Guardrails 防护

最近更新时间:2026-07-07 10:19:57

我的收藏

1. 接口描述

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

为指定模型路由实例关联 Guardrails 防护。当前支持关联腾讯云 WAF LLM SDK 接入配置,关联成功后,模型路由转发的请求会按照绑定的 WAF 防护配置进行安全检测。

本接口为异步接口。接口返回成功表示请求已受理,可使用返回的 RequestId 调用 DescribeAsyncJobs 查询任务执行结果;防护配置生效后,可调用 DescribeModelRouterGuardrails 查询当前关联。

当前每个模型路由实例最多关联 1 个 Guardrail。如需替换已关联的防护配置,请调用 ModifyModelRouterGuardrails。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssociateModelRouterGuardrails。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
Guardrails.N Array of AssociateGuardrailConfig

待关联的 Guardrail 防护配置列表。

当前最多支持 1 个元素。每个元素必须填写 InstanceId、ServiceId;Type 和 InputCheckDepth 为选填,不传时分别使用默认值 WAF 和 5。本结构不包含 GuardrailId,关联成功后由系统生成。

ModelRouterId String

模型路由实例 ID。


示例值:cmr-abc12345

3. 输出参数

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

4. 示例

示例1 关联 WAF Guardrail 防护

输入示例

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

{
    "ModelRouterId": "cmr-abc12345",
    "Guardrails": [
        {
            "Type": "WAF",
            "InstanceId": "waf_2kw60zgy0908e8j3",
            "ServiceId": "waf_rule_abc123",
            "InputCheckDepth": 5
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnsupportedOperation.InvalidModelRouterStatus UnsupportedOperation.InvalidModelRouterStatus