1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
查询新企业安全组规则 从node接口迁移 原接口DescribeSecurityGroupNewList
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEnterpriseSecurityGroupRuleList。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Limit | 是 | Integer | 分页每页数量 示例值:10 |
Offset | 是 | Integer | 分页当前页 示例值:0 |
Status | 否 | String | 启用状态 1启用 0 未启用 示例值:1 |
Area | 否 | String | 地域 示例值:ap-guangzhou |
Filter | 否 | Integer | 规则下发方式筛选 1 新规则和延迟下发 2 仅看新规则 示例值:1 |
SearchValue | 否 | String | 查询条件 示例值:{"Port":"3306","common":""} |
SearchFilters.N | 否 | Array of CommonFilter | 查询条件新 示例值:[{"Name":"common","Values":["andy"],"OperatorType":9}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 查询结果总数 示例值:1 |
AllTotal | Integer | 规则总数 示例值:10 |
Data | Array of EnterpriseSecurityGroupRuleRuleInfo | 规则列表 示例值:[{"AclTags":"名称","BetaList":[{"TaskId":"9001","TaskName":"autotest","LastTime":"1999-01-01 00:00:01"}],"Cidr":"192.16.1.0/24","Detail":"企业安全组描述","InstanceName":"企业安全组实例","IsDelay":0,"IsNew":1,"OrderIndex":1,"ParameterName":"参数模版","Port":"-1/-1","PrivateIp":"1.1.1.1","Protocol":"ANY","ProtocolPortName":"模版","PublicIp":"1.1.1.1","Region":"AllRegion","RuleUuid":61257,"ServiceTemplateId":"ip-didd011","SouCidr":"192.168.1.0/24","SouInstanceName":"模版名称","SouParameterName":"模版名称","SouPrivateIp":"1.1.1.1","SouPublicIp":"1.1.1.1","SourceId":"ipmg-17hphuxg","SourceType":7,"Status":1,"Strategy":1,"TargetId":"cfwrg-b803523898534bcbd9b7d2c7d92c175e1712804418","TargetType":100,"Uuid":"cfw_newsg_1300448058_0.0.0.0/0_17228848067531","Id":61257}] |
Enable | Integer | 规则列表整体启用状态 取值范围 0/1/2 0.表示没有启用的(可以批量启用) 1.表示没有禁用的(可以批量禁用) 2 表示混合情况(不可批量操作) 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1 查询企业安全组信息
查询企业安全组信息
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnterpriseSecurityGroupRuleList
<公共请求参数>
{
"Limit": 1,
"Offset": 0,
"SearchFilters": [
{
"Name": "common",
"Values": [
"模板"
],
"OperatorType": 9
}
]
}
输出示例
{
"Response": {
"AllTotal": 30,
"Data": [
{
"AclTags": "名称",
"BetaList": [
{
"TaskId": "9001",
"TaskName": "autotest",
"LastTime": "1999-01-01 00:00:01"
}
],
"Cidr": "192.16.1.0/24",
"Detail": "企业安全组描述",
"InstanceName": "企业安全组实例",
"IsDelay": 0,
"IsNew": 1,
"OrderIndex": 1,
"ParameterName": "参数模版",
"Port": "-1/-1",
"PrivateIp": "1.1.1.1",
"Protocol": "ANY",
"ProtocolPortName": "模版",
"PublicIp": "1.1.1.1",
"Region": "AllRegion",
"RuleUuid": 61257,
"ServiceTemplateId": "ip-didd011",
"SouCidr": "192.168.1.0/24",
"SouInstanceName": "模版名称",
"SouParameterName": "模版名称",
"SouPrivateIp": "1.1.1.1",
"SouPublicIp": "1.1.1.1",
"SourceId": "ipmg-17hphuxg",
"SourceType": 7,
"Status": 1,
"Strategy": 1,
"TargetId": "cfwrg-b803523898534bcbd9b7d2c7d92c175e1712804418",
"TargetType": 100,
"Uuid": "cfw_newsg_1300448058_0.0.0.0/0_17228848067531",
"Id": 61257
}
],
"Enable": 2,
"RequestId": "d835bbe0-99e8-4cb7-a29a-3dfe2eff7d14",
"Total": 28
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |