Network ResourcesDistributed Switch Related Interfaces

QueryUplinkGroup

GET/zstack/v1/l2-networks/virtual-switch/uplink-group
GET/zstack/v1/l2-networks/virtual-switch/uplink-group/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/l2-networks/virtual-switch/uplink-group
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edessfb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/l2-networks/virtual-switch/uplink-group/d36391a37b5c399ea46eb86bb2f6ec8a

Queryable Fields

Run the CLI command tool, enter QueryUplinkGroup, and press Tab to view all queryable fields and resource names that support cross-table queries.

API Response

Sample Response

{
  "inventories": [
    {
      "interfaceName": "eth0",
      "type": "PhysicalInterface",
      "interfaceUuid": "24343c2ab2803d82b16b531b5e58b086",
      "hostUuid": "1b66d910a4de3418b6214b04ac1a2dd3",
      "l2NetworkUuid": "0472b472fef131999b770c1671515cb7"
    }
  ]
}
NameTypeDescriptionStarting Version
successboolean 4.3.0
inventoriesListSee inventories.4.3.0
errorErrorCodeThe error code. If not null, the operation fails, or vice versa. For more information, see error.4.3.0

inventories

NameTypeDescriptionStarting Version
interfaceNameStringThe interface name.4.3.0
bondingUuidStringThe bonding UUID.4.3.0
interfaceUuidStringThe interface UUID.4.3.0
hostUuidStringThe host UUID.4.3.0
l2NetworkUuidStringThe Distributed Switch UUID.4.3.0
l2ProviderTypeStringThe Distributed Switch implementation type.4.3.0
bridgeNameStringThe bridge name.4.3.0
createDateTimestampThe creation date.4.3.0
lastOpDateTimestampThe last operation date.4.3.0
typeUplinkGroupTypeSee type.4.3.0

type

NameTypeDescriptionStarting Version
PhysicalInterfaceUplinkGroupTypePhysical NIC.4.3.0
BondingUplinkGroupTypeBonding.4.3.0

error

NameTypeDescriptionStarting Version
codeStringThe error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.0.6
descriptionStringThe brief description of the error.0.6
detailsStringThe details about the error.0.6
elaborationStringThe reserved field. Default value: null.0.6
opaqueLinkedHashMapThe reserved field. Default value: null.0.6
causeErrorCodeThe root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.0.6

SDK Sample

Java SDK

QueryUplinkGroupAction action = new QueryUplinkGroupAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryUplinkGroupAction.Result res = action.call();

Python SDK

QueryUplinkGroupAction action = QueryUplinkGroupAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryUplinkGroupAction.Result res = action.call()