QueryBareMetal2BondingNicRef
API Requests
URLs
GET /v1/baremetal2/bonding/nic/refsHeaders
Authorization: OAuth the-session-uuidQueryable Fields
You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryBareMetal2BondingNicRef, and pressing the Tab key.
Curl Samples
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/baremetal2/bonding/nic/refs?q=uuid=1ca709f9d1cf377b99b20f277e7c97f9API Response
Sample Response
{
"inventories": [
{
"uuid": "8efce80a3b804b038d4cc7055e3eb162",
"name": "BM_CHASSIS",
"description": "This is a bare metal chassis.",
"zoneUuid": "fc08d44db9ec493e8f14150a3bf4fe40",
"clusterUuid": "06fe95935cd74d3bbb15c049e7333295",
"chassisOfferingUuid": "aa98b259748448b992c58076910b7343",
"type": "IPMI",
"state": "Enabled",
"status": "Available",
"powerStatus": "POWER_ON",
"provisionType": "Remote",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error | 4.4.24 |
| success | boolean | 4.4.24 | |
| inventories | List | See inventories | 4.4.24 |
#error
| 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. | 4.4.24 |
| description | String | The brief description of the error. | 4.4.24 |
| details | String | The details about the error. | 4.4.24 |
| elaboration | String | The reserved field. Default value: null. | 4.4.24 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 4.4.24 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 4.4.24 |
#inventories
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The resource UUID. | 4.4.24 |
| name | String | The resource name. | 4.4.24 |
| description | String | The detailed description of the resource. | 4.4.24 |
| zoneUuid | String | The zone UUID. | 4.4.24 |
| clusterUuid | String | The cluster UUID. | 4.4.24 |
| chassisOfferingUuid | String | The chassis offering UUID. | 4.4.24 |
| type | String | Type | 4.4.24 |
| state | String | The state of the elastic bare metal instance. | 4.4.24 |
| status | String | The status of the elastic bare metal instance. | 4.4.24 |
| powerStatus | String | The power status. | 4.4.24 |
| createDate | Timestamp | The creation date. | 4.4.24 |
| lastOpDate | Timestamp | The last operation date. | 4.4.24 |
| chassisNics | List | See chassisNics | 4.4.24 |
| chassisDisks | List | See chassisDisks | 4.4.24 |
| chassisOffering | BareMetal2ChassisOfferingInventory | See chassisOffering | 4.4.24 |
#chassisNics
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The UUID of the bare metal chassis NIC. | 4.4.24 |
| chassisUuid | String | The UUID of the bare metal chassis. | 4.4.24 |
| mac | String | The MAC address of the chassis NIC. | 4.4.24 |
| speed | String | The data rate of the chassis NIC. | 4.4.24 |
| isProvisionNic | Boolean | Indicates whether the NIC is a provisioned NIC. | 4.4.24 |
| createDate | Timestamp | The time when the NIC was created. | 4.4.24 |
| lastOpDate | Timestamp | The time when the NIC was last modified. | 4.4.24 |
#chassisDisks
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The UUID of the chassis disk. | 4.4.24 |
| chassisUuid | String | The chassis UUID. | 4.4.24 |
| diskSize | Long | The size of the disk storage space, in bytes. | 4.4.24 |
| type | String | The type of the disk. | 4.4.24 |
| createDate | Timestamp | The time when the disk was created. | 4.4.24 |
| lastOpDate | Timestamp | The time when the disk was last modified. | 4.4.24 |
#chassisOffering
| Name | Type | Description | Starting Version |
|---|---|---|---|
| uuid | String | The chassis offering UUID. | 4.4.24 |
| name | String | The name of the chassis offering. | 4.4.24 |
| description | String | The detailed description of the chassis offering. | 4.4.24 |
| architecture | String | The CPU architecture. | 4.4.24 |
| cpuModelName | String | The CPU model name. | 4.4.24 |
| cpuNum | Integer | The number of CPU cores. | 4.4.24 |
| memorySize | Long | The memory size. | 4.4.24 |
| bootMode | String | The boot mode. | 4.4.24 |
| state | String | The state of the chassis offering. | 4.4.24 |
| createDate | Timestamp | The time when the chassis offering was created. | 4.4.24 |
| lastOpDate | Timestamp | The time when the chassis offering was last modified. | 4.4.24 |
SDK Sample
Java
SDK
QueryBareMetal2BondingNicRefAction action = new QueryBareMetal2BondingNicRefAction();
action.conditions = asList("uuid=9c199dcc0a8e3f888e2e2979b9c68b5e");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryBareMetal2BondingNicRefAction.Result res = action.call();Python
SDK
QueryBareMetal2BondingNicRefAction action = QueryBareMetal2BondingNicRefAction()
action.conditions = ["uuid=2dfe71bbf313315f825a52a17568fc71"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryBareMetal2BondingNicRefAction.Result res = action.call()