統合ガイド › BFC API リファレンス ガイド › API に関する詳細なドキュメント › グリッド URI › グリッドの取得

グリッドの取得

グリッドのセット、単一のグリッド、およびグリッドの状態に関する情報を取得できます。

GET  BFC/grids

引数

なし

結果

成功時には、HTTP リターン コード 200、およびグリッド レコードのリストであるペイロードが返されます。 エラーの際には、HTTP エラー コードと、関連するエラー情報が返されます。

説明

システム内の現在のグリッドのセットに関する情報を、グリッド レコードのリストとして取得します。 BFC API の 1.0 リリースの場合は、返すグリッド レコードの範囲を指定できません。システム内のすべてのグリッドに対してレコードが返されます。

BFC API の 1.0 リリースの場合、GET で入力される grid_record 内のフィールドは、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、および state です。

Python の例

session = get_session()
conn = HTTPSConnection(bfcHost + ':8443')
conn.connect()
conn.request(method='GET',
             url='/BFC/grids',
             headers={'Content-Type':'application/json',
                      'Authorization':session})
grids = json.loads(conn.getresponse().read())
print grids

JSON ペイロードの例

{"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}}]} 

単一グリッドに関する情報を取得します

GET  BFC/grids/<grid_name>

引数

なし

結果

成功時には、HTTP リターン コード 200、およびグリッド レコードであるペイロードが返されます。 エラーの際には、HTTP エラー コードと、関連するエラー情報が返されます。

説明

単一のグリッドに関する情報を取得します。 情報がグリッド レコードで返されます。 BFC API の 1.0 リリースの場合、GET で入力される grid_record 内のフィールドは、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、および state です。

Python の例

from httplib import HTTPSConnection
import json
import os
import sys

gridName = sys.argv[1]
print 'gridName: {0}'.format(gridName)
bfcHost = os.environ["BFC_HOST"]
bfcSession = os.environ["BFC_SESSION"]
conn = HTTPSConnection(bfcHost + ':8443')
conn.connect()
conn.request(method='GET',
             url='/BFC/grids/' + gridName,
             headers={'Content-Type':'application/json',
                      'Authorization':bfcSession})
r1 = conn.getresponse()
print 'HTTP Response Code: {0}'.format(r1.status)
grid = json.loads(conn.getresponse().read())
print json.dumps(grid, sort_keys=True, indent=4)

JSON ペイロードの例

{"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}} 

単一グリッドの状態に関する情報を取得します

GET  BFC/grids/<grid_name>/state

引数

なし

結果

成功時には、HTTP リターン コード 200、およびグリッドの状態であるペイロードが文字列として返されます。 エラーの際には、HTTP エラー コードと、関連するエラー情報が返されます。

説明

単一のグリッドの状態を取得します。 グリッドの状態が文字列で返されます。

JSON ペイロードの例

"resource_allocated_state"