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

获取可应用安全组的网卡列表清单

获取可应用安全组的网卡列表清单

调试可用性

在线调试

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

路径参数

查询参数

请求参数

路径参数

  • securityGroupUuidString必填

    安全组UUID

查询参数

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • vmInstanceUuidString必填

      虚拟机UUID

    • l3NetworkUuidString必填

      分布式端口组UUID

    • ipString必填

      来源IP地址。

    • macString必填

      暂无描述。

    • hypervisorTypeString必填

      暂无描述。

    • netmaskString必填

      暂无描述。

    • gatewayString必填

      暂无描述。

    • metaDataString必填

      元数据。

    • ipVersionInteger必填

      ip协议号

    • driverTypeString必填

      暂无描述。

    • internalNameString必填

      内部名称。

    • deviceIdInteger必填

      设备ID。

    • typeString必填

      类型。

    • stateString必填

      网卡状态

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • usedIpsList必填

      详情参考usedIps

      • uuidString必填

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

      • ipRangeUuidString必填

        IP段UUID

      • l3NetworkUuidString必填

        分布式端口组UUID

      • ipVersionInteger必填

        IP协议号

      • ipString必填

        IP地址

      • netmaskString必填

        网络掩码

      • gatewayString必填

        网关地址

      • usedForString必填

        已使用用于。

      • ipInLonglong必填

        暂无描述。

      • vmNicUuidString必填

        虚拟机网卡UUID

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/security-groups/{securityGroupUuid}/vm-instances/candidate-nics

/zstack/v1/security-groups/{securityGroupUuid}/vm-instances/candidate-nics

操作 ID

GetCandidateVmNicForSecurityGroup

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/security-groups/{securityGroupUuid}/vm-instances/candidate-nics?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "80d2eab0354c329b8257e8f9fcd76d43", "vmInstanceUuid": "e8af62992ec5343facac7c5fc164ddd0", "l3NetworkUuid": "738cc18ef5003a00937c0e17e6c67a2d", "ip": "192.168.0.123", "mac": "fa:ef:34:5c:6c:00", "hypervisorType": "KVM", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "internalName": "eth0", "deviceId": 0.0 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史