Hardware SDN Controller Operations
AddSdnController
API Request
POST zstack/v1/sdn-controllersAuthorization: OAuth the-session-uuid{
"params": {
"vendorType": "vendor",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"userName": "admin",
"password": "password"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTags and userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vendorType":"vendor","name":"sdn-1","description":"sdn controller from vendor","ip":"192.168.1.1","userName":"admin","password":"password"}}' http://localhost:8080/zstack/v1/sdn-controllers| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| vendorType | String | body (contained in the params structure) | 3.7.0 | ||
| name | String | body (contained in the params structure) | The resource name. | 3.7.0 | |
| description | String | body (contained in the params structure) | Optional. The detailed description of the resource. | 3.7.0 | |
| ip | String | body (contained in the params structure) | 3.7.0 | ||
| userName | String | body (contained in the params structure) | Optional. The user name. | 5.3.20 | |
| password | String | body (contained in the params structure) | Optional. The password. | 5.3.20 | |
| resourceUuid | String | body (contained in the params structure) | Optional. The resource UUID. | 3.7.0 | |
| tagUuids | List | body (contained in the params structure) | Optional. The tag UUID list. | 3.7.0 | |
| systemTags | List | body | Optional. The system tags. | 3.7.0 | |
| userTags | List | body | Optional. The user tags. | 3.7.0 | |
| zoneUuid | String | body (contained in the params structure) | Optional. The zone UUID. | 5.3.0 | |
| hostRefs | List | See hostRefs | 5.3.0 |
Note:
- When you add an SDN controller in ZStack Cloud, you
can create an H3C SDN controller by adding the H3C_VDS_UUID option to
SystemTags. The SystemTag is passed by using the vdsUuid
parameter.
- Format of the H3C_VDS_UUID option:
vdsUuid::{%s} - Example:
vdsUuid::1234-5678 - Associated resource:
SdnControllerVO.class
- Format of the H3C_VDS_UUID option:
- When you add a Huawei SDN controller in ZStack Cloud,
you can record the VLAN range used by the SDN controller by adding
startVlan::endVlan options to SystemTags.
- Format:
startVlan::{%s}::endVlan::{%s} - Example:
startVlan::110::endVlan::120 - Associated resource:
SdnControllerVO.class
- Format:
- When you add an H3C v1 SDN controller in ZStack Cloud, you can record the Vni range used by the SDN controller by adding
startVni::endVni options to SystemTags.
- Format:
startVlan::{%s}::endVlan::{%s} - Example:
startVlan::100::endVlan::200 - Associated resource:
SdnControllerVO.class
- Format:
API Response
{
"inventory": {
"uuid": "2f7e443a152833efb0f4b7d196a35ce0",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | Boolean | 5.3.20 | |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.7.0 |
| inventory | SdnControllerInventory | See inventory. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.7.0 |
| description | String | The brief description of the error. | 3.7.0 |
| details | String | The details about the error. | 3.7.0 |
| elaboration | String | The reserved field. Default value: null. | 3.7.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.7.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 3.7.0 |
| vendorType | String | 3.7.0 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 3.7.0 |
| description | String | The detailed description of the resource. | 3.7.0 |
| ip | String | 3.7.0 | |
| username | String | 3.7.0 | |
| password | String | 3.7.0 | |
| createDate | Timestamp | The creation date. | 3.7.0 |
| lastOpDate | Timestamp | The last operation date. | 3.7.0 |
| status | SdnControllerStatus | See status. | 5.3.20 |
| hostRefs | List | See host Refs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
SDK Sample
UpdateSdnControllerAction action = new UpdateSdnControllerAction();
action.uuid = "4a39301758b13cda968bdcd866452d14";
action.name = "Test-Net";
action.description = "Test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSdnControllerAction.Result res = action.call();UpdateSdnControllerAction action = UpdateSdnControllerAction()
action.uuid = "4a39301758b13cda968bdcd866452d14"
action.name = "Test-Net"
action.description = "Test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSdnControllerAction.Result res = action.call()RemoveSdnController
API Request
DELETE zstack/v1/sdn-controllers/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controllers/237901c5097b38c480315569a1ac7567?deleteMode=Permissive| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 3.7.0 | |
| deleteMode | String | body | Optional. The delete mode. | 3.7.0 | |
| systemTags | List | body | Optional. The system tags. | 3.7.0 | |
| userTags | List | body | Optional. The user tags. | 3.7.0 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
RemoveSdnControllerAction action = new RemoveSdnControllerAction();
action.uuid = "237901c5097b38c480315569a1ac7567";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveSdnControllerAction.Result res = action.call();RemoveSdnControllerAction action = RemoveSdnControllerAction()
action.uuid = "237901c5097b38c480315569a1ac7567"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveSdnControllerAction.Result res = action.call()QuerySdnController
API Request
GET zstack/v1/sdn-controllers
GET zstack/v1/sdn-controllers/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controllers?q=uuid=5e897e7e3a663786b873a3e020dbfc0acurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controllers/37c3e4f7602930c5888107528521ac90Queryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QuerySdnController, and pressing the Tab key.
API Response
{
"inventories": [
{
"uuid": "b4134eb269a632eda5df826686733c5e",
"name": "test-sdn",
"description": "sdn for test",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | Boolean | 5.3.20 | |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.7.0 |
| inventories | List | See inventories. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.7.0 |
| description | String | The brief description of the error. | 3.7.0 |
| details | String | The details about the error. | 3.7.0 |
| elaboration | String | The reserved field. Default value: null. | 3.7.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.7.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 3.7.0 |
| vendorType | String | 3.7.0 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 3.7.0 |
| description | String | The detailed description of the resource. | 3.7.0 |
| ip | String | 3.7.0 | |
| username | String | 3.7.0 | |
| password | String | 3.7.0 | |
| createDate | Timestamp | The creation date. | 3.7.0 |
| lastOpDate | Timestamp | The last operation date. | 3.7.0 |
| status | SdnControllerStatus | See status. | 5.3.20 |
| hostRefs | List | See hostRefs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.20 |
| Connected | SdnControllerStatus | Connected. | 5.3.20 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.20 |
SDK Sample
QuerySdnControllerAction action = new QuerySdnControllerAction();
action.conditions = asList("uuid=e9f330402ed03b32a865ac4f19890589");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySdnControllerAction.Result res = action.call();QuerySdnControllerAction action = QuerySdnControllerAction()
action.conditions = ["uuid=d6a1f2d694273d31bfd23736ab530e44"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySdnControllerAction.Result res = action.call()ChangeSdnController
API Request
PUT zstack/v1/sdn-controllers/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"changeSdnController": {
"userName": "sdnuser",
"password": "newpassword"
},
"systemTags": [],
"userTags": []
}
Note:
In the proceding sample, bothsystemTagsand userTags are optional.These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeSdnController":{"userName":"sdnuser","password":"newpassword"}}' http://localhost:8080/zstack/v1/sdn-controllers/fde0b2acbe6c3c7192e32d113f4e00b8/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The UUID of the SDN controller resource. | 5.4.0 | |
| userName | String | body(contained in the changeSdnControllerstructure) | Optional. New user name for the SDN controller. | 5.4.0 | |
| password | String | body(contained in the changeSdnControllerstructure) | Optional. The new password for the SDN controller. | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 | |
| vlanRanges | List | body(contained in the changeSdnControllerstructure) | 5.4.0 |
Note:
- When you create a Layer 3 network in ZStack Cloud,
you can specify the port mirroring network by adding the
mirrorNetwork option to SystemTags.
- Format of the mirrorNetwork option:
mirrorNetwork::{L3NetworkVOUuid} - Example:
mirrorNetwork::1c707a63817b4f29b1235fa1f76c0ccc
- Format of the mirrorNetwork option:
- When you create a Layer 3 network in ZStack Cloud,
you can record the Huawei SDN virtual router UUID associated with the VPC
gateway by adding the logicalRouterUuid option to
SystemTags.
- Format of the logicalRouterUuid option:
logicalRouterUuid::{%s} - Example:
logicalRouterUuid::ecb4a71e0e32476da948a583ea0a220d
- Format of the logicalRouterUuid option:
- When you add a Huawei SDN controller in ZStack Cloud,
you can record the VLAN range used by the SDN controller by adding
startVlan::endVlan:: options to SystemTags.
- Format of the startVlan and endVlan options:
startVlan::{%s}::endVlan::{%s} - Example:
startVlan::100::endVlan::1000
- Format of the startVlan and endVlan options:
API Response
{
"inventory": {
"uuid": "cd65a5af636038bf91f4e404ef9594b1",
"vendorType": "H3C-VCFC",
"name": "updated-sdn-controller",
"description": "Updated SDN controller configuration",
"ip": "192.168.1.100",
"username": "admin",
"password": "newpassword",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
}| Name | Type | Descriotion | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.0 | |
| inventory | SdnControllerInventory |
See inventory. |
5.4.0 |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| vendorType | String | 5.4.0 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| ip | String | 5.4.0 | |
| username | String | 5.4.0 | |
| password | String | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| status | SdnControllerStatus | See status. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
SDK Sample
ChangeSdnControllerAction action = new ChangeSdnControllerAction();
action.uuid = "fde0b2acbe6c3c7192e32d113f4e00b8";
action.userName = "sdnuser";
action.password = "newpassword";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeSdnControllerAction.Result res = action.call();ChangeSdnControllerAction action = ChangeSdnControllerAction()
action.uuid = "fde0b2acbe6c3c7192e32d113f4e00b8"
action.userName = "sdnuser"
action.password = "newpassword"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeSdnControllerAction.Result res = action.call()PullSdnControllerTenant
API Request
PUT zstack/v1/sdn-controllers/{uuid}/tenant/actionsAuthorization: OAuth the-session-uuid{
"pullSdnControllerTenant": {},
"systemTags": [],
"userTags": []
}
Note: In the proceding sample, both
systemTagsand userTags are optional.These two fields can be
included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"pullSdnControllerTenant":{}}' http://localhost:8080/zstack/v1/sdn-controllers/6d53fa409b343fc8a231c100e3f3c90f/tenant/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.3.28 | |
| systemTags | List | body | Optional. The system tags. | 5.3.28 | |
| userTags | List | body | Optional. The user tags. | 5.3.28 |
API Response
{
"inventories": []
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.3.28 | |
| inventories | List | See inventories. | 5.3.28 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.28 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 0.6 |
| description | String | The brief description of the error. | 0.6 |
| details | String | The details about the error. | 0.6 |
| elaboration | String | The reserved field. Default value: null. | 0.6 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 0.6 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.28 |
| sdnControllerUuid | String | 5.3.28 | |
| tenantUuid | String | 5.3.28 | |
| vdsUuid | String | 5.3.28 | |
| tenantName | String | 5.3.28 | |
| vdsName | String | 5.3.28 | |
| cloudDomainName | String | 5.3.28 | |
| status | String | 5.3.28 | |
| createDate | Timestamp | The creation date. | 5.3.28 |
| lastOpDate | Timestamp | The last operation date. | 5.3.28 |
SDK Sample
PullSdnControllerTenantAction action = new PullSdnControllerTenantAction();
action.uuid = "6d53fa409b343fc8a231c100e3f3c90f";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
PullSdnControllerTenantAction.Result res = action.call();PullSdnControllerTenantAction action = PullSdnControllerTenantAction()
action.uuid = "6d53fa409b343fc8a231c100e3f3c90f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
PullSdnControllerTenantAction.Result res = action.call()CreateHuaweiIMasterVRouter
API Request
POST zstack/v1/sdn-controller/huawei-imaster/vroutersAuthorization: OAuth the-session-uuid{
"params": {
"name": "test-vrouter",
"description": "Test VRouter for Huawei iMaster",
"huaweiVpcUuid": "67ed6b0065633829892c11ccf1ee2dba"
},
"systemTags": [],
"userTags": []
}
Note: In the proceeding sample, both systemTagsand
userTags are optional. These two fields can be included in the body
structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"test-vrouter","description":"Test VRouter for Huawei iMaster","huaweiVpcUuid":"67ed6b0065633829892c11ccf1ee2dba"}}' http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vrouters| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| name | String | body (contained in the params structure) | The resource name. | 5.4.0 | |
| description | String | body (contained in the params structure) | Optional. The detailed description of the resource. | 5.4.0 | |
| huaweiVpcUuid | String | body (contained in the params structure) | 5.4.0 | ||
| resourceUuid | String | body (contained in the params structure) | Optional. The resource UUID. | 5.4.0 | |
| tagUuids | List | body (contained in the params structure) | Optional. The tag UUID list. | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"inventory": {
"uuid": "5a7236affa1f34d7908972b14956b18b",
"name": "test-vrouter",
"description": "Test VRouter for Huawei iMaster",
"logicalNetworkId": "605a782332663c769f1845ac76efc526",
"tenantId": "3350497bb7393700b77bc28d625468d8",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.0 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.0 |
| inventory | HuaweiIMasterVRouterInventory | See inventory. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| logicalNetworkId | String | 5.4.0 | |
| tenantId | String | 5.4.0 | |
| fabricUuid | String | 5.4.0 | |
| deleted | Boolean | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
SDK Sample
CreateHuaweiIMasterVRouterAction action = new CreateHuaweiIMasterVRouterAction();
action.name = "test-vrouter";
action.description = "Test VRouter for Huawei iMaster";
action.huaweiVpcUuid = "67ed6b0065633829892c11ccf1ee2dba";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateHuaweiIMasterVRouterAction.Result res = action.call();CreateHuaweiIMasterVRouterAction action = CreateHuaweiIMasterVRouterAction()
action.name = "test-vrouter"
action.description = "Test VRouter for Huawei iMaster"
action.huaweiVpcUuid = "67ed6b0065633829892c11ccf1ee2dba"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateHuaweiIMasterVRouterAction.Result res = action.call()DeleteHuaweiIMasterVRouter
API Request
DELETE zstack/v1/sdn-controller/huawei-imaster/vrouters/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vrouters/523c2083fec532b79fbc3701909e3b25| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.0 | |
| sdnControllerUuid | String | body | Optional. | 5.4.0 | |
| deleteMode | String | body | Optional. The deletion mode (Permissive/Enforcing, Permissive). | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
DeleteHuaweiIMasterVRouterAction action = new DeleteHuaweiIMasterVRouterAction();
action.uuid = "523c2083fec532b79fbc3701909e3b25";
action.sdnControllerUuid = "6f0803e4276a38308d958c2d8dc7381c";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteHuaweiIMasterVRouterAction.Result res = action.call();DeleteHuaweiIMasterVRouterAction action = DeleteHuaweiIMasterVRouterAction()
action.uuid = "523c2083fec532b79fbc3701909e3b25"
action.sdnControllerUuid = "6f0803e4276a38308d958c2d8dc7381c"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteHuaweiIMasterVRouterAction.Result res = action.call()QueryHuaweiIMasterVRouter
API Request
GET zstack/v1/sdn-controller/huawei-imaster/vrouters
GET zstack/v1/sdn-controller/huawei-imaster/vrouters/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vrouters?q=uuid=6a3128b0ec823829ae6dbbdd9e59122ecurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vrouters/c59afc7c9cb739bab4286803ba3536fdQueryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryHuaweiIMasterVRouter, and pressing the Tab key.
API Response
{
"inventories": [
{
"uuid": "e75a229874b23b35903e52a6f52059cb",
"name": "vrouter1",
"description": "vrouter for test",
"logicalNetworkId": "87ed0075640733c291aa223772d9d82d",
"tenantId": "2f4c1e3a62fa3da1ab1cca8b53074b9f"
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.0 | |
| inventories | List | See inventories. | 5.4.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The brief description of the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| logicalNetworkId | String | 5.4.0 | |
| tenantId | String | 5.4.0 | |
| fabricUuid | String | 5.4.0 | |
| deleted | Boolean | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
SDK Sample
QueryHuaweiIMasterVRouterAction action = new QueryHuaweiIMasterVRouterAction();
action.conditions = asList("uuid=5accb3ddb5b1343b81617f13d13a3632");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHuaweiIMasterVRouterAction.Result res = action.call();QueryHuaweiIMasterVRouterAction action = QueryHuaweiIMasterVRouterAction()
action.conditions = ["uuid=dd650dbcf99931a9a9bd442b2b3e4f0d"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHuaweiIMasterVRouterAction.Result res = action.call()DeleteHuaweiIMasterTenant
API Request
DELETE zstack/v1/sdn-controller/huawei-imaster/tenants/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/tenants/082fa02e39d53778a21a7e86b044ce17| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.0 | |
| sdnControllerUuid | String | body | Optional. The SDN controller UUID. | 5.4.0 | |
| deleteMode | String | body | Optional. The deletion mode (Permissive/Enforcing, Permissive). | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
DeleteHuaweiIMasterTenantAction action = new DeleteHuaweiIMasterTenantAction();
action.uuid = "082fa02e39d53778a21a7e86b044ce17";
action.sdnControllerUuid = "2969528393513dcb812b38947a2ff3bc";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteHuaweiIMasterTenantAction.Result res = action.call();DeleteHuaweiIMasterTenantAction action = DeleteHuaweiIMasterTenantAction()
action.uuid = "082fa02e39d53778a21a7e86b044ce17"
action.sdnControllerUuid = "2969528393513dcb812b38947a2ff3bc"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteHuaweiIMasterTenantAction.Result res = action.call()QueryHuaweiIMasterTenant
API Request
GET zstack/v1/sdn-controller/huawei-imaster/tenants
GET zstack/v1/sdn-controller/huawei-imaster/tenants/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/tenants?q=uuid=a611c5dc7e463ffaab957ebfc51e2afecurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/tenants/756bdfbf03b336f8863fa39595ffb7caQueryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryHuaweiIMasterTenant, and pressing the Tab key.
API Response
{
"inventories": [
{
"uuid": "4ca38813eb493b34a95f9f506c97f92d",
"name": "tenant1",
"description": "sdn for test",
"fabricIds": [
"5c9a525042c53d559350692d45de92b3"
]
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | Whether the operation succeeds. | 5.4.0 |
| inventories | List | See inventories. | 5.4.0 |
| error | ErrorCode | See error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The brief description of the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| fabricIds | String | 5.4.0 | |
| sdnControllerUuid | String | 5.4.0 | |
| deleted | Boolean | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
SDK Sample
QueryHuaweiIMasterTenantAction action = new QueryHuaweiIMasterTenantAction();
action.conditions = asList("uuid=d57c6fedabbf3a5b91e543f5cf1c9980");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHuaweiIMasterTenantAction.Result res = action.call();QueryHuaweiIMasterTenantAction action = QueryHuaweiIMasterTenantAction()
action.conditions = ["uuid=3295ba081400315ea46f1f074b850933"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHuaweiIMasterTenantAction.Result res = action.call()DeleteHuaweiIMasterVpc
API Request
DELETE zstack/v1/sdn-controller/huawei-imaster/vpcs/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vpcs/7daed678898c31968176551f0b718ab6| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.0 | |
| sdnControllerUuid | String | body | 5.4.0 | ||
| deleteMode | String | body | Optional. The deletion mode (Permissive/Enforcing, Permissive). | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
DeleteHuaweiIMasterVpcAction action = new DeleteHuaweiIMasterVpcAction();
action.uuid = "7daed678898c31968176551f0b718ab6";
action.sdnControllerUuid = "34bab7bf172633e78e54fdefdc5c0b6e";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteHuaweiIMasterVpcAction.Result res = action.call();DeleteHuaweiIMasterVpcAction action = DeleteHuaweiIMasterVpcAction()
action.uuid = "7daed678898c31968176551f0b718ab6"
action.sdnControllerUuid = "34bab7bf172633e78e54fdefdc5c0b6e"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteHuaweiIMasterVpcAction.Result res = action.call()QueryHuaweiIMasterVpc
API Request
GET zstack/v1/sdn-controller/huawei-imaster/vpcs
GET zstack/v1/sdn-controller/huawei-imaster/vpcs/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vpcs?q=uuid=94ca3286f3e43125a09243d352c9428dcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/vpcs/e1101c95aee93111bc47ce3b83727169Queryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryHuaweiIMasterVpc, and pressing the Tab key.
API Response
{
"inventories": [
{
"uuid": "1e7388c5359a3809b87bfe9c9c891061",
"name": "vpc1",
"description": "vpc for test",
"tenantId": "07b9992d75a635619bac0bac52aac5bd",
"fabricId": "a5bfb6a007c5380bb244975552fd9528"
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | Whether the operaton succeeds. | 5.4.0 |
| inventories | List | See inventories. | 5.4.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The brief description of the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| tenantId | String | The tenant ID. | 5.4.0 |
| fabricId | String | The fabric ID. | 5.4.0 |
| sdnControllerUuid | String | The SDN controller UUID. | 5.4.0 |
| deleted | Boolean | The deletion flag. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
SDK Sample
QueryHuaweiIMasterVpcAction action = new QueryHuaweiIMasterVpcAction();
action.conditions = asList("uuid=1949ad5872293963b8bc71047b5efa71");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHuaweiIMasterVpcAction.Result res = action.call();QueryHuaweiIMasterVpcAction action = QueryHuaweiIMasterVpcAction()
action.conditions = ["uuid=af61d2ecb4f93f98b0d75c7e1c3cff25"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHuaweiIMasterVpcAction.Result res = action.call()DeleteHuaweiIMasterFabric
API Request
DELETE zstack/v1/sdn-controller/huawei-imaster/fabrics/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/fabrics/1aa09d25169430c2a01ec3f1b6f1ff67| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.0 | |
| sdnControllerUuid | String | body | Optional. | 5.4.0 | |
| deleteMode | String | body | Optional. The deletion mode (Permissive/Enforcing, Permissive). | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
DeleteHuaweiIMasterFabricAction action = new DeleteHuaweiIMasterFabricAction();
action.uuid = "1aa09d25169430c2a01ec3f1b6f1ff67";
action.sdnControllerUuid = "7b50926063c439b4ba2b2da766b6dc67";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteHuaweiIMasterFabricAction.Result res = action.call();DeleteHuaweiIMasterFabricAction action = DeleteHuaweiIMasterFabricAction()
action.uuid = "1aa09d25169430c2a01ec3f1b6f1ff67"
action.sdnControllerUuid = "7b50926063c439b4ba2b2da766b6dc67"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteHuaweiIMasterFabricAction.Result res = action.call()QueryHuaweiIMasterFabric
API Request
GET zstack/v1/sdn-controller/huawei-imaster/fabrics
GET zstack/v1/sdn-controller/huawei-imaster/fabrics/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/fabrics?q=uuid=838b4d7e1c6937b08065c471fcdb5d03curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/fabrics/99e0f6310d3f3a75ad1856fff8014061Queryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryHuaweiIMasterFabric, and pressing the Tab key.
API Response
{
"inventories": [
{
"uuid": "74c62e19bc8f3792979d2d70b7af53a4",
"name": "fabric",
"description": "fabric for test"
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.0 | |
| inventories | List | Seeinventories. | 5.4.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 0.6 |
| description | String | The brief description of the error. | 0.6 |
| details | String | The brief description of the error. | 0.6 |
| elaboration | String | The reserved field. Default value: null. | 0.6 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 0.6 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| sdnControllerUuid | String | The SDN controller UUID. | 5.4.0 |
| deleted | Boolean | The deletion flag. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
SDK Sample
QueryHuaweiIMasterFabricAction action = new QueryHuaweiIMasterFabricAction();
action.conditions = asList("uuid=f9aae037a6cf38b68374e7b1c8d3e65b");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryHuaweiIMasterFabricAction.Result res = action.call();QueryHuaweiIMasterFabricAction action = QueryHuaweiIMasterFabricAction()
action.conditions = ["uuid=1b1c880dd7f43329affa520bfcbe635b"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryHuaweiIMasterFabricAction.Result res = action.call()ReconnectSdnController
API Request
PUT zstack/v1/sdn-controllers/{sdnControllerUuid}/actionsAuthorization: OAuth the-session-uuid{
"reconnectSdnController": {},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTags and userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"reconnectSdnController":{}}' http://localhost:8080/zstack/v1/sdn-controllers/911e4bc69d453bf89aae865ea6878263/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| sdnControllerUuid | String | url | 5.3.20 | ||
| systemTags | List | body | Optional. The system tags. | 5.3.20 | |
| userTags | List | body | Optional. The user tags. | 5.3.20 |
API Response
{
"inventory": {
"uuid": "65eede773d4a340681558318aabdc6a5",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | Boolean | 5.3.0 | |
| inventory | SdnControllerInventory | See inventory. | 5.3.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.20 |
| vendorType | String | 5.3.20 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 5.3.20 |
| description | String | The detailed description of the resource. | 5.3.20 |
| ip | String | 5.3.20 | |
| username | String | 5.3.20 | |
| password | String | 5.3.20 | |
| createDate | Timestamp | The creation date. | 5.3.20 |
| lastOpDate | Timestamp | The last operation date. | 5.3.20 |
| status | SdnControllerStatus | See status. | 5.3.20 |
| hostRefs | List | See hostRefs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.3.20 |
| description | String | The brief description of the error. | 5.3.20 |
| details | String | The details about the error. | 5.3.20 |
| elaboration | String | The reserved field. Default value: null. | 5.3.20 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.3.20 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.3.20 |
SDK Sample
ReconnectSdnControllerAction action = new ReconnectSdnControllerAction();
action.sdnControllerUuid = "911e4bc69d453bf89aae865ea6878263";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ReconnectSdnControllerAction.Result res = action.call();ReconnectSdnControllerAction action = ReconnectSdnControllerAction()
action.sdnControllerUuid = "911e4bc69d453bf89aae865ea6878263"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ReconnectSdnControllerAction.Result res = action.call()UpdateSdnController
API Request
PUT zstack/v1/sdn-controllers/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"updateSdnController": {
"name": "Test-Net",
"description": "Test"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTags and userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSdnController":{"name":"Test-Net","description":"Test"}}' http://localhost:8080/zstack/v1/sdn-controllers/4a39301758b13cda968bdcd866452d14/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 3.7.0 | |
| name | String | body (contained in the updateSdnController structure) | Optional. The resource name. | 3.7.0 | |
| description | String | body (contained in the updateSdnController structure) | Optional. The detailed description of the resource. | 3.7.0 | |
| systemTags | List | body | Optional. The system tags. | 3.7.0 | |
| userTags | List | body | Optional. The user tags. | 3.7.0 |
API Response
{
"inventory": {
"uuid": "722428da8bac30d2b75daa2f6cd34e9d",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.7.0 |
| inventory | SdnControllerInventory | See inventory. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 3.7.0 |
| description | String | The brief description of the error. | 3.7.0 |
| details | String | The details about the error. | 3.7.0 |
| elaboration | String | The reserved field. Default value: null. | 3.7.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 3.7.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 3.7.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 3.7.0 |
| vendorType | String | 3.7.0 | |
| vendorVersion | String | The vendor version | 5.4.0 |
| name | String | The resource name. | 3.7.0 |
| description | String | The detailed description of the resource. | 3.7.0 |
| ip | String | 3.7.0 | |
| username | String | 3.7.0 | |
| password | String | 3.7.0 | |
| createDate | Timestamp | The creation date. | 3.7.0 |
| lastOpDate | Timestamp | The last operation date. | 3.7.0 |
| status | SdnControllerStatus | See status. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
SDK Sample
UpdateSdnControllerAction action = new UpdateSdnControllerAction();
action.uuid = "4a39301758b13cda968bdcd866452d14";
action.name = "Test-Net";
action.description = "Test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSdnControllerAction.Result res = action.call();UpdateSdnControllerAction action = UpdateSdnControllerAction()
action.uuid = "4a39301758b13cda968bdcd866452d14"
action.name = "Test-Net"
action.description = "Test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSdnControllerAction.Result res = action.call()PullHuaweiIMasterController
API Request
PUT zstack/v1/sdn-controller/huawei-imaster/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"pullHuaweiIMasterController": {
"pullSwitch": false
},
"systemTags": [],
"userTags": []
}
Note: In the proceding sample, both
systemTagsand userTags are optional.These two fields can be
included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"pullHuaweiIMasterController":{"pullSwitch":false}}' http://localhost:8080/zstack/v1/sdn-controller/huawei-imaster/10b101c6b2583c1ab6a08c4ea6962d6a/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | Optional. The resource UUID. | 5.4.0 | |
| pullSwitch | boolean | body (contained in thepullHuaweiIMasterController structure) | Optional. Whether to pull the switch information. | 5.4.0 | |
| systemTags | List | body | Optional. The system tags. | 5.4.0 | |
| userTags | List | body | Optional. The user tags. | 5.4.0 |
API Response
{
"inventories": []
}| Name | Type | Description | Starting version |
|---|---|---|---|
| success | boolean | 5.4.0 | |
| inventories | List | See inventories. | 5.4.0 |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| vendorType | String | 5.4.0 | |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| ip | String | 5.4.0 | |
| username | String | 5.4.0 | |
| password | String | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| fabrics | List | See fabrics. | 5.4.0 |
| tenants | List | See tenants. | 5.4.0 |
| vpcs | List | See vpcs. | 5.4.0 |
| vrouters | List | See vrouters. | 5.4.0 |
| status | SdnControllerStatus | See status. | 5.4.0 |
| vniRanges | List | See vniRanges. | 5.4.0 |
| vxlanPools | List | See vxlanPools. | 5.4.0 |
| hostRefs | List | See hostRefs. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| sdnControllerUuid | String | The SDN controller UUID. | 5.4.0 |
| deleted | Boolean | The deletion flag. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| fabricIds | String | 5.4.0 | |
| sdnControllerUuid | String | 5.4.0 | |
| deleted | Boolean | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| tenantId | String | The tenant ID. | 5.4.0 |
| fabricId | String | The fabric ID. | 5.4.0 |
| sdnControllerUuid | String | The SDN controller UUID. | 5.4.0 |
| deleted | Boolean | The deletion flag. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| logicalNetworkId | String | 5.4.0 | |
| tenantId | String | 5.4.0 | |
| fabricUuid | String | 5.4.0 | |
| deleted | Boolean | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.4.0 |
| Connected | SdnControllerStatus | Connected. | 5.4.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| startVni | Integer | 5.4.0 | |
| endVni | Integer | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | 5.4.0 | |
| attachedCidrs | Map | 5.4.0 | |
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| zoneUuid | String | The zone UUID. | 5.4.0 |
| physicalInterface | String | 5.4.0 | |
| type | String | 5.4.0 | |
| vSwitchType | String | 5.4.0 | |
| virtualNetworkId | Integer | 5.4.0 | |
| isolated | Boolean | 5.4.0 | |
| pvlan | String | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| attachedClusterUuids | List | 5.4.0 | |
| attachedVtepRefs | List | See attachedVtepRefs. | 5.4.0 |
| remoteVteps | List | See remoteVteps. | 5.4.0 |
| attachedVxlanNetworkRefs | List | See attachedVxlanNetworkRefs. | 5.4.0 |
| attachedVniRanges | List | See attachedVniRanges. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| hostUuid | String | The host UUID. | 5.4.0 |
| vtepIp | String | 5.4.0 | |
| port | Integer | 5.4.0 | |
| type | String | 5.4.0 | |
| physicalInterface | String | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| poolUuid | String | The VXLAN pool UUID. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| clusterUuid | String | The cluster UUID. | 5.4.0 |
| vtepIp | String | The VXLAN Tunnel Endpoint. | 5.4.0 |
| port | Integer | The port. | 5.4.0 |
| type | String | The type. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| poolUuid | String | The UUID of the VXLAN resource pool. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| vni | Integer | The VNI number. | 5.4.0 |
| poolUuid | String | The VXLAN pool UUID. | 5.4.0 |
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description or the resource. | 5.4.0 |
| zoneUuid | String | The zone UUID. | 5.4.0 |
| physicalInterface | String | The physical NIC. | 5.4.0 |
| type | String | The L2 network type. | 5.4.0 |
| vSwitchType | String | 5.4.0 | |
| virtualNetworkId | Integer | 5.4.0 | |
| isolated | Boolean | 5.4.0 | |
| pvlan | String | 5.4.0 | |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| attachedClusterUuids | List | The attached cluster UUID list. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.4.0 |
| name | String | The resource name. | 5.4.0 |
| description | String | The detailed description of the resource. | 5.4.0 |
| startVni | Integer | The start VNI. | 5.4.0 |
| endVni | Integer | The end VNI. | 5.4.0 |
| createDate | Timestamp | The creation date. | 5.4.0 |
| lastOpDate | Timestamp | The last operation date. | 5.4.0 |
| l2NetworkUuid | String | The L2 network UUID. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The resource UUID. | 5.4.0 |
| hostUuid | String | The physical server UUID. | 5.4.0 |
| vSwitchType | String | The virtual switch type. | 5.4.0 |
| vtepIp | String | The physical server VTEP IP address. | 5.4.0 |
| nicPciAddresses | String | The mapping of physical NICs to PCI addresses. | 5.4.0 |
| nicDrivers | String | The mapping of physical NICs to driver types. | 5.4.0 |
| netmask | String | The netmask of the physical server's VTEP IP. | 5.4.0 |
| bondMode | String | The bonding mode of the physical NICs. | 5.4.0 |
| lacpMode | String | The LACP mode of the physical NICs. | 5.4.0 |
SDK Sample
PullHuaweiIMasterControllerAction action = new PullHuaweiIMasterControllerAction();
action.uuid = "10b101c6b2583c1ab6a08c4ea6962d6a";
action.pullSwitch = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
PullHuaweiIMasterControllerAction.Result res = action.call();PullHuaweiIMasterControllerAction action = PullHuaweiIMasterControllerAction()
action.uuid = "10b101c6b2583c1ab6a08c4ea6962d6a"
action.pullSwitch = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
PullHuaweiIMasterControllerAction.Result res = action.call()SdnControllerAddHost
API Request
POST zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST http://localhost:8080/zstack/v1/sdn-controllers/13dced0afb8d3bb4ad238eb476eca64e/hosts/1f4e13ef459c39968a10f79cc5905ea4| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| sdnControllerUuid | String | url | The SDN controller UUID. | 5.3.0 | |
| hostUuid | String | url | The host UUID. | 5.3.0 | |
| vSwitchType | String | body | Optional. The virtual switch type. |
|
5.3.0 |
| nicNames | List | body | The name list of physical server's NICs. | 5.3.0 | |
| vtepIp | String | body | Optional. The physical server's VTEP IP. | 5.3.0 | |
| systemTags | List | body | Optional. The system tags. | 5.3.0 | |
| userTags | List | body | Optional. The user tags. | 5.3.0 | |
| netmask | String | body | Optional. The physical server's VTEP IP netmask. | 5.3.0 | |
| bondMode | String | body | Optional. The physical server's NIC bond mode. | 5.3.0 | |
| lacpMode | String | body | Optional. The physical server's NIC LACP mode. | 5.3.0 |
API Response
{
"inventory": {
"uuid": "2b317c278d253df6bab1acd9b293d957",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.3.0 | |
| inventory | SdnControllerInventory | See inventory. | 5.3.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.0 |
| vendorType | String | 5.3.0 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 5.3.0 |
| description | String | Optional. The detailed description of the resource. | 5.3.0 |
| ip | String | 5.3.0 | |
| username | String | 5.3.0 | |
| password | String | 5.3.0 | |
| createDate | Timestamp | The creation date. | 5.3.0 |
| lastOpDate | Timestamp | The last operation date. | 5.3.0 |
| status | SdnControllerStatus | See status. | 5.3.0 |
| hostRefs | List | See hostRefs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.3.0 |
| description | String | The brief description of the error. | 5.3.0 |
| details | String | The details about the error. | 5.3.0 |
| elaboration | String | The reserved field. Default value: null. | 5.3.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.3.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.3.0 |
SDK Sample
SdnControllerAddHostAction action = new SdnControllerAddHostAction();
action.sdnControllerUuid = "13dced0afb8d3bb4ad238eb476eca64e";
action.hostUuid = "1f4e13ef459c39968a10f79cc5905ea4";
action.vSwitchType = "H3C VCFC";
action.vtepIp = "192.168.1.101";
action.netmask = "ens1 ens2";
action.bondMode = "active-backup";
action.lacpMode = "off";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SdnControllerAddHostAction.Result res = action.call();SdnControllerAddHostAction action = SdnControllerAddHostAction()
action.sdnControllerUuid = "13dced0afb8d3bb4ad238eb476eca64e"
action.hostUuid = "1f4e13ef459c39968a10f79cc5905ea4"
action.vSwitchType = "H3C VCFC"
action.vtepIp = "192.168.1.101"
action.netmask = "ens1 ens2"
action.bondMode = "active-backup"
action.lacpMode = "off"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SdnControllerAddHostAction.Result res = action.call()SdnControllerChangeHost
API Request
PUT zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}/actionsAuthorization: OAuth the-session-uuid{
"sdnControllerChangeHost": {
"vSwitchType": "H3C VCFC",
"vtepIp": "192.168.1.101",
"netmask": "ens1 ens2",
"bondMode": "active-backup",
"lacpMode": "off"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTags and userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"sdnControllerChangeHost":{"vSwitchType":"H3C VCFC","vtepIp":"192.168.1.101","netmask":"ens1 ens2","bondMode":"active-backup","lacpMode":"off"}}' http://localhost:8080/zstack/v1/sdn-controllers/51a894d84f22366eb0ff853748f7cb1d/hosts/772b68aff57f3bbb82c40d569d6bc76a/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| sdnControllerUuid | String | url | The SDN controller UUID. | 5.3.0 | |
| hostUuid | String | url | The host UUID. | 5.3.0 | |
| vSwitchType | String | body (contained in thesdnControllerChangeHoststructure) | Optional. The virtual switch type. |
|
5.3.0 |
| nicNames | List | body (contained in thesdnControllerChangeHoststructure) | Optional. The list of physical server's nic names. | 5.3.0 | |
| vtepIp | String | body (contained in the sdnControllerChangeHoststructure) | Optional. The physical server's VTEP IP. | 5.3.0 | |
| netmask | String | body (contained in thesdnControllerChangeHoststructure) | Optional. The physical server's VTEP IP netmask. | 5.3.0 | |
| bondMode | String | body (contained in thesdnControllerChangeHoststructure) | Optional. The physical server's bond mode. | 5.3.0 | |
| lacpMode | String | body(containted in thesdnControllerChangeHoststructure) | Optional. The physical server's LACP mode. | 5.3.0 | |
| systemTags | List | body | Optional. The system tags. | 5.3.0 | |
| userTags | List | body | Optional. The user tags. | 5.3.0 |
API Response
{
"inventory": {
"uuid": "b2d35464d0db3362b605c1e79814f237",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.3.0 | |
| inventory | SdnControllerInventory | Seeinventory. | 5.3.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.0 |
| vendorType | String | 5.3.0 | |
| vendorVersion | String | The vendor version. | 5.4.0 |
| name | String | The resource name. | 5.3.0 |
| description | String | The detailed description of the resource. | 5.3.0 |
| ip | String | 5.3.0 | |
| username | String | 5.3.0 | |
| password | String | 5.3.0 | |
| createDate | Timestamp | The creation date. | 5.3.0 |
| lastOpDate | Timestamp | The last operation date. | 5.3.0 |
| status | SdnControllerStatus | See status. | 5.3.0 |
| hostRefs | List | See hostRefs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.3.0 |
| description | String | The brief description of the error. | 5.3.0 |
| details | String | The details about the error. | 5.3.0 |
| elaboration | String | The reserved field. Default value: null. | 5.3.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.3.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.3.0 |
SDK Sample
SdnControllerChangeHostAction action = new SdnControllerChangeHostAction();
action.sdnControllerUuid = "51a894d84f22366eb0ff853748f7cb1d";
action.hostUuid = "772b68aff57f3bbb82c40d569d6bc76a";
action.vSwitchType = "H3C VCFC";
action.vtepIp = "192.168.1.101";
action.netmask = "ens1 ens2";
action.bondMode = "active-backup";
action.lacpMode = "off";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SdnControllerChangeHostAction.Result res = action.call();SdnControllerChangeHostAction action = SdnControllerChangeHostAction()
action.sdnControllerUuid = "51a894d84f22366eb0ff853748f7cb1d"
action.hostUuid = "772b68aff57f3bbb82c40d569d6bc76a"
action.vSwitchType = "H3C VCFC"
action.vtepIp = "192.168.1.101"
action.netmask = "ens1 ens2"
action.bondMode = "active-backup"
action.lacpMode = "off"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SdnControllerChangeHostAction.Result res = action.call()SdnControllerRemoveHost
API Request
DELETE zstack/v1/sdn-controllers/{sdnControllerUuid}/hosts/{hostUuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sdn-controllers/2adbaedc05a03129bd055ba7a3f045cc/hosts/1fb1da4d101335b2b981f0b107ac7ba8| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| sdnControllerUuid | String | url | The SDN controller UUID. | 5.3.0 | |
| hostUuid | String | url | The host UUID. | 5.3.0 | |
| vSwitchType | String | body | The virtual switch type. |
|
5.3.0 |
| systemTags | List | body | Optional. The system tags. | 5.3.0 | |
| userTags | List | body | Optional. The user tags. | 5.3.0 |
API Response
{
"inventory": {
"uuid": "5aedd20ff2883bca8bdcc0dd7a46e779",
"vendorType": "H3C VCFC",
"name": "sdn-1",
"description": "sdn controller from vendor",
"ip": "192.168.1.1",
"username": "admin",
"password": "password"
}
}
| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.3.0 | |
| inventory | SdnControllerInventory | Seeinventory. | 5.3.0 |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.0 |
| vendorType | String | 5.3.0 | |
| vendorVersion | String | The vendor type. | 5.4.0 |
| name | String | The resource name. | 5.3.0 |
| description | String | The detailed description of the resource. | 5.3.0 |
| ip | String | 5.3.0 | |
| username | String | 5.3.0 | |
| password | String | 5.3.0 | |
| createDate | Timestamp | The creation date. | 5.3.0 |
| lastOpDate | Timestamp | The last operation date. | 5.3.0 |
| status | SdnControllerStatus | See status. | 5.3.0 |
| hostRefs | List | See hostRefs. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Connecting | SdnControllerStatus | Connecting. | 5.3.0 |
| Connected | SdnControllerStatus | Connected. | 5.3.0 |
| Disconnected | SdnControllerStatus | Disconnected. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| sdnControllerUuid | String | The SDN controller UUID. | 5.3.0 |
| hostUuid | String | The host UUID. | 5.3.0 |
| vSwitchType | String | The virtual switch type. | 5.3.0 |
| vtepIp | String | The VTEP IP. | 5.3.0 |
| nicPciAddresses | String | The NIC PCI address mapping. | 5.3.0 |
| nicDrivers | String | The NIC driver mapping. | 5.3.0 |
| netmask | String | The VTEP IP netmask. | 5.3.0 |
| bondMode | String | The NIC bond mode. | 5.3.0 |
| lacpMode | String | The NIC LACP mode. | 5.3.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.3.0 |
| description | String | The brief description of the error. | 5.3.0 |
| details | String | The details about the error. | 5.3.0 |
| elaboration | String | The reserved field. Default value: null. | 5.3.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.3.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.3.0 |
SDK Sample
SdnControllerRemoveHostAction action = new SdnControllerRemoveHostAction();
action.sdnControllerUuid = "2adbaedc05a03129bd055ba7a3f045cc";
action.hostUuid = "1fb1da4d101335b2b981f0b107ac7ba8";
action.vSwitchType = "OvnDpdk";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SdnControllerRemoveHostAction.Result res = action.call();SdnControllerRemoveHostAction action = SdnControllerRemoveHostAction()
action.sdnControllerUuid = "2adbaedc05a03129bd055ba7a3f045cc"
action.hostUuid = "1fb1da4d101335b2b981f0b107ac7ba8"
action.vSwitchType = "OvnDpdk"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SdnControllerRemoveHostAction.Result res = action.call()CreateOvnControllerOffering
API Request
POST zstack/v1/instance-offerings/ovnAuthorization: OAuth the-session-uuid{
"params": {
"zoneUuid": "9ea522ec01fc3da286fa47b8a60a0824",
"managementNetworkUuid": "3302e9bed4e33ab68912cf3d75fcc749",
"imageUuid": "c2e0cc0faa713de795a079ad7b6470d0",
"name": "ovn-Offering",
"cpuNum": 2,
"memorySize": 1024,
"reservedMemorySize": 0,
"sortKey": 0,
"type": "Ovn"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTags and userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"zoneUuid":"9ea522ec01fc3da286fa47b8a60a0824","managementNetworkUuid":"3302e9bed4e33ab68912cf3d75fcc749","imageUuid":"c2e0cc0faa713de795a079ad7b6470d0","name":"ovn-Offering","cpuNum":2,"memorySize":1024,"reservedMemorySize":0,"sortKey":0,"type":"Ovn"}}' http://localhost:8080/zstack/v1/instance-offerings/ovn| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| zoneUuid | String | body (contained in theparamsstructure) | The zone UUID. | 5.3.0 | |
| managementNetworkUuid | String | body (contained in theparamsstructure) | The management network UUID. | 5.3.0 | |
| imageUuid | String | body (contained in theparamsstructure) | The image UUID. | 5.3.0 | |
| name | String | body (contained in theparamsstructure) | The offering name. | 5.3.0 | |
| description | String | body (contained in theparamsstructure) | Optional. The detailed description of the resource. | 5.3.0 | |
| cpuNum | int | body (contained in theparamsstructure) | The CPU number. | 5.3.0 | |
| memorySize | long | body (contained in theparamsstructure) | The memory size in Byte. | 5.3.0 | |
| reservedMemorySize | long | body (contained in theparamsstructure) | Optional. | 5.3.0 | |
| allocatorStrategy | String | body (contained in theparamsstructure) | Optional. The allocation strategy. | 5.3.0 | |
| sortKey | int | body (contained in theparamsstructure) | Optional. | 5.3.0 | |
| type | String | body (contained in theparamsstructure) | Optional. | 5.3.0 | |
| resourceUuid | String | body (contained in theparamsstructure) | Optional. The resource UUID. | 5.3.0 | |
| tagUuids | List | body (contained in theparamsstructure) | Optional. The tag UUID. | 5.3.0 | |
| systemTags | List | body | Optional. The system tags. | 5.3.0 | |
| userTags | List | body | Optional. The user tags. | 5.3.0 |
API Response
{
"inventory": {
"uuid": "3b0af4671cc93f619ef326a3c99d825c",
"name": "instanceOffering1",
"cpuNum": 2,
"cpuSpeed": 1,
"type": "UserVm",
"allocatorStrategy": "Mevoco",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM",
"state": "Enabled"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | Boolean | 5.3.20 | |
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 5.3.20 |
| inventory | InstanceOfferingInventory | Seeinventory. | 5.3.20 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.3.20 |
| description | String | The brief description of the error. | 5.3.20 |
| details | String | The details about the error. | 5.3.20 |
| elaboration | String | The reserved field. Default value: null. | 5.3.20 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.3.20 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.3.20 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.3.20 |
| name | String | The resource name. | 5.3.20 |
| description | String | Optional. The detailed description of the resource. | 5.3.20 |
| cpuNum | Integer | The CPU number. | 5.3.20 |
| cpuSpeed | Integer | The CPU speed. | 5.3.20 |
| memorySize | Long | The memory size. | 5.3.20 |
| type | String | The type. | 5.3.20 |
| allocatorStrategy | String | The allocation strategy. | 5.3.20 |
| sortKey | Integer | 5.3.20 | |
| createDate | Timestamp | The creation date. | 5.3.20 |
| lastOpDate | Timestamp | The last operation date. | 5.3.20 |
| state | String | The state. | 5.3.20 |
SDK Sample
CreateOvnControllerOfferingAction action = new CreateOvnControllerOfferingAction();
action.zoneUuid = "9ea522ec01fc3da286fa47b8a60a0824";
action.managementNetworkUuid = "3302e9bed4e33ab68912cf3d75fcc749";
action.imageUuid = "c2e0cc0faa713de795a079ad7b6470d0";
action.name = "ovn-Offering";
action.cpuNum = 2;
action.memorySize = 1024;
action.reservedMemorySize = 0;
action.sortKey = 0;
action.type = "Ovn";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateOvnControllerOfferingAction.Result res = action.call();CreateOvnControllerOfferingAction action = CreateOvnControllerOfferingAction()
action.zoneUuid = "9ea522ec01fc3da286fa47b8a60a0824"
action.managementNetworkUuid = "3302e9bed4e33ab68912cf3d75fcc749"
action.imageUuid = "c2e0cc0faa713de795a079ad7b6470d0"
action.name = "ovn-Offering"
action.cpuNum = 2
action.memorySize = 1024
action.reservedMemorySize = 0
action.sortKey = 0
action.type = "Ovn"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateOvnControllerOfferingAction.Result res = action.call()CreateNfvInstOffering
API Request
POST zstack/v1/instance-offerings/nfvinstAuthorization: OAuth the-session-uuid{
"params": {
"zoneUuid": "4e805d7b14bd3f14a91f94775beb12c9",
"managementNetworkUuid": "8517112e29f13eac8470f918baac3edd",
"imageUuid": "3db251b909a13775a8c80f6b76b34f0c",
"name": "DEDICATED-SLB-Offering",
"cpuNum": 2,
"memorySize": 1024,
"reservedMemorySize": 0,
"sortKey": 0
},
"systemTags": [],
"userTags": []
}
Note: In the preceding sample, both systemTagsand
userTags are optional.These two fields can be included in the body
structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"zoneUuid":"4e805d7b14bd3f14a91f94775beb12c9","managementNetworkUuid":"8517112e29f13eac8470f918baac3edd","imageUuid":"3db251b909a13775a8c80f6b76b34f0c","name":"DEDICATED-SLB-Offering","cpuNum":2,"memorySize":1024,"reservedMemorySize":0,"sortKey":0}}' \
http://localhost:8080/zstack/v1/instance-offerings/nfvinst| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| zoneUuid | String | body(contained in the paramsstructure) | The zone UUID. | 0.6 | |
| managementNetworkUuid | String | body(contained in the paramsstructure) | 0.6 | ||
| imageUuid | String | body(contained in the paramsstructure) | The image UUID. | 0.6 | |
| name | String | body(contained in the paramsstructure) | The resource name. | 0.6 | |
| description | String | body(contained in the paramsstructure) | Optional. The detailed description of the resource. | 0.6 | |
| cpuNum | int | body(contained in the paramsstructure) | 0.6 | ||
| memorySize | long | body(contained in the paramsstructure) | 0.6 | ||
| allocatorStrategy | String | body(contained in the paramsstructure) | Optional. | 0.6 | |
| sortKey | int | body(contained in the paramsstructure) | Optional. | 0.6 | |
| type | String | body(contained in the paramsstructure) | Optional. | 0.6 | |
| resourceUuid | String | body(contained in the paramsstructure) | Optional. The resource UUID. | 0.6 | |
| tagUuids | List | body(contained in the paramsstructure) | Optional. The list of tag UUIDs. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 | |
| reservedMemorySize | long | body(contained in the paramsstructure) | Optional. | 5.4.2 |
API Response
{
"inventory": {
"uuid": "3b0af4671cc93f619ef326a3c99d825c",
"name": "instanceOffering1",
"cpuNum": 2,
"cpuSpeed": 1,
"type": "UserVm",
"allocatorStrategy": "Mevoco",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM",
"state": "Enabled"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | InstanceOfferingInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 0.6 |
| name | String | The resource name. | 0.6 |
| description | String | Optional. The detailed description of the resource. | 0.6 |
| cpuNum | Integer | The CPU number. | 0.6 |
| cpuSpeed | Integer | The CPU speed. | 0.6 |
| memorySize | Long | The memory size. | 0.6 |
| type | String | The type. | 0.6 |
| allocatorStrategy | String | The allocation strategy. | 0.6 |
| sortKey | Integer | 0.6 | |
| createDate | Timestamp | The creation date. | 0.6 |
| lastOpDate | Timestamp | The last operation date. | 0.6 |
| state | String | The status (Enabled, Disabled). | 0.6 |
SDK Sample
CreateNfvInstOfferingAction action = new CreateNfvInstOfferingAction();
action.zoneUuid = "4e805d7b14bd3f14a91f94775beb12c9";
action.managementNetworkUuid = "8517112e29f13eac8470f918baac3edd";
action.imageUuid = "3db251b909a13775a8c80f6b76b34f0c";
action.name = "DEDICATED-SLB-Offering";
action.cpuNum = 2;
action.memorySize = 1024;
action.reservedMemorySize = 0;
action.sortKey = 0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateNfvInstOfferingAction.Result res = action.call();CreateNfvInstOfferingAction action = CreateNfvInstOfferingAction()
action.zoneUuid = "4e805d7b14bd3f14a91f94775beb12c9"
action.managementNetworkUuid = "8517112e29f13eac8470f918baac3edd"
action.imageUuid = "3db251b909a13775a8c80f6b76b34f0c"
action.name = "DEDICATED-SLB-Offering"
action.cpuNum = 2
action.memorySize = 1024
action.reservedMemorySize = 0
action.sortKey = 0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateNfvInstOfferingAction.Result res = action.call()CreateNfvInst
API Request
POST zstack/v1/nfvinstgroup/instAuthorization: OAuth the-session-uuid{
"params": {
"name": "NfvInst",
"nfvInstGroupUuid": "ebd1efff3ce534129170d32bcb7a8a1b",
"description": "this is a nfv inst for test"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \-X POST -d '{"params":{"name":"NfvInst","nfvInstGroupUuid":"ebd1efff3ce534129170d32bcb7a8a1b","description":"this is a nfv inst for test"}}' \ \
http://localhost:8080/zstack/v1/nfvinstgroup/inst| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| name | String | body(contained in the paramsstructure) | The resource name. | 0.6 | |
| nfvInstGroupUuid | String | body(contained in the paramsstructure) | 0.6 | ||
| description | String | body(contained in the paramsstructure) | Optional. The detailed description of the resource. | 0.6 | |
| zoneUuid | String | body(contained in the paramsstructure) | Optional. The zone UUID. | 0.6 | |
| clusterUuid | String | body(contained in the paramsstructure) | Optional. The cluster UUID. | 0.6 | |
| hostUuid | String | body(contained in the paramsstructure) | Optional. The host UUID. | 0.6 | |
| resourceUuid | String | body(contained in the paramsstructure) | Optional. The resource UUID. | 0.6 | |
| tagUuids | List | body(contained in the paramsstructure) | Optional. The list of tag UUIDs. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
{
"inventory": {
"configVersion": 0
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | NfvInstInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| imageUuid | String | The image Uuid. | 5.4.2 |
| hostUuid | String | The host Uuid. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 5.4.2 |
| rootVolumeUuid | String | The root volume Uuid. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
SDK Sample
CreateNfvInstAction action = new CreateNfvInstAction();
action.name = "NfvInst";
action.nfvInstGroupUuid = "ebd1efff3ce534129170d32bcb7a8a1b";
action.description = "this is a nfv inst for test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateNfvInstAction.Result res = action.call();CreateNfvInstAction action = CreateNfvInstAction()
action.name = "NfvInst"
action.nfvInstGroupUuid = "ebd1efff3ce534129170d32bcb7a8a1b"
action.description = "this is a nfv inst for test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateNfvInstAction.Result res = action.call()AttachNfvInstToGroup
API Request
PUT zstack/v1/nfvinstgroup/group/{groupUuid}/instances/{nfvInstUuid}/actionsAuthorization: OAuth the-session-uuid{
"attachNfvInstToGroup": {},
"systemTags": [],
"userTags": []
}
Note: In the preceding sample, both systemTagsand userTags are
optional.These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"attachNfvInstToGroup":{}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/567d546382d33bd2b44b4b52f7109896/instances/5d9126e217473805b351c309279ee492/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| groupUuid | String | url | 5.4.2 | ||
| nfvInstUuid | String | url | 5.4.2 | ||
| systemTags | List | body | Optional. The system tags. | 5.4.2 | |
| userTags | List | body | Optional. The user tags. | 5.4.2 |
API Response
{
"inventory": {
"name": "ovn-controller-group",
"uuid": "7f45e412407e3d66b967c74b10380d04",
"description": "OVN SDN Controller HA Group",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.2 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error.. | 5.4.2 |
| inventory | NfvInstGroupInventory | See inventory.. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource UUID. | 5.4.2 |
| description | String | The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | The VIP UUID. | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage UUID. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource UUID. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| imageUuid | String | The image UUID. | 5.4.2 |
| hostUuid | String | The host UUID. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering UUID. | 5.4.2 |
| rootVolumeUuid | String | The root volume UUID. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network UUID. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
AttachNfvInstToGroupAction action = new AttachNfvInstToGroupAction();
action.groupUuid = "567d546382d33bd2b44b4b52f7109896";
action.nfvInstUuid = "5d9126e217473805b351c309279ee492";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachNfvInstToGroupAction.Result res = action.call();AttachNfvInstToGroupAction action = AttachNfvInstToGroupAction()
action.groupUuid = "567d546382d33bd2b44b4b52f7109896"
action.nfvInstUuid = "5d9126e217473805b351c309279ee492"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachNfvInstToGroupAction.Result res = action.call()DetachNfvInstFromGroup
API Request
PUT zstack/v1/nfvinstgroup/group/{groupUuid}/instances/{nfvInstUuid}/actionsAuthorization: OAuth the-session-uuid{
"detachNfvInstFromGroup": {},
"systemTags": [],
"userTags": []
}
Note:
In the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure. curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"detachNfvInstFromGroup":{}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/ac8a5781ccce3f099a7d99676f4bf518/instances/887cc8c54cfd3b9e8b58ec5e310a7bb0/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| groupUuid | String | url | 5.4.2 | ||
| nfvInstUuid | String | url | 5.4.2 | ||
| systemTags | List | body | Optional. The system tags. | 5.4.2 | |
| userTags | List | body | Optional. The user tags. | 5.4.2 |
API Response
{
"inventory": {
"name": "ovn-controller-group",
"uuid": "e2c651d088a33695b8013aa49bba833c",
"description": "OVN SDN Controller HA Group",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.2 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.2 |
| inventory | NfvInstGroupInventory | See inventory. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource Uuid. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage Uuid. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| imageUuid | String | The image UUID. | 5.4.2 |
| hostUuid | String | The host UUID. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering UUID. | 5.4.2 |
| rootVolumeUuid | String | The root volume UUID. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
DetachNfvInstFromGroupAction action = new DetachNfvInstFromGroupAction();
action.groupUuid = "ac8a5781ccce3f099a7d99676f4bf518";
action.nfvInstUuid = "887cc8c54cfd3b9e8b58ec5e310a7bb0";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachNfvInstFromGroupAction.Result res = action.call();DetachNfvInstFromGroupAction action = DetachNfvInstFromGroupAction()
action.groupUuid = "ac8a5781ccce3f099a7d99676f4bf518"
action.nfvInstUuid = "887cc8c54cfd3b9e8b58ec5e310a7bb0"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachNfvInstFromGroupAction.Result res = action.call()ReconnectNfvInst
API Request
PUT zstack/v1/vm-instances/appliances/nfvinst/{vmInstanceUuid}/actionsAuthorization: OAuth the-session-uuid{
"reconnectNfvInst": {},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"reconnectNfvInst":{}}' \
http://localhost:8080/zstack/v1/vm-instances/appliances/nfvinst/88eff88e87e63114a614f8d7ef6fee60/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| vmInstanceUuid | String | url | The VM instance Uuid. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
{
"inventory": {
"managementNetworkUuid": "47ba3309aba3352f9c0f2abd2168f9f6",
"name": "Test-NfvInst",
"description": "this is a nfv vm",
"clusterUuid": "711ef65a8dab345bad1e456b3585f155",
"imageUuid": "d0ee9f7493c332a6824007bccf785852",
"instanceOfferingUuid": "dae6bdd8a3a83d63ae36bce0d5704afa"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | ApplianceVmInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| applianceVmType | String | 0.6 | |
| managementNetworkUuid | String | 0.6 | |
| defaultRouteL3NetworkUuid | String | 0.6 | |
| status | String | 0.6 | |
| agentPort | Integer | 0.6 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 0.6 |
| name | String | The resource name. | 0.6 |
| description | String | Optional. The detailed description of the resource. | 0.6 |
| zoneUuid | String | The zone UUID. | 0.6 |
| clusterUuid | String | The cluster UUID. | 0.6 |
| imageUuid | String | The image UUID. | 0.6 |
| hostUuid | String | The host UUID. | 0.6 |
| lastHostUuid | String | 0.6 | |
| instanceOfferingUuid | String | The instance offering UUID. | 0.6 |
| rootVolumeUuid | String | The root volume UUID. | 0.6 |
| platform | String | 0.6 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 0.6 | |
| type | String | 0.6 | |
| hypervisorType | String | 0.6 | |
| memorySize | Long | 0.6 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 0.6 | |
| cpuSpeed | Long | 0.6 | |
| allocatorStrategy | String | 0.6 | |
| createDate | Timestamp | The creation date. | 0.6 |
| lastOpDate | Timestamp | The last operation date. | 0.6 |
| state | String | 0.6 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 0.6 |
| allVolumes | List | See allVolumes. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| vmInstanceUuid | String | The VM instance UUID. | 4.7.13 |
| l3NetworkUuid | String | The L3 network UUID. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedlps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.0.0 |
| ipRangeUuid | String | The IP range UUID. | 5.0.0 |
| l3NetworkUuid | String | The L3 network UUID. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC UUID. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage UUID. | 4.7.13 |
| vmInstanceUuid | String | The VM instance UUID. | 4.7.13 |
| diskOfferingUuid | String | The disk offering UUID. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
SDK Sample
ReconnectNfvInstAction action = new ReconnectNfvInstAction();
action.vmInstanceUuid = "88eff88e87e63114a614f8d7ef6fee60";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ReconnectNfvInstAction.Result res = action.call();ReconnectNfvInstAction action = ReconnectNfvInstAction()
action.vmInstanceUuid = "88eff88e87e63114a614f8d7ef6fee60"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ReconnectNfvInstAction.Result res = action.call()ProvisionNfvInstConfig
API Request
PUT zstack/v1/vm-instances/appliances/nfvinst/{vmInstanceUuid}/provisionAuthorization: OAuth the-session-uuid{
"provisionNfvInstConfig": {},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are
optional.These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"provisionNfvInstConfig":{}}' \
http://localhost:8080/zstack/v1/vm-instances/appliances/nfvinst/8dcbeddb685a30f5aea4d03b2bb97bf4/provision| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| vmInstanceUuid | String | url | The VM instance Uuid. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
{
"inventory": {
"managementNetworkUuid": "7e02d6549e333ee28bf03ce6a1cf88ab",
"name": "Test-NfvInst",
"description": "this is a nfv inst vm",
"clusterUuid": "486d257fe1fc3a3ba4b84383fa6debb9",
"imageUuid": "2f382f1546d534319d31f1473ddd682b",
"instanceOfferingUuid": "62b777323fce30648d39ba2c061a64e0"
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | ApplianceVmInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| applianceVmType | String | 0.6 | |
| managementNetworkUuid | String | 0.6 | |
| defaultRouteL3NetworkUuid | String | 0.6 | |
| status | String | 0.6 | |
| agentPort | Integer | 0.6 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 0.6 |
| name | String | The resource name. | 0.6 |
| description | String | Optional. The detailed description of the resource. | 0.6 |
| zoneUuid | String | The zone Uuid. | 0.6 |
| clusterUuid | String | The cluster Uuid. | 0.6 |
| imageUuid | String | The image Uuid. | 0.6 |
| hostUuid | String | The host Uuid. | 0.6 |
| lastHostUuid | String | 0.6 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 0.6 |
| rootVolumeUuid | String | The root volume Uuid. | 0.6 |
| platform | String | 0.6 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 0.6 | |
| type | String | 0.6 | |
| hypervisorType | String | 0.6 | |
| memorySize | Long | 0.6 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 0.6 | |
| cpuSpeed | Long | 0.6 | |
| allocatorStrategy | String | 0.6 | |
| createDate | Timestamp | The creation date. | 0.6 |
| lastOpDate | Timestamp | The last operation date. | 0.6 |
| state | String | 0.6 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 0.6 |
| allVolumes | List | See allVolumes. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network UUID. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 5.0.0 |
| ipRangeUuid | String | The IP range UUID. | 5.0.0 |
| l3NetworkUuid | String | The L3 network UUID. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC UUID. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
SDK Sample
ProvisionNfvInstConfigAction action = new ProvisionNfvInstConfigAction();
action.vmInstanceUuid = "8dcbeddb685a30f5aea4d03b2bb97bf4";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ProvisionNfvInstConfigAction.Result res = action.call();ProvisionNfvInstConfigAction action = ProvisionNfvInstConfigAction()
action.vmInstanceUuid = "8dcbeddb685a30f5aea4d03b2bb97bf4"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ProvisionNfvInstConfigAction.Result res = action.call()CreateNfvInstGroup
API Request
POST zstack/v1/nfvinstgroup/groupAuthorization: OAuth the-session-uuid{
"params": {
"name": "nfvInstGroup",
"instType": "KVM",
"funcType": "DEDICATED_SLB"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"nfvInstGroup","instType":"KVM","funcType":"DEDICATED_SLB"}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| name | String | body(contained in the paramsstructure) | The resource name. | 0.6 | |
| description | String | body(contained in the paramsstructure) | Optional. The detailed description of the resource. | 0.6 | |
| instType | String | body(contained in the paramsstructure) |
|
0.6 | |
| funcType | String | body(contained in the paramsstructure) |
|
0.6 | |
| monitorIps | List | body(contained in the paramsstructure) | Optional. | 0.6 | |
| nfvInstOfferingUuid | String | body(contained in the paramsstructure) | 0.6 | ||
| frontEndL3NetworkUuid | String | body(contained in the paramsstructure) | Optional. | 0.6 | |
| backendL3NetworkUuids | List | body(contained in the paramsstructure) | Optional. | 0.6 | |
| resourceUuid | String | body(contained in the paramsstructure) | Optional. The resource Uuid. | 0.6 | |
| tagUuids | List | body(contained in the paramsstructure) | Optional. The list of tag Uuids. | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 | |
| netOsDistro | String | body(contained in the paramsstructure) | Optional. | 5.4.2 | |
| baseOsDistro | String | body(contained in the paramsstructure) | Optional. | 5.4.2 | |
| vipUuid | String | body(contained in the paramsstructure) | Optional. VIP UUID | 5.4.2 | |
| ipv6VipUuid | String | body(contained in the paramsstructure) | Optional. | 5.4.2 | |
| primaryStorageUuid | String | body(contained in the paramsstructure) | Optional. The primary storage Uuid. | 5.4.2 | |
| primaryStoragePoolUuid | String | body(contained in the paramsstructure) | Optional. | 5.4.2 | |
| clusterUuid | String | body(contained in the paramsstructure) | Optional. The cluster Uuid. | 5.4.2 | |
| zoneUuid | String | body(contained in the paramsstructure) | Optional. The zone Uuid. | 5.4.2 |
API Response
{
"inventory": {
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | NfvInstGroupInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource Uuid. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage Uuid. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource UUID. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| imageUuid | String | The image UUID. | 5.4.2 |
| hostUuid | String | The host UUID. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 5.4.2 |
| rootVolumeUuid | String | The root volume UUID. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
CreateNfvInstGroupAction action = new CreateNfvInstGroupAction();
action.name = "nfvInstGroup";
action.instType = "KVM";
action.funcType = "DEDICATED_SLB";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateNfvInstGroupAction.Result res = action.call();CreateNfvInstGroupAction action = CreateNfvInstGroupAction()
action.name = "nfvInstGroup"
action.instType = "KVM"
action.funcType = "DEDICATED_SLB"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateNfvInstGroupAction.Result res = action.call()DeleteNfvInstGroup
API Request
DELETE zstack/v1/nfvinstgroup/group/{uuid}Authorization: OAuth the-session-uuidcurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE \
http://localhost:8080/zstack/v1/nfvinstgroup/group/4161bb82e42332bd8a34cec6d4c3aedd| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource Uuid. | 0.6 | |
| deleteMode | String | body | Optional. The deletion mode (Permissive / Enforcing,Permissive) | 0.6 | |
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
DeleteNfvInstGroupAction action = new DeleteNfvInstGroupAction();
action.uuid = "4161bb82e42332bd8a34cec6d4c3aedd";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteNfvInstGroupAction.Result res = action.call();DeleteNfvInstGroupAction action = DeleteNfvInstGroupAction()
action.uuid = "4161bb82e42332bd8a34cec6d4c3aedd"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteNfvInstGroupAction.Result res = action.call()ProvisionNfvInstGroup
API Request
PUT zstack/v1/nfvinstgroup/group/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"provisionNfvInstGroup": {},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"provisionNfvInstGroup":{}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/f35f1cb6eb9037158a17e2b94d6f3655/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.2 | |
| systemTags | List | body | Optional. The system tags. | 5.4.2 | |
| userTags | List | body | Optional. The user tags. | 5.4.2 |
API Response
{
"inventory": {
"name": "ovn-controller-group",
"uuid": "5373205b70163c54b333c2af3a3ab3d0",
"description": "OVN SDN Controller HA Group",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.2 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.2 |
| inventory | NfvInstGroupInventory | See inventory. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource UUID. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage Uuid. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| imageUuid | String | The image Uuid. | 5.4.2 |
| hostUuid | String | The host UUID. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering UUID. | 5.4.2 |
| rootVolumeUuid | String | The root volume UUID. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network UUID. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
ProvisionNfvInstGroupAction action = new ProvisionNfvInstGroupAction();
action.uuid = "f35f1cb6eb9037158a17e2b94d6f3655";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ProvisionNfvInstGroupAction.Result res = action.call();ProvisionNfvInstGroupAction action = ProvisionNfvInstGroupAction()
action.uuid = "f35f1cb6eb9037158a17e2b94d6f3655"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ProvisionNfvInstGroupAction.Result res = action.call()UpdateNfvInstGroup
API Request
PUT zstack/v1/nfvinstgroup/group/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"updateNfvInstGroup": {
"name": "nfvInstGroup-1",
"description": "nfv inst group test"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateNfvInstGroup":{"name":"nfvInstGroup-1","description":"nfv inst group test"}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/ff57ab6e79613a40b7e55d38e3069ea5/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource Uuid. | 3.5 | |
| name | String | body(contained in the updateNfvInstGroupstructure) | Optional. The resource name. | 5.5 | |
| description | String | body(contained in the updateNfvInstGroupstructure) | Optional. The detailed description of the resource. | 5.5 | |
| systemTags | List | body | Optional. The system tags. | 5.5 | |
| userTags | List | body | Optional. The user tags. | 5.5 |
API Response
{
"inventory": {
"name": "test-nfvinstgroup",
"uuid": "ca9371db50593f2786205e163e5e99d6",
"description": "nfv inst group description",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.2 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.2 |
| inventory | NfvInstGroupInventory | See inventory. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource Uuid. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage UUID. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster UUID. | 5.4.2 |
| zoneUuid | String | The zone UUID. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| imageUuid | String | The image Uuid. | 5.4.2 |
| hostUuid | String | The host Uuid. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 5.4.2 |
| rootVolumeUuid | String | The root volume Uuid. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
UpdateNfvInstGroupAction action = new UpdateNfvInstGroupAction();
action.uuid = "ff57ab6e79613a40b7e55d38e3069ea5";
action.name = "nfvInstGroup-1";
action.description = "nfv inst group test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateNfvInstGroupAction.Result res = action.call();UpdateNfvInstGroupAction action = UpdateNfvInstGroupAction()
action.uuid = "ff57ab6e79613a40b7e55d38e3069ea5"
action.name = "nfvInstGroup-1"
action.description = "nfv inst group test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateNfvInstGroupAction.Result res = action.call()SyncNfvInstGroup
API Request
PUT zstack/v1/nfvinstgroup/group/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"syncNfvInstGroup": {},
"systemTags": [],
"userTags": []
}
Note: In the preceding sample, both systemTagsand
userTags are optional. These two fields can be included in the body
structure. curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
X PUT -d '{"syncNfvInstGroup":{}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/f6befd7f753634faba06ac3c4391b9ca/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The UUID. | 5.4.2 | |
| systemTags | List | body | Optional. The system tags. | 5.4.2 | |
| userTags | List | body | Optional. The user tags. | 5.4.2 |
API Response
{
"inventory": {
"name": "ovn-controller-group",
"uuid": "021818d61ed638b9913d79422dd33d4a",
"description": "OVN SDN Controller HA Group",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 5.4.2 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 5.4.2 |
| inventory | NfvInstGroupInventory | See inventory. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource Uuid. | 5.4.2 |
| description | String | The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage Uuid. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| imageUuid | String | The image Uuid. | 5.4.2 |
| hostUuid | String | The host Uuid. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 5.4.2 |
| rootVolumeUuid | String | The root volume Uuid. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedlps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance UUid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The Layer3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
SyncNfvInstGroupAction action = new SyncNfvInstGroupAction();
action.uuid = "f6befd7f753634faba06ac3c4391b9ca";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SyncNfvInstGroupAction.Result res = action.call();SyncNfvInstGroupAction action = SyncNfvInstGroupAction()
action.uuid = "f6befd7f753634faba06ac3c4391b9ca"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SyncNfvInstGroupAction.Result res = action.call()ChangeNfvInstGroupOperationMode
API Request
PUT zstack/v1/nfvinstgroup/group/{uuid}/actionsAuthorization: OAuth the-session-uuid{
"changeNfvInstGroupOperationMode": {
"operationMode": "Maintenance"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeNfvInstGroupOperationMode":{"operationMode":"Maintenance"}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/1dd069e761853e6f83d146e08fc988b7/actions| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 5.4.2 | |
| operationMode | String | body(contain in the changeNfvInstGroupOperationMode structure) |
|
5.4.2 | |
| systemTags | List | body | Optional. The system tags. | 5.4.2 | |
| userTags | List | body | Optional. The user tags. | 5.4.2 |
API Response
{
"inventory": {
"name": "ovn-controller-group",
"uuid": "db47a6637d2731d9b9469505c468a098",
"description": "OVN SDN Controller HA Group",
"configVersion": 0,
"l3Networks": []
}
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| success | boolean | 0.6 | |
| error | ErrorCode | Error code, null if operation succeeds, non-null if operation fails, see error. | 0.6 |
| inventory | NfvInstGroupInventory | See inventory. | 0.6 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 5.4.0 |
| description | String | The brief description of the error. | 5.4.0 |
| details | String | The details about the error. | 5.4.0 |
| elaboration | String | The reserved field. Default value: null. | 5.4.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 5.4.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 5.4.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| name | String | The resource name. | 5.4.2 |
| uuid | String | The resource Uuid. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| nfvInstOfferingUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| vipUuid | String | VIP UUID | 5.4.2 |
| ipv6VipUuid | String | 5.4.2 | |
| primaryStorageUuid | String | The primary storage Uuid. | 5.4.2 |
| primaryStoragePoolUuid | String | 5.4.2 | |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| instType | InstType | See instType. | 5.4.2 |
| funcType | FuncType | See funcType. | 5.4.2 |
| status | NfvInstGroupStatus | See status. | 5.4.2 |
| operationMode | NfvInstGroupOperationMode | See operationMode. | 5.4.2 |
| instances | List | See instances. | 5.4.2 |
| monitors | List | See monitors. | 5.4.2 |
| services | List | See services. | 5.4.2 |
| configTasks | List | See configTasks. | 5.4.2 |
| l3Networks | List | See l3Networks. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| KVM | InstType | 5.4.2 | |
| CONTAINER | InstType | 5.4.2 | |
| HOST | InstType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| OVN_SDN_CONTROLLER | FuncType | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Initializing | NfvInstGroupStatus | 5.4.2 | |
| Healthy | NfvInstGroupStatus | 5.4.2 | |
| Degraded | NfvInstGroupStatus | 5.4.2 | |
| Operating | NfvInstGroupStatus | 5.4.2 | |
| Unavailable | NfvInstGroupStatus | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| Normal | NfvInstGroupOperationMode | 5.4.2 | |
| Maintenance | NfvInstGroupOperationMode | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| configVersion | int | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| netOsDistro | String | 5.4.2 | |
| baseOsDistro | String | 5.4.2 | |
| clusterStatus | String | 5.4.2 | |
| statusDetail | String | 5.4.2 | |
| applianceVmType | String | 5.4.2 | |
| managementNetworkUuid | String | 5.4.2 | |
| defaultRouteL3NetworkUuid | String | 5.4.2 | |
| status | String | 5.4.2 | |
| agentPort | Integer | 5.4.2 | |
| haStatus | String | 5.4.2 | |
| uuid | String | The resource Uuid. | 5.4.2 |
| name | String | The resource name. | 5.4.2 |
| description | String | Optional. The detailed description of the resource. | 5.4.2 |
| zoneUuid | String | The zone Uuid. | 5.4.2 |
| clusterUuid | String | The cluster Uuid. | 5.4.2 |
| imageUuid | String | The image Uuid. | 5.4.2 |
| hostUuid | String | The host Uuid. | 5.4.2 |
| lastHostUuid | String | 5.4.2 | |
| instanceOfferingUuid | String | The instance offering Uuid. | 5.4.2 |
| rootVolumeUuid | String | The root volume Uuid. | 5.4.2 |
| platform | String | 5.4.2 | |
| architecture | String | 5.4.2 | |
| defaultL3NetworkUuid | String | 5.4.2 | |
| type | String | 5.4.2 | |
| hypervisorType | String | 5.4.2 | |
| memorySize | Long | 5.4.2 | |
| reservedMemorySize | Long | 5.4.2 | |
| cpuNum | Integer | 5.4.2 | |
| cpuSpeed | Long | 5.4.2 | |
| allocatorStrategy | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| state | String | 5.4.2 | |
| guestOsType | String | 5.4.2 | |
| vmNics | List | See vmNics. | 5.4.2 |
| allVolumes | List | See allVolumes. | 5.4.2 |
| vmCdRoms | List | See vmCdRoms. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| l3NetworkUuid | String | The L3 network Uuid. | 4.7.13 |
| ip | String | 4.7.13 | |
| mac | String | 4.7.13 | |
| hypervisorType | String | 4.7.13 | |
| netmask | String | 4.7.13 | |
| gateway | String | 4.7.13 | |
| metaData | String | 4.7.13 | |
| ipVersion | Integer | 4.7.13 | |
| driverType | String | 4.7.13 | |
| internalName | String | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| type | String | 4.7.13 | |
| state | String | The NIC state. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| usedIps | List | See usedIps. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 5.0.0 |
| ipRangeUuid | String | The IP range Uuid. | 5.0.0 |
| l3NetworkUuid | String | The L3 network Uuid. | 5.0.0 |
| ipVersion | Integer | 5.0.0 | |
| ip | String | 5.0.0 | |
| netmask | String | 5.0.0 | |
| gateway | String | 5.0.0 | |
| usedFor | String | The allocation reason. | 5.0.0 |
| ipInLong | long | 5.0.0 | |
| ipInBinary | byte[] | 5.2.0 | |
| vmNicUuid | String | The VM NIC Uuid. | 5.0.0 |
| createDate | Timestamp | The creation date. | 5.0.0 |
| lastOpDate | Timestamp | The last operation date. | 5.0.0 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| primaryStorageUuid | String | The primary storage Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| diskOfferingUuid | String | The disk offering Uuid. | 4.7.13 |
| rootImageUuid | String | 4.7.13 | |
| installPath | String | 4.7.13 | |
| type | String | 4.7.13 | |
| format | String | 4.7.13 | |
| size | Long | 4.7.13 | |
| actualSize | Long | 4.7.13 | |
| deviceId | Integer | 4.7.13 | |
| state | String | 4.7.13 | |
| status | String | 4.7.13 | |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| isShareable | Boolean | 4.7.13 | |
| volumeQos | String | 4.7.13 | |
| lastDetachDate | Timestamp | 4.7.13 | |
| lastVmInstanceUuid | String | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource Uuid. | 4.7.13 |
| vmInstanceUuid | String | The VM instance Uuid. | 4.7.13 |
| deviceId | Integer | 4.7.13 | |
| isoUuid | String | 4.7.13 | |
| isoInstallPath | String | 4.7.13 | |
| name | String | The resource name. | 4.7.13 |
| description | String | Optional. The detailed description of the resource. | 4.7.13 |
| createDate | Timestamp | The creation date. | 4.7.13 |
| lastOpDate | Timestamp | The last operation date. | 4.7.13 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| monitorIp | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | Long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceName | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| id | long | 5.4.2 | |
| nfvInstGroupUuid | String | 5.4.2 | |
| configVersion | int | 5.4.2 | |
| serviceUuid | String | 5.4.2 | |
| taskName | String | 5.4.2 | |
| taskData | String | 5.4.2 | |
| path | String | 5.4.2 | |
| checkStatus | boolean | 5.4.2 |
| Name | Type | Description | Starting Version |
|---|---|---|---|
| nfvInstGroupUuid | String | 5.4.2 | |
| networkServiceUuid | String | 5.4.2 | |
| l3NetworkUuid | String | The L3 network Uuid. | 5.4.2 |
| l3NetworkCategory | String | 5.4.2 | |
| l3NetworkType | String | 5.4.2 | |
| type | String | 5.4.2 | |
| createDate | Timestamp | The creation date. | 5.4.2 |
| lastOpDate | Timestamp | The last operation date. | 5.4.2 |
SDK Sample
ChangeNfvInstGroupOperationModeAction action = new ChangeNfvInstGroupOperationModeAction();
action.uuid = "1dd069e761853e6f83d146e08fc988b7";
action.operationMode = "Maintenance";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeNfvInstGroupOperationModeAction.Result res = action.call();ChangeNfvInstGroupOperationModeAction action = ChangeNfvInstGroupOperationModeAction()
action.uuid = "1dd069e761853e6f83d146e08fc988b7"
action.operationMode = "Maintenance"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeNfvInstGroupOperationModeAction.Result res = action.call()AddL3NetworkToGroup
API Request
POST zstack/v1/nfvinstgroup/group/{nfvInstGroupUuid}/service/{networkServiceUuid}Authorization: OAuth the-session-uuid{
"params": {
"frontEndL3NetworkUuid": "2353b0e1eaf430dca4b3024c238e455f"
},
"systemTags": [],
"userTags": []
}
Note: In
the preceding sample, both systemTagsand userTags are optional.
These two fields can be included in the body structure.curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"frontEndL3NetworkUuid":"2353b0e1eaf430dca4b3024c238e455f"}}' \
http://localhost:8080/zstack/v1/nfvinstgroup/group/0c2382cd771b33279d44695f721fc791/service/cdb5f49b42503212a1b7b2eb77ca3e93| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| nfvInstGroupUuid | String | url | 0.6 | ||
| networkServiceUuid | String | url | 0.6 | ||
| frontEndL3NetworkUuid | String | body(contained in the paramsstructure) | 0.6 | ||
| backendL3NetworkUuids | List | body(contained in the paramsstructure) | 0.6 | ||
| systemTags | List | body | Optional. The system tags. | 0.6 | |
| userTags | List | body | Optional. The user tags. | 0.6 |
API Response
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}SDK Sample
AddL3NetworkToGroupAction action = new AddL3NetworkToGroupAction();
action.nfvInstGroupUuid = "0c2382cd771b33279d44695f721fc791";
action.networkServiceUuid = "cdb5f49b42503212a1b7b2eb77ca3e93";
action.frontEndL3NetworkUuid = "2353b0e1eaf430dca4b3024c238e455f";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddL3NetworkToGroupAction.Result res = action.call();AddL3NetworkToGroupAction action = AddL3NetworkToGroupAction()
action.nfvInstGroupUuid = "0c2382cd771b33279d44695f721fc791"
action.networkServiceUuid = "cdb5f49b42503212a1b7b2eb77ca3e93"
action.frontEndL3NetworkUuid = "2353b0e1eaf430dca4b3024c238e455f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddL3NetworkToGroupAction.Result res = action.call()