查询安全组规则列表v3
更新时间 2025-08-26 16:07:50
最近更新时间: 2025-08-26 16:07:50
接口功能介绍
查询安全组规则列表v3
接口约束
无
URI
GET /v3/securityGroup/rule/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| securityGroupOid | 是 | String | 安全组ID |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupOid | String | 安全组id | ||
| securityGroupName | String | 安全组名字 | ||
| osSecurityGroupName | String | os侧安全组名字 | ||
| foreignGroupId | String | 安全组uuid | ||
| remark | String | 描述 | ||
| strategynetworkDTOList | Array of Objects | 规则列表 | strategynetworkDTOList |
表 strategynetworkDTOList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| direction | Integer | 规则方向。[入方向：15，出方向：10] | ||
| ipAddressField | String | IP地址 | ||
| protocolType | String | 端口协议。[10：自定义TCP，15：自定义UDP，20：全部ICMP，25：GRE，30：全部TCP-非自定义，35：全部UDP_非自定义，99：全部放通] | ||
| portRange | String | 端口范围，例如 20000,20006，如果是全部端口则填 ALL | ||
| authPolicy | Integer | 规则类型。[拒绝：15，允许：10] | ||
| securityGroupOid | String | 安全组ID |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":[{
"securityGroupOid":"sg-41f5rni5zu4oufa85xwob",
"securityGroupName":"security-apitest-update",
"osSecurityGroupName":null,
"foreignGroupId":"75452c2f-4ae5-49fe-b097-5aed8a76117f",
"isRelStrategy":null,
"remark":"qqq",
"strategynetworkDTOList":[{
"direction":15,
"ipAddressField":"0.0.0.0/0",
"protocolType":"10",
"portRange":"ALL",
"authPolicy":10,
"securityGroupOid":"sg-41f5rni5zu4oufa85xwob"
}]
}]
}
状态码
请参考 状态码
错误码
请参考 错误码
