DocsKnowledge BaseAPI Explorer
Documentation›Explore more›ZStack ZSphere›API ReferenceZVF

Cluster Related Interfaces

CreateCluster

API Request

URLs
POST zstack/v1/clusters
Headers
Authorization: OAuth the-session-uuid
Body
{
"params": {
"zoneUuid": "d5629a75f0a24280ac669d93d38a7dcd",
"name": "cluster1",
"description": "test",
"hypervisorType": "KVM"
  },
"systemTags": [],
"userTags": []
}
Note: In the above example, systemTags and userTags fields can be omitted. They are listed to indicate that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"zoneUuid":"e1fb7d87073b397c857eaeeb16243103","name":"cluster1","description":"test","hypervisorType":"KVM"}}' \
http://localhost:8080/zstack/v1/clusters
Parameter List
Name Type Location Description Allowed Values Starting Version
zoneUuid String body (contained in params structure) Data Center UUID 0.6
name String body (contained in params structure) Resource name 0.6
description (optional) String body (contained in params structure) Resource description 0.6
hypervisorType String body (contained in params structure) Hypervisor type
  • KVM
  • Simulator
 4.0.0
type (optional) String body (contained in params structure) Reserved field. Do not use.
  • zstack
 0.6
resourceUuid (optional) String body (contained in params structure)
  • When resourceUuid is not null, the virtualization platform uses this value as the UUID of the resource being created;
  • Otherwise, the virtualization platform automatically generates a UUID
 0.6
architecture (optional) String body (contained in params structure) Optional. The architecture.
  • x86_64
  • aarch64
  • mips64el
 4.0.0
tagUuids (optional) List body (contained in params structure) Optional. The tag UUIDs. 4.0.0
systemTags (optional) List body System tag 0.6
userTags (optional) List body User tag 0.6

API Response

Response Example
{
"inventory": {
"name": "cluster1",
"uuid": "dc7442bb39674d779d688369329ba845",
"description": "test",
"state": "Enabled",
"hypervisorType": "KVM",
"createDate": "Jun 7, 2017 9:20:31 PM",
"lastOpDate": "Jun 7, 2017 9:20:31 PM",
"zoneUuid": "342b68c14869412984d6327a58b18f9b",
"type": "zstack"
  }
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 0.6
inventory ClusterInventory See details inventory 0.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#inventory
Name Type Description Starting Version
name String Resource name 0.6
uuid String Resource UUID, uniquely identifies the resource 0.6
description String Resource description 0.6
state String Cluster state 0.6
hypervisorType String Hypervisor type 0.6
createDate Timestamp Creation time 0.6
lastOpDate Timestamp Last modification time 0.6
zoneUuid String Data Center UUID 0.6
type String Reserved field 0.6

SDK Examples

Java SDK
CreateClusterAction action = new CreateClusterAction();
action.zoneUuid = "70fd596da027478eb22ac9357aed23f4";
action.name = "cluster1";
action.description = "test";
action.hypervisorType = "KVM";
action.sessionId = "894477861bcc45488978b584908e4ee3";
CreateClusterAction.Result res = action.call();
Python SDK
CreateClusterAction action = CreateClusterAction()
action.zoneUuid = "cfe698802c87486986878daa2da7e02f"
action.name = "cluster1"
action.description = "test"
action.hypervisorType = "KVM"
action.sessionId = "0664130c5d36414bbb3a7a59ef87ea5a"
CreateClusterAction.Result res = action.call()

DeleteCluster

API Request

URLs
DELETE zstack/v1/clusters/{uuid}?deleteMode={deleteMode}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth d55b1a48ad2348ceb3bea95b407a8bde" \
-X DELETE http://localhost:8080/zstack/v1/clusters/a5bb7e5ca83f41748538d953709ba3c3?deleteMode=Permissive
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Resource UUID, uniquely identifies the resource 0.6
deleteMode (optional) String body Delete mode 0.6
systemTags (optional) List body System tag 0.6
userTags (optional) List body User tag 0.6

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains an error field, for example:

{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
    }
}

SDK Examples

Java SDK
DeleteClusterAction action = new DeleteClusterAction();
action.uuid = "51b6e91ce692487ea582418f52835061";
action.deleteMode = "Permissive";
action.sessionId = "41695ae924854a3abfc1e681e092f744";
DeleteClusterAction.Result res = action.call();
Python SDK
DeleteClusterAction action = DeleteClusterAction()
action.uuid = "2e9d94bbe3d240d3a660e86a7cd6aff8"
action.deleteMode = "Permissive"
action.sessionId = "386fba061d404eeb830a772e31fd4faf"
DeleteClusterAction.Result res = action.call()

