智简魔方文档

GET 安全组规则列表

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/security_group/{id}/rule
所属业务插件
来源模块/系统快照管理
认证方式Bearer Token(用户令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

安全组规则列表

请求参数

名称位置类型必选说明
idpathinteger(int32)安全组ID
keywordsquerystring关键字
directionquerystring规则方向筛选 in=进方向 out=出方向
pagequeryinteger(int32)页数
limitqueryinteger(int32)每页条数
orderbyquerystring排序 id
sortquerystring升降序 asc desc

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.list[object]安全组规则列表
data.list[].idinteger(int32)安全组规则ID
data.list[].descriptionstring描述
data.list[].directionstring规则方向 in进 out出
data.list[].protocolstring协议 all all_tcp all_udp tcp udp icmp ssh telnet http https mssql oracle mysql rdp postgresql redis gre
data.list[].portstring端口范围
data.list[].ipstring授权IP
data.list[].create_timeinteger(int32)创建时间
data.countinteger(int32)安全组规则总数

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)错误状态码
msgstring错误提示