You can retrieve information about a set of grids, for a single grid, and for grid state.
GET BFC/grids
Payload is empty.
HTTP return code 200 and a payload that is a list of grid records on success. Returns an HTTP error code and the associated fault information on error.
Retrieves information about the current set of grids in the system as a list of grid records. For the 1.0 release of the BFC API, you cannot specify the range of grid records to return, rather records are returned for all grids in the system.
For the 1.0 release of the BFC API, the fields in the grid_record that are populated on a GET are: name, description, controller_ip, id, applogic_version, xen_config, esx_config, external_network, default_vlan, vmware_license_key, app_ip_count, app_ips, servers, oem_kit, global_user_dir, account_id and state.
Example JSON Payload
{"grid":{"comp_id":1234,"id":2,"name":"SimpleGrid2",
"description":"SimpleGrid2 description","state":"resource_allocated_state",
"applogic_version":"3.1.2","applogic_hotfixes":null,"enable_language_packs":false,
"xen_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":null}},
"esx_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":null}},
"servers":[],"external_network":"127.10.10.0/24",
"app_ips":[{"grid_ip_range":{subnet_id:2345,vlan:10,public_private:"public",
ip_low:"127.10.10.2",ip_high:"127.10.10.11"}],"app_ip_count":10,
"controller_ip":"127.10.10.1","default_vlan":1,
"account_id":null,"account_key":null, "oem_kit":null,
"vmware_license_key":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX","global_user_dir":null,
"grid_controller_name":null,"grid_controller_user":null,"grid_controller_password":null,
"recovery_password":null,"additional_config":null}},
{"grid":{"comp_id":5678,"id":1,"name":"SimpleGrid1",
"description":"SimpleGrid1 description","state":"resource_allocated_state",
"applogic_version":"3.1.1","applogic_hotfixes":null,"enable_language_packs":false,
"xen_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":null}},
"esx_config":{"grid_server_configuration":{"min":0,"target":0,"max":0,"selection_criteria":null}},
"servers":[],"external_network":"127.10.10.0/24",
"app_ips":[{"grid_ip_range":{subnet_id:1245,vlan:null,public_private:"public",
ip_low:"127.10.10.13",ip_high:"127.10.10.22"}],"app_ip_count":10,
"controller_ip":"127.10.10.12","default_vlan":1,
"account_id":null,"account_key":null, "oem_kit":null,
"vmware_license_key":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX","global_user_dir":null,
"grid_controller_name":null,"grid_controller_user":null,"grid_controller_password":null,
"recovery_password":null, "additional_config":null, "external_storage":null}}]}
Retrieve Information about a Single Grid
GET BFC/grids/<grid_name>
Payload is empty.
HTTP return code 200 and a payload that is a grid record on success. Returns an HTTP error code and the associated fault information on error.
Retrieves information about a single grid. The information is returned in a grid record. For the 1.0 release of the BFC API, the fields in the grid_record that are populated on a GET are: name, description, controller_ip, id, applogic_version, xen_config, esx_config, external_network, default_vlan, vmware_license_key, app_ip_count, app_ips, servers, oem_kit, account_id, global_user_dir, external_storage, and state.
Example JSON Payload
{"grid":{"comp_id":null,"id":2,"name":"SimpleGrid2",
"description":"SimpleGrid2 description","state":"resource_allocated_state",
"applogic_version":"3.1.2","applogic_hotfixes":null,"enable_language_packs":false,
"xen_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":[["xengold"]]}},
"esx_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":[["esxgold"]]}},
"servers":[],"external_network":"127.10.10.0/24",
"app_ips":[{"grid_ip_range":{subnet_id:2345,vlan:10,public_private:"public",
ip_low:"127.10.10.2",ip_high:"127.10.10.11"}],"app_ip_count":10,
"controller_ip":"127.10.10.1","default_vlan":1,
"account_id":null,"account_key":null, "oem_kit":"Acme Computer Corp",
"vmware_license_key":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX","global_user_dir":null,
"grid_controller_name":null,"grid_controller_user":null,"grid_controller_password":null,
"recovery_password":null,"additional_config":null,"external_storage":null}}
Retrieve State Information for a Single Grid
GET BFC/grids/<grid_name>/state
Payload is empty.
HTTP return code 200 and a payload that is the grid state as a string on success. Returns an HTTP error code and the associated fault information on error.
Retrieves the state of a single grid. The grid state is returned in a string.
Example JSON Payload
"resource_allocated_state"
|
Copyright © 2012 CA.
All rights reserved.
|
|