QueryCluster

API Request

URLs
GET zstack/v1/clusters
GET zstack/v1/clusters/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 815c808ecfb5461b953544d4bcefea31" \
-X GET http://localhost:8080/zstack/v1/clusters?q=hypervisorType=KVM
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 663eef55906d4b6e9750f9b4ed65f5f9" \
-X GET http://localhost:8080/zstack/v1/clusters/a8d5ea1ceda34616a26bec2fce3b4d8a

Queryable Fields

Run the CLI command tool, enter QueryCluster and press Tab to view all queryable fields and resource names that can be queried across tables.

API Response

Response Example
{
"inventories": [
    {
"name": "cluster1",
"uuid": "41f3a4eb130347a2af6d7f2e0d21fab0",
"description": "test",
"state": "Enabled",
"hypervisorType": "KVM",
"createDate": "Jun 7, 2017 9:20:13 PM",
"lastOpDate": "Jun 7, 2017 9:20:13 PM",
"zoneUuid": "aad01c8b25774796b2e341ec51a7c9c1",
"type": "zstack"
    }
  ]
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 0.6
inventories List See details inventories 0.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#inventories
Name Type Description Starting Version
name String Resource name 0.6
uuid String Resource UUID, uniquely identifies the resource 0.6
description String Resource description 0.6
state String Cluster state 0.6
hypervisorType String Hypervisor type 0.6
createDate Timestamp Creation time 0.6
lastOpDate Timestamp Last modification time 0.6
zoneUuid String Data Center UUID 0.6
type String Reserved field 0.6

SDK Examples

Java SDK
QueryClusterAction action = new QueryClusterAction();
action.conditions = asList("hypervisorType=KVM");
action.sessionId = "3e214b652cc947ea9e1aa256d05752ea";
QueryClusterAction.Result res = action.call();
Python SDK
QueryClusterAction action = QueryClusterAction()
action.conditions = ["hypervisorType=KVM"]
action.sessionId = "ad8f3cd4b5bc4da0a3a91dc8bcbdd18c"
QueryClusterAction.Result res = action.call()

UpdateCluster

API Request

URLs
PUT zstack/v1/clusters/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
"updateCluster": {
"name": "cluster1",
"description": "test"
  },
"systemTags": [],
"userTags": []
}
Note: In the above example, systemTags and userTags fields can be omitted. They are listed to indicate that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateCluster":{"name":"cluster1","description":"test"}}' \
http://localhost:8080/zstack/v1/clusters/851a3783e1503de2a1b9222014c843c4/actions
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Resource UUID, uniquely identifies the resource 0.6
name (optional) String body (contained in updateCluster structure) Resource name 0.6
description (optional) String body (contained in updateCluster structure) Resource description 0.6
systemTags (optional) List body System tag 0.6
userTags (optional) List body User tag 0.6

API Response

