跳转到主要内容
API Explorer|API Explorer
网络管理/网络服务/安全组相关接口
GETSecurity Group起始版本 0.6同步需要认证

查询安全组

查询安全组

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • stateString必填

      当前状态。

    • ipVersionInteger必填

      ip协议号

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • attachedL3NetworkUuidsSet必填

      暂无描述。

    • rulesList必填

      详情参考rules

      • uuidString必填

        资源的UUID，唯一标示该资源

      • securityGroupUuidString必填

        安全组UUID

      • typeString必填

        流量类型

      • ipVersionInteger必填

        ip协议号

      • startPortInteger必填

        如果协议是TCP/UDP, 它是端口范围（port range）的起始端口号; 如果协议是ICMP, 它是ICMP类型（type）

      • endPortInteger必填

        如果协议是TCP/UDP, 它是端口范围（port range）的结束端口号; 如果协议是ICMP, 它是ICMP类型（type）

      • protocolString必填

        流量协议类型

      • stateString必填

        规则的可用状态, 当前版本未实现

      • allowedCidrString必填

        允许的CIDR,根据流量类型的不同, 允许的CIDR有不同的含义,如果流量类型是Ingress, 允许的CIDR是允许访问虚拟机网卡的源CIDR,如果流量类型是Egress, 允许的CIDR是允许从虚拟机网卡离开并到达的目的地CIDR

      • remoteSecurityGroupUuidString必填

        远程安全组UUID。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/security-groups

/zstack/v1/security-groups

操作 ID

QuerySecurityGroup

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/security-groups' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "6f757e65fed243babeac0be896e77caf", "name": "web", "description": "for test", "state": "Enabled", "createDate": "Jun 7, 2017 9:20:34 PM", "lastOpDate": "Jun 7, 2017 9:20:34 PM", "internalId": 0.0 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史