管理インターフェイス

コンテンツ :

この文書の Apiary バージョン

この API 仕様は、Apiary でも確認できます。

トップ

GET /admin/log

Cygnus のログレベルを取得します。

GET http://<cygnus_host>:<management_port>/admin/log

レスポンス : 

200 OK
{"level": "...."}
500 Internal Server Error
{
    "error": "..."
}

トップ

PUT /admin/log

クエリ・パラメータとしてログレベルを指定して、Cygnus のログレベルを更新します。

有効なログレベルは、DEBUG, INFO, WARNING (WARN も動作します)、ERROR およびFATAL

PUT http://<cygnus_host>:<management_port>/admin/log?level=<log_level>

レスポンス :

200 OK
400 Bad Request
{"error":"Invalid log level"}
400 Bad Request
{"error":"}

トップ

GET /admin/configuration/agent

GET all parameters

URL 内の URI として設定ファイルへのパスを指定して、エージェントからすべてのパラメータを取得します。エージェントの名前は agent_ で始まる必要があります。

GET "http://<cygnus_host>:<management_port>/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf"

注 : /v1/admin/configuration/agent パスの使用方法も同じです。

GET "http://<cygnus_host>:<management_port>/v1/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf"

レスポンス :

エージェント設定ファイルへの有効なパス : 

{"success":"true","result" : {
{"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","channels.mysql-channel.transactionCapacity":"100","cygnus-common.sources.http-source.interceptors.gi.type":"com.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"false","cygnus-common.sinks.mysql-sink.mysql_password":"root","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules_2.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.handlers.NGSIRestHandler","cygnus-common.sinks.mysql-sink.data_model":"dm-by-service-path","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel"}}}

エージェント設定ファイルへの無効なパス : 

{"success":"false","result" : { "File not found in the path received" }

無効なエージェント設定ファイル名 : 

{"success":"false","error":"Agent file name must start with 'agent_'."}

トップ

GET a single parameter

URL 内の URI としての設定ファイルへのパスとクエリ・パラメータとしてのパラメータの名前を指定して、エージェントから単一のパラメータを取得します。エージェントの名前は agent_ で始まる必要があります。

GET "http://<cygnus_host>:<management_port>/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf&param=<param_name>"

注 : /v1/admin/configuration/agent パスの使用方法も同じです。

GET "http://<cygnus_host>:<management_port>/v1/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf&param=<param_name>"

レスポンス :

エージェント設定ファイルへの有効なパス : 

{"success":"true","result" : {"cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute"}

エージェント設定ファイルへの無効なパス : 

{"success":"false","result" : {"File not found in the path received"}

エージェント設定ファイルにパラメータがありません : 

{"success":"false","result" : {"Param 'cygnus-common.sinks.mysql-sink.new_parameter' not found in the agent"}

無効なエージェント設定ファイル名 : 

{"success":"false","error":"Agent file name must start with 'agent_'."}

トップ

POST /admin/configuration/agent

URL 内の URI として設定ファイルへのパス、およびクエリ・パラメータとしてのパラメータの名前と値を指定して、エージェントに存在しない単一のパラメータを送信します。エージェントの名前は agent_ で始まる必要があります。

POST "http://<cygnus_host>:<management_port>/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.my_new_param&value=my_new_value"

注 : /v1/admin/configuration/agent パスの使用方法も同じです。

POST "http://<cygnus_host>:<management_port>/v1/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.my_new_param&value=my_new_value"

レスポンス :

エージェント設定ファイルへの有効なパス : 

{"success":"true","result" : {"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","cygnus-common.channels.mysql-channel.transactionCapacity":"100","cygnus-common.sources.http-source.interceptors.gi.type":"com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"true","cygnus-common.sinks.mysql-sink.mysql_password":"","cygnus-common.channels.aux-channel.capacity":"1000","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.telefonica.iot.cygnus.sinks.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.channels.aux-channel.type":"memory","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.channels.aux-channel.transactionCapacity":"100","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.telefonica.iot.cygnus.handlers.NGSIRestHandler","cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute","cygnus-common.sinks.mysql-sink.my_new_param":"my_new_value","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel aux-channel"}}}

エージェント設定ファイルへの無効なパス : 

{"success":"false","result" : { "File not found in the path received" }

エージェント設定ファイルの既存の値 : 

{"success":"false","result" : {"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","cygnus-common.channels.mysql-channel.transactionCapacity":"100","cygnus-common.sources.http-source.interceptors.gi.type":"com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"true","cygnus-common.sinks.mysql-sink.mysql_password":"","cygnus-common.channels.aux-channel.capacity":"1000","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.telefonica.iot.cygnus.sinks.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.channels.aux-channel.type":"memory","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.channels.aux-channel.transactionCapacity":"100","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.telefonica.iot.cygnus.handlers.NGSIRestHandler","cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute","cygnus-common.sinks.mysql-sink.my_new_param":"my_new_value","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel aux-channel"}}}

無効なエージェント設定ファイル名 :

{"success":"false","error":"Agent file name must start with 'agent_'."}

トップ

PUT /admin/configuration/agent

URL 内の URI として設定ファイルへのパス、およびクエリ・パラメータとしてのパラメータの名前と値を指定して、存在しない場合は単一のパラメータを置き換えます。エージェントの名前は agent_ で始まる必要があります。

PUT "http://<cygnus_host>:<management_port>/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.my_new_param&value=my_new_value"

注 : /v1/admin/configuration/agent パスの使用方法も同じです。

PUT "http://<cygnus_host>:<management_port>/v1/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.new_param&value=new_value"

レスポンス :

エージェント設定ファイルへの有効なパス : 

{"success":"true","result" : {"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","cygnus-common.channels.mysql-channel.transactionCapacity":"100","cygnus-common.sources.http-source.interceptors.gi.type":"com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"true","cygnus-common.sinks.mysql-sink.mysql_password":"","cygnus-common.channels.aux_channel1.capacity":"1000","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.telefonica.iot.cygnus.sinks.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.channels.aux_channel1.type":"memory","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.channels.aux_channel2.type":"memory","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.channels.aux_channel1.transactionCapacity":"100","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.telefonica.iot.cygnus.handlers.NGSIRestHandler","cygnus-common.channels.aux_channel2.transactionCapacity":"100","cygnus-common.channels.aux_channel2.capacity":"1000","cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel aux_channel1 aux_channel2"}}}

エージェント設定ファイルへの無効なパス : 

{"success":"false","result" : { "File not found in the path received" }

無効なエージェント設定ファイル名 : 

{"success":"false","error":"Agent file name must start with 'agent_'."}

PUT メソッドの後にテスト済みのエージェント設定ファイルが表示されます。

cygnus-common.sources = http-source
cygnus-common.sinks = mysql-sink
cygnus-common.channels = mysql-channel aux_channel1 aux_channel2

cygnus-common.sources.http-source.interceptors.gi.type = com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder
cygnus-common.sources.http-source.handler.default_service = def_service
cygnus-common.sources.http-source.interceptors = ts gi
cygnus-common.sources.http-source.type = org.apache.flume.source.http.HTTPSource
cygnus-common.sources.http-source.handler.default_service_path = /def_servpath
cygnus-common.sources.http-source.handler.notification_target = /notify
cygnus-common.sources.http-source.interceptors.ts.type = timestamp
cygnus-common.sources.http-source.port = 5050
cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file = /cygnus/apache-flume-1.4.0-bin/conf/grouping_rules.conf
cygnus-common.sources.http-source.channels = mysql-channel
cygnus-common.sources.http-source.handler.events_ttl = 2
cygnus-common.sources.http-source.handler = com.telefonica.iot.cygnus.handlers.NGSIRestHandler

cygnus-common.channels.mysql-channel.transactionCapacity = 100
cygnus-common.channels.mysql-channel.capacity = 1000
cygnus-common.channels.mysql-channel.type = memory

cygnus-common.channels.aux_channel1.capacity = 1000
cygnus-common.channels.aux_channel1.type = memory
cygnus-common.channels.aux_channel1.transactionCapacity = 100

cygnus-common.channels.aux_channel2.type = memory
cygnus-common.channels.aux_channel2.transactionCapacity = 100
cygnus-common.channels.aux_channel2.capacity = 1000

cygnus-common.sinks.mysql-sink.mysql_port = 3306
cygnus-common.sinks.mysql-sink.mysql_host = localhost
cygnus-common.sinks.mysql-sink.enable_grouping = true
cygnus-common.sinks.mysql-sink.mysql_password =
cygnus-common.sinks.mysql-sink.type = com.telefonica.iot.cygnus.sinks.NGSIMySQLSink
cygnus-common.sinks.mysql-sink.batch_timeout = 10
cygnus-common.sinks.mysql-sink.mysql_username = root
cygnus-common.sinks.mysql-sink.batch_size = 1
cygnus-common.sinks.mysql-sink.channel = mysql-channel
cygnus-common.sinks.mysql-sink.new_parameter = new_value
cygnus-common.sinks.mysql-sink.data_model = dm-by-attribute
cygnus-common.sinks.mysql-sink.attr_persistence = row

トップ

DELETE /admin/configuration/agent

URL 内の URI として設定ファイルへのパスとクエリ・パラメータとしてのパラメータの名前を指定して、エージェントに存在する単一のパラメータを削除します。エージェントの名前は agent_ で始まる必要があります。

DELETE "http://<cygnus_host>:<management_port>/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.new_parameter

/v1/admin/configuration/agent を使用して、DELETE 単一のパラメータには、2番目のオプションがあります。両方とも同じ動作をしますが、どちらも自由に使用できます。

DELETE "http://<cygnus_host>:<management_port>/v1/admin/configuration/agent/cygnus/apache-flume-1.4.0-bin/conf/agent_cygnus.conf?param=cygnus-common.sinks.mysql-sink.new_param"

レスポンス :

エージェント設定ファイルへの有効なパス : 

{"success":"true","result" : {"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","cygnus-common.channels.mysql-channel.transactionCapacity":"100","cygnus-common.sources.http-source.interceptors.gi.type":"com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"true","cygnus-common.sinks.mysql-sink.mysql_password":"","cygnus-common.channels.aux_channel1.capacity":"1000","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.telefonica.iot.cygnus.sinks.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.channels.aux_channel1.type":"memory","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.channels.aux_channel1.transactionCapacity":"100","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.telefonica.iot.cygnus.handlers.NGSIRestHandler","cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel aux_channel1"}}}

エージェント設定ファイルへの無効なパス : 

{"success":"false","result" : { "File not found in the path received" }

エージェント設定ファイルにパラメータがありません : 

{"success":"false","result" : {"agent":{"cygnus-common.sinks.mysql-sink.mysql_port":"3306","cygnus-common.channels.mysql-channel.transactionCapacity":"100","cygnus-common.sinks.mysql-sink.new_parameter":"new_value","cygnus-common.sources.http-source.interceptors.gi.type":"com.telefonica.iot.cygnus.interceptors.NGSIGroupingInterceptor$Builder","cygnus-common.sources.http-source.handler.default_service":"def_service","cygnus-common.sources.http-source.interceptors":"ts gi","cygnus-common.sinks.mysql-sink.mysql_host":"localhost","cygnus-common.sources.http-source.type":"org.apache.flume.source.http.HTTPSource","cygnus-common.sources.http-source.handler.default_service_path":"\/def_servpath","cygnus-common.sources.http-source.handler.notification_target":"\/notify","cygnus-common.sinks.mysql-sink.enable_grouping":"true","cygnus-common.sinks.mysql-sink.mysql_password":"","cygnus-common.channels.aux_channel1.capacity":"1000","cygnus-common.sources":"http-source","cygnus-common.channels.mysql-channel.capacity":"1000","cygnus-common.sinks.mysql-sink.type":"com.telefonica.iot.cygnus.sinks.NGSIMySQLSink","cygnus-common.sources.http-source.interceptors.ts.type":"timestamp","cygnus-common.channels.aux_channel1.type":"memory","cygnus-common.sinks.mysql-sink.batch_timeout":"10","cygnus-common.sources.http-source.port":"5050","cygnus-common.sinks.mysql-sink.batch_size":"1","cygnus-common.sinks.mysql-sink.mysql_username":"root","cygnus-common.sinks.mysql-sink.channel":"mysql-channel","cygnus-common.sources.http-source.interceptors.gi.grouping_rules_conf_file":"\/cygnus\/apache-flume-1.4.0-bin\/conf\/grouping_rules.conf","cygnus-common.channels.mysql-channel.type":"memory","cygnus-common.channels.aux_channel1.transactionCapacity":"100","cygnus-common.sources.http-source.channels":"mysql-channel","cygnus-common.sources.http-source.handler.events_ttl":"2","cygnus-common.sources.http-source.handler":"com.telefonica.iot.cygnus.handlers.NGSIRestHandler","cygnus-common.sinks.mysql-sink.data_model":"dm-by-attribute","cygnus-common.sinks":"mysql-sink","cygnus-common.sinks.mysql-sink.attr_persistence":"row","cygnus-common.channels":"mysql-channel aux_channel1"}}}

無効なエージェント設定ファイル名 : 

{"success":"false","error":"Agent file name must start with 'agent_'."}

トップ

GET /admin/configuration/instance

GET all parameters

URL 内の URI として設定ファイルへのパスが指定されたインスタンスからすべてのパラメータを取得します。インスタンスへのパスは /usr/cygnus/conf でなければなりません。

GET "http://<cygnus_host>:<management_port>/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf"

注 : /v1/admin/configuration/instance パスの使用方法も同じです。

GET "http://<cygnus_host>:<management_port>/v1/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf"

レスポンス :

インスタンス設定ファイルへの有効なパス : 

{"success":"true","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"8081","CONFIG_FOLDER":"\/usr\/cygnus\/conf","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}

インスタンス設定ファイルへの無効なパス : 

{"success":"false","result" : {"Invalid path for a instance configuration file"}

インスタンス設定ファイルが見つかりません : 

{"success":"false","result" : {"File not found in the path received"}

トップ

GET a single parameter

URL 内の URI としての設定ファイルへのパスとクエリ・パラメータとしてのパラメータの名前を指定して、インスタンスから単一のパラメータを取得します。インスタンスへのパスは /usr/cygnus/conf でなければなりません。

GET "http://<cygnus_host>:<management_port>/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>"

注 : /v1/admin/configuration/instance パスの使用方法も同じです。

GET "http://<cygnus_host>:<management_port>/v1/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>"

レスポンス :

インスタンス設定ファイルへの有効なパス : 

{"success":"true","result" : {"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf"}

インスタンス設定ファイルへの無効なパス :

{"success":"false","result" : {"Invalid path for a instance configuration file"}

インスタンス設定ファイルにパラメータがありません : 

{"success":"false","result" : {"Param 'CONFIG_FOLDER_FILE' not found in the instance"}

インスタンス設定ファイルが見つかりません : 

{"success":"false","result" : {"File not found in the path received"}

トップ

POST /admin/configuration/instance

URL 内の URI として設定ファイルへのパス、およびクエリ・パラメータとしてのパラメータの名前と値が指定されたインスタンスに存在しない場合は、単一のパラメータを送信します。インスタンスへのパスは /usr/cygnus/conf でなければなりません。

POST "http://<cygnus_host>:<management_port>/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>&value=<param_value>"

注 : /v1/admin/configuration/instance パスの使用方法も同じです。

POST "http://<cygnus_host>:<management_port>/v1/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>&value=<param_value>"

レスポンス :

インスタンス設定ファイルへの有効なパス : 

{"success":"true","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"8081","CONFIG_FOLDER":"\/usr\/cygnus\/conf","ADMIN_PORT_2":"8082","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルへの無効なパス : 

{"success":"false","result" : {"Invalid path for a instance configuration file"}

インスタンス設定ファイルの既存の値 : 

{"success":"false","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","CONFIG_FOLDER":"\/usr\/cygnus\/conf","ADMIN_PORT":"8081","CYGNUS_USER":"cygnus","LOGFILE_NAME":"cygnus.log","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルが見つかりません : 

{"success":"false","result" : {"File not found in the path received"}

トップ

PUT /admin/configuration/instance

URL 内の URI として設定ファイルへのパス、およびクエリ・パラメータとしてのパラメータの名前と値が指定されている場合は、存在しない場合は単一のパラメータを置き換えます。インスタンスへのパスは /usr/cygnus/conf でなければなりません。

PUT "http://<cygnus_host>:<management_port>/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>&value=<param_value>"

注 : /v1/admin/configuration/instance パスの使用方法も同じです。

PUT "http://<cygnus_host>:<management_port>/v1/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>&value=<param_value>"

レスポンス :

インスタンス設定ファイルへの有効なパス。old_value 値で NEW_PARAM を追加する : 

{"success":"true","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"8081","CONFIG_FOLDER":"\/usr\/cygnus\/conf","NEW_PARAM":"old_value","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルへの有効なパス。new_value 値で NEW_PARAM を更新する : 

{"success":"true","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"8081","CONFIG_FOLDER":"\/usr\/cygnus\/conf","NEW_PARAM":"new_value","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルへの無効なパス : 

{"success":"false","result" : {"Invalid path for a instance configuration file"}

インスタンス設定ファイルが見つかりません : 

{"success":"false","result" : {"File not found in the path received"}

以下の PUT メソッドの後にテスト済みのインスタンス設定ファイルが表示されます。

#####
# Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
#
# This file is part of fiware-cygnus (FI-WARE project).
#
# fiware-cygnus is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
# later version.
# fiware-cygnus is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along with fiware-cygnus. If not, see
# http://www.gnu.org/licenses/.
#
# For those usages not covered by the GNU Affero General Public License please contact with iot_support at tid dot es

# Which is the config file
CONFIG_FILE=/usr/cygnus/conf/agent.conf

# Name of the agent. The name of the agent is not trivial, since it is the base for the Flume parameters
# naming conventions, e.g. it appears in .sources.http-source.channels=...
AGENT_NAME=cygnus-common

# Administration port. Must be unique per instance
ADMIN_PORT=8081

# Where is the config folder
CONFIG_FOLDER=/usr/cygnus/conf

OLD_CONFIG=true

# Name of the logfile located at /var/log/cygnus. It is important to putthe extension '.log' in order to the log rotation works properly
LOGFILE_NAME=cygnus.log

# Who to run cygnus as. Note that you may need to use root if you want
# to run cygnus in a privileged port (<1024)
CYGNUS_USER=cygnus

# Polling interval (seconds) for the configuration reloading
POLLING_INTERVAL=30

トップ

DELETE /admin/configuration/instance

URL 内の URI としての設定ファイルへのパスとクエリ・パラメータとしてのパラメータの名前を指定して、インスタンス内の単一のパラメータを削除します。インスタンスへのパスは /usr/cygnus/conf でなければなりません。

DELETE "http://<cygnus_host>:<management_port>/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>"

注 : /v1/admin/configuration/instance パスの使用方法も同じです。

DELETE "http://<cygnus_host>:<management_port>/v1/admin/configuration/instance/usr/cygnus/conf/cygnus_instance.conf?param=<param_name>"

レスポンス :

インスタンス設定ファイルへの有効なパス :

{"success":"true","result" : {"instance":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"8081","CONFIG_FOLDER":"\/usr\/cygnus\/conf","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルに存在する値 :

{"success":"false","result" : {"agent":{"CONFIG_FILE":"\/usr\/cygnus\/conf\/agent.conf","AGENT_NAME":"cygnus-common","ADMIN_PORT":"898989","CONFIG_FOLDER":"\/usr\/cygnus\/conf","ADMIN_PORT_2":"1234","LOGFILE_NAME":"cygnus.log","CYGNUS_USER":"cygnus","POLLING_INTERVAL":"30"}}}

インスタンス設定ファイルへの無効なパス :

{"success":"false","result" : {"Invalid path for a instance configuration file"}

インスタンス設定ファイルが見つかりません : 

{"success":"false","result" : {"File not found in the path received"}

トップ