Response Example
{
"inventory": {
"name": "cluster1",
"uuid": "9dd0fbecb0e04260ad161c66d1da9f96",
"description": "test",
"state": "Enabled",
"hypervisorType": "KVM",
"createDate": "Jun 7, 2017 9:20:29 PM",
"lastOpDate": "Jun 7, 2017 9:20:29 PM",
"zoneUuid": "25b7ddce968f4cbbb58aa5a205e116ee",
"type": "zstack"
  }
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 0.6
inventory ClusterInventory See details inventory 0.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#inventory
Name Type Description Starting Version
name String Resource name 0.6
uuid String Resource UUID, uniquely identifies the resource 0.6
description String Resource description 0.6
state String Cluster state 0.6
hypervisorType String Hypervisor type 0.6
createDate Timestamp Creation time 0.6
lastOpDate Timestamp Last modification time 0.6
zoneUuid String Data Center UUID 0.6
type String Reserved field 0.6

SDK Examples

Java SDK
UpdateClusterAction action = new UpdateClusterAction();
action.uuid = "ce185b26a4f14153941a868435d94498";
action.name = "cluster1";
action.description = "test";
action.sessionId = "5abfadbc97d64b4687ba6281de117d2d";
UpdateClusterAction.Result res = action.call();
Python SDK
UpdateClusterAction action = UpdateClusterAction()
action.uuid = "a643ba1b98524c60acced530ce2ded1b"
action.name = "cluster1"
action.description = "test"
action.sessionId = "cc779e5d5344493d9bd1cb1ced887321"
UpdateClusterAction.Result res = action.call()

ChangeClusterState

API Request

URLs
PUT zstack/v1/clusters/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid
Body
{
"changeClusterState": {
"stateEvent": "disable"
  },
"systemTags": [],
"userTags": []
}
Note: In the above example, systemTags and userTags fields can be omitted. They are listed to indicate that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeClusterState":{"stateEvent":"disable"}}' \
http://localhost:8080/zstack/v1/clusters/652ee5e996203bfbb5eb75e750720093/actions
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Resource UUID, uniquely identifies the resource 0.6
stateEvent String body (contained in changeClusterState structure) Availability state trigger event
  • enable
  • disable
 0.6
systemTags (optional) List body System tag 0.6
userTags (optional) List body User tag 0.6

API Response

Response Example
{
"inventory": {
"name": "cluster1",
"uuid": "2cebd4274c7c4550add1ee3620b52a81",
"description": "test",
"state": "Enabled",
"hypervisorType": "KVM",
"createDate": "Jun 7, 2017 9:20:25 PM",
"lastOpDate": "Jun 7, 2017 9:20:25 PM",
"zoneUuid": "90eb72b73e144650990db2aa1ddee7c1",
"type": "zstack"
  }
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 0.6
inventory ClusterInventory See details inventory 0.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#inventory
Name Type Description Starting Version
name String Resource name 0.6
uuid String Resource UUID, uniquely identifies the resource 0.6
description String Resource description 0.6
state String Cluster state 0.6
hypervisorType String Hypervisor type 0.6
createDate Timestamp Creation time 0.6
lastOpDate Timestamp Last modification time 0.6
zoneUuid String Data Center UUID 0.6
type String Reserved field 0.6

SDK Examples

Java SDK
ChangeClusterStateAction action = new ChangeClusterStateAction();
action.uuid = "b97eb5ab5e264edbad128090b0ac28c2";
action.stateEvent = "disable";
action.sessionId = "79368b716c6a4d5db37fc7c601bf14cc";
ChangeClusterStateAction.Result res = action.call();
Python SDK
ChangeClusterStateAction action = ChangeClusterStateAction()
action.uuid = "24f520e8991d464eaf2ed9b1e55996a3"
action.stateEvent = "disable"
action.sessionId = "11db5049d24342e7af8b1a3992484184"
ChangeClusterStateAction.Result res = action.call()

UpdateClusterOS

API Request

URLs
PUT zstack/v1/clusters/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateClusterOS": {
    "excludePackages": [
      "kernel",
      "systemd*"
    ],
    "updatePackages": [
      "zstack-release"
    ],
    "releaseVersion": "c74"
  },
  "systemTags": [],
  "userTags": []
}
Note: In the above example, systemTags and userTags fields can be omitted. They are listed to indicate that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateClusterOS":{"excludePackages":["kernel","systemd*"],"updatePackages":["zstack-release"],"releaseVersion":"c74"}}' http://localhost:8080/zstack/v1/clusters/31c4951f39ae38969802e833448369ae/actions
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Resource UUID, uniquely identifies the resource 2.3
excludePackages (optional) List body (contained in updateClusterOS structure) List of packages not to upgrade 3.7.0
updatePackages (optional) List body (contained in updateClusterOS structure) List of packages to upgrade 3.7.0
releaseVersion (optional) String body (contained in updateClusterOS structure) Version of the repository for upgrade 3.7.0
resourceUuid (optional) String body (contained in updateClusterOS structure) Optional. The resource UUID. 3.7.0
tagUuids (optional) List body (contained in updateClusterOS structure) Tag UUID list 3.7.0
systemTags (optional) List body System tag 2.3
userTags (optional) List body User tag 2.3

API Response

Response Example
{
  "inventory": {
    "uuid": "932696598b64375ea4ae6226cc0c1407"
  }
}
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 2.3
inventory LongJobInventory See details inventory 2.2
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#inventory
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 2.2.4
name String Resource name 2.2.4
description String Resource description 2.2.4
apiId String API ID used to associate TaskProgress 2.2.4
jobName String Job name 2.2.4
jobData String Job data 2.2.4
jobResult String Job result 2.2.4
targetResourceUuid String Target resource UUID 2.2.4
managementNodeUuid String Management Node UUID 2.2.4
createDate Timestamp Creation time 2.2.4
lastOpDate Timestamp Last modification time 2.2.4
executeTime Long The execute time. 3.7.0
state LongJobState See details state 2.2.4
#state
Name Type Description Starting Version
Waiting LongJobState The Waiting value. 3.7.0
Suspended LongJobState The Suspended value. 3.7.0
Running LongJobState The Running value. 3.7.0
Succeeded LongJobState The Succeeded value. 3.7.0
Canceling LongJobState The Canceling value. 3.7.0
Canceled LongJobState The Canceled value. 3.7.0
Failed LongJobState The Failed value. 3.7.0

