1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
创建新企业安全组规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddEnterpriseSecurityGroupRules。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Data.N | 是 | Array of SecurityGroupRule | 创建规则数据 示例值:[ { "Description": "rule", "DestContent": "81.69.8.8", "DestType": "net", "OrderIndex": "1", "Port": "6666", "Protocol": "UDP", "RuleAction": "accept", "ServiceTemplateId": "", "SourceContent": "81.69.14.119", "SourceType": "net" } ] |
Type | 否 | Integer | 添加类型,0:添加到最后,1:添加到最前;2:中间插入;默认0添加到最后 示例值:1 |
ClientToken | 否 | String | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。 示例值:123e4567-e89b-12d3-a456-426655440000 |
IsDelay | 否 | Integer | (IsDelay为老版参数,新版无需输入)是否延迟下发,1则延迟下发,否则立即下发 示例值:1 |
From | 否 | String | 来源 默认空 覆盖导入是 batch_import_cover 示例值:batch_import_cover |
IsUseId | 否 | Integer | 是否复用rule id,1为是,默认不需要 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Status | Integer | 状态值,0:添加成功,非0:添加失败 示例值:0 |
Rules | Array of SecurityGroupSimplifyRule | 添加成功的规则详情 示例值:[ { "RuleUuid": 31375, "Sequence": 1, "SourceContent": "81.69.14.119", "DestContent": "81.69.9.181", "Protocol": "UDP", "Description": "autotest_3" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建新企业安全组规则
创建新企业安全组规则
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddEnterpriseSecurityGroupRules
<公共请求参数>
{
"Data": [
{
"OrderIndex": "1",
"Protocol": "TCP",
"SourceType": "net",
"SourceContent": "192.168.0.1",
"DestType": "net",
"DestContent": "192.168.0.2",
"RuleAction": "accept",
"Port": "80",
"Description": "规则详情"
}
]
}
输出示例
{
"Response": {
"Status": 1,
"Rules": [
{
"SourceContent": "192.168.0.1",
"DestContent": "192.168.0.2",
"Protocol": "TCP",
"Description": "规则详情",
"RuleUuid": 1,
"Sequence": 1
}
],
"RequestId": "d4b7cab1-5594-41fb-88c6-67822af94807"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
ResourceInUse | 资源被占用。 |
UnsupportedOperation | 操作不支持。 |