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

检查安全组规则是否可用

检查安全组规则是否可用

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • securityGroupUuidString必填

    安全组的UUID，唯一标示该资源

查询参数

  • typeString必填

    安全组规则的方向

  • protocolString必填

    安全组规则的协议类型

  • remoteSecurityGroupUuidString

    远端安全组的UUID，唯一标示该资源

  • ipVersionInteger

    安全组规则的IP版本

  • srcIpRangeString

    安全组规则的源ip范围

请求体字段

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • availableboolean必填

    规则是否可用

  • codeString必填

    规则检验错误码

  • reasonString必填

    原因

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/security-groups/{securityGroupUuid}/rules/validation

/zstack/v1/security-groups/{securityGroupUuid}/rules/validation

操作 ID

ValidateSecurityGroupRule

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/security-groups/{securityGroupUuid}/rules/validation?type=<type>&protocol=<protocol>&remoteSecurityGroupUuid=<remoteSecurityGroupUuid>&ipVersion=1&srcIpRange=<srcIpRange>&dstIpRange=<dstIpRange>&dstPortRange=<dstPortRange>&action=<action>&startPort=1&endPort=1&allowedCidr=<allowedCidr>' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "available": true, "code": "SG.2000" }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史