SDK Examples

Java SDK
UpdateClusterOSAction action = new UpdateClusterOSAction();
action.uuid = "31c4951f39ae38969802e833448369ae";
action.excludePackages = asList("kernel","systemd*");
action.updatePackages = asList("zstack-release");
action.releaseVersion = "c74";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateClusterOSAction.Result res = action.call();
Python SDK
UpdateClusterOSAction action = UpdateClusterOSAction()
action.uuid = "31c4951f39ae38969802e833448369ae"
action.excludePackages = [kernel, systemd*]
action.updatePackages = [zstack-release]
action.releaseVersion = "c74"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateClusterOSAction.Result res = action.call()

GetClusterHostNetworkFacts

API Request

URLs
GET zstack/v1/cluster/hosts-network-facts/{clusterUuid}?hostUuid={hostUuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/cluster/hosts-network-facts/811d04aa12e3390cb29cb7664862e1f2?limit=1000&start=0
Parameter List
Name Type Location Description Allowed Values Starting Version
hostUuid String url Cluster UUID 4.3.6
limit (optional) Integer query Optional. The limit. 4.3.6
start (optional) Integer query Optional. The start. 4.3.6
systemTags (optional) List query Optional. The system tags. 4.3.6
userTags (optional) List query Optional. The user tags. 4.3.6

API Response

Response Example
{
  "bondings": [
    {
      "uuid": "23d8ef3080f3379887097e816463d1cf",
      "hostUuid": "46ee6624a6a8307295c583884340d5c2",
      "bondingName": "bond0",
      "mode": "active-backup 1",
      "xmitHashPolicy": "layer2 0",
      "miiStatus": "up",
      "mac": "ac:1f:6b:93:6c:8c",
      "ipAddresses": [
        "172.20.0.116/16"
      ],
      "miimon": 100,
      "allSlavesActive": true,
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM",
      "slaves": [
        {
          "uuid": "79bae81259b83a5989d9f7664ea033ba",
          "hostUuid": "46ee6624a6a8307295c583884340d5c2",
          "bondingUuid": "23d8ef3080f3379887097e816463d1cf",
          "interfaceName": "eno1",
          "interfaceType": "bondingSlave",
          "speed": 1000,
          "slaveActive": true,
          "carrierActive": true,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 2:20:57 PM",
          "lastOpDate": "Nov 14, 2017 2:20:57 PM"
        },
        {
          "uuid": "197768d887cf3f2a985f58d0e10a48b4",
          "hostUuid": "46ee6624a6a8307295c583884340d5c2",
          "bondingUuid": "23d8ef3080f3379887097e816463d1cf",
          "interfaceName": "eno2",
          "interfaceType": "bondingSlave",
          "speed": 1000,
          "slaveActive": false,
          "carrierActive": false,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 2:20:57 PM",
          "lastOpDate": "Nov 14, 2017 2:20:57 PM"
        }
      ]
    }
  ],
  "nics": [
    {
      "uuid": "79bae81259b83a5989d9f7664ea033ba",
      "hostUuid": "46ee6624a6a8307295c583884340d5c2",
      "bondingUuid": "23d8ef3080f3379887097e816463d1cf",
      "interfaceName": "eno1",
      "interfaceType": "bondingSlave",
      "speed": 1000,
      "slaveActive": true,
      "carrierActive": true,
      "mac": "ac:1f:6b:93:6c:8c",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    },
    {
      "uuid": "197768d887cf3f2a985f58d0e10a48b4",
      "hostUuid": "46ee6624a6a8307295c583884340d5c2",
      "bondingUuid": "23d8ef3080f3379887097e816463d1cf",
      "interfaceName": "eno2",
      "interfaceType": "bondingSlave",
      "speed": 1000,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "ac:1f:6b:93:6c:8c",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    },
    {
      "uuid": "2b43c44d63b03009a52cd95dbceccc21",
      "hostUuid": "46ee6624a6a8307295c583884340d5c2",
      "interfaceName": "ens2f0",
      "interfaceType": "noMaster",
      "speed": 1000,
      "slaveActive": true,
      "carrierActive": true,
      "ipAddresses": [
        "169.254.0.115/24"
      ],
      "mac": "98:03:9b:00:ea:f2",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    },
    {
      "uuid": "3071fef136fa3102b7289c3e3c461da1",
      "hostUuid": "46ee6624a6a8307295c583884340d5c2",
      "interfaceName": "ens2f1",
      "interfaceType": "bridgeSlave",
      "speed": 1000,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "98:03:9b:00:ea:f3",
      "createDate": "Nov 14, 2017 2:20:57 PM",
      "lastOpDate": "Nov 14, 2017 2:20:57 PM"
    }
  ]
}
Name Type Description Starting Version
success boolean Whether the operation succeeded. 4.3.6
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See details error 4.3.6
bondings List See details bondings 4.3.6
nics List See details nics 4.3.6
#error
Name Type Description Starting Version
code String Error code number, globally unique identifier of the error, e.g. SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, default is null 0.6
opaque LinkedHashMap Reserved field, default is null 0.6
cause ErrorCode Root cause, the error that caused the current error. If there is no original error, this field is null 0.6
#bondings
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.5.0
hostUuid String Host UUID 3.5.0
bondingName String Bond name 3.5.0
bondingType String Bond application status, can be noBridge, bridgeSlave 4.7.0
speed Long Bond speed 4.7.0
mode String Bond mode 3.5.0
xmitHashPolicy String Hash policy 3.5.0
miiStatus String MII status 3.5.0
mac String MAC address 3.5.0
ipAddresses List IP addresses 3.5.0
gateway String Gateway address 4.7.0
callBackIp String Callback address 4.7.0
miimon Long MII monitor interval 3.5.0
type String Bond type 4.7.0
allSlavesActive Boolean The all slaves active. 3.5.0
description String Resource description 4.7.0
createDate Timestamp Creation time 3.5.0
lastOpDate Timestamp Last modification time 3.5.0
slaves List See details slaves 3.5.0
#slaves
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.5.0
hostUuid String Host UUID 3.5.0
bondingUuid String Bond UUID 3.5.0
interfaceModel String Network card model 4.7.11
vendorId String Vendor ID 4.7.11
deviceId String Device ID 4.7.11
subvendorId String Sub-vendor ID 4.7.11
subdeviceId String Sub-device ID 4.7.11
interfaceName String Network card name 3.5.0
interfaceType String Network card application status, can be noMaster, bridgeSlave, bondSlave 3.5.0
speed Long Network card speed 3.5.0
slaveActive Boolean Bond link status 3.5.0
carrierActive Boolean Physical link status 3.5.0
ipAddresses List IP addresses 3.5.0
gateway String Gateway address 4.7.0
mac String MAC address 3.5.0
callBackIp String Callback address 4.7.0
pciDeviceAddress String Network card PCI address 3.5.0
offloadStatus String The offload status. 4.7.0
description String Resource description 4.7.0
createDate Timestamp Creation time 3.5.0
lastOpDate Timestamp Last modification time 3.5.0
#nics
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.5.0
hostUuid String Host UUID 3.5.0
bondingUuid String Bond UUID 3.5.0
interfaceModel String Network card model 4.7.11
vendorId String Vendor ID 4.7.11
deviceId String Device ID 4.7.11
subvendorId String Sub-vendor ID 4.7.11
subdeviceId String Sub-device ID 4.7.11
interfaceName String Network card name 3.5.0
interfaceType String Network card application status, can be noMaster, bridgeSlave, bondSlave 3.5.0
speed Long Network card speed 3.5.0
slaveActive Boolean Bond link status 3.5.0
carrierActive Boolean Physical link status 3.5.0
ipAddresses List IP addresses 3.5.0
gateway String Gateway address 4.7.0
mac String MAC address 3.5.0
callBackIp String Callback address 4.7.0
pciDeviceAddress String Network card PCI address 3.5.0
offloadStatus String The offload status. 4.7.0
description String Resource description 4.7.0
createDate Timestamp Creation time 3.5.0
lastOpDate Timestamp Last modification time 3.5.0

SDK Examples

Java SDK
GetClusterHostNetworkFactsAction action = new GetClusterHostNetworkFactsAction();
action.clusterUuid = "811d04aa12e3390cb29cb7664862e1f2";
action.limit = 1000;
action.start = 0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetClusterHostNetworkFactsAction.Result res = action.call();
Python SDK
GetClusterHostNetworkFactsAction action = GetClusterHostNetworkFactsAction()
action.clusterUuid = "811d04aa12e3390cb29cb7664862e1f2"
action.limit = 1000
action.start = 0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetClusterHostNetworkFactsAction.Result res = action.call()
PreviousData Center Related InterfacesNextHost Related Interfaces
API Reference | ZStack ZSphere · ZVF | ZStack Resource Center