1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
创建一条 ACL 用户访问控制规则。可选择引用若干条系统规则,亦可自定义规则,两者至少提供其一
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSandboxACLRule。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| RuleName | 是 | String | 规则名称 入参限制:长度 1-128 示例值:禁止出站访问未知域名 |
| Level | 是 | String | 规则级别 枚举值: INFO:提示 LOW:低危 MEDIUM:中危 HIGH:高危 CRITICAL:严重 示例值:HIGH |
| BelongAssetType | 是 | String | 归属资产类型 枚举值: HOST:主机 CONTAINER:容器 示例值:HOST |
| EffectScope | 是 | TrafficSandboxEffectScope | 生效范围 入参限制:EffectScope.EffectType=INCLUDE 时 EffectAssets 必须非空 |
| Status | 是 | String | 初始状态 枚举值: ON:启用 OFF:禁用 示例值:ON |
| RuleAction | 是 | String | 规则动作(RuleAction) 枚举值: PASS:加白 BLOCK:拦截并告警 MONITOR:告警 示例值:BLOCK |
| SystemRuleIDList.N | 否 | Array of Integer | 引用的系统规则 ID 列表 入参限制:最多 100 个;与 UserRuleContent 至少提供其一 示例值:[1001,1002] |
| UserRuleContent.N | 否 | Array of TrafficSandboxACLRuleContentItem | 用户自定义规则内容 入参限制:最多 100 条子规则;与 SystemRuleIDList 至少提供其一 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | 新建规则的 ID 示例值:2001 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 ACL 规则示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSandboxACLRule
<公共请求参数>
{
"RuleName": "禁止出站访问未知域名",
"Level": "HIGH",
"BelongAssetType": "HOST",
"SystemRuleIDList": [
1001
],
"EffectScope": {
"EffectType": "EXCLUDE"
},
"RuleAction": "BLOCK",
"Status": "ON"
}
输出示例
{
"Response": {
"ID": 2001,
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。