CA 3Tera AppLogic API の有効なオブジェクト › iface オブジェクト › info メソッド（iface オブジェクト）

info メソッド（iface オブジェクト）

説明

コンポーネント インターフェースの情報を表示します。

構文

/api/v1/iface/info?app=application&comp=component&iface=interface&vdc=controller-name 

引数

application

アプリケーションの名前

component

コンポーネントの名前

interface

インターフェースの名前

controller-name

ターゲットの仮想データ センターの名前

トランザクション タイプ

同期

リクエスト タイプ

GET

例

sugarcrm:main.srv1 の入力端子の情報を表示します。

GET http://192.168.123.200/api/v1/iface/info?app=sugarcrm&comp=main.srv1&iface=in&vdc=mygrid 

サンプル出力

XML

<interface>
   <name>in</name>
   <connections>
       <name>connections[0]</name>
      <loc_addr>F2640A00361E0000</loc_addr>
       <loc_ip>10.80.54.18</loc_ip>
      <rem_addr>F2640A0036350000</rem_addr>
       <rem_ip>10.80.54.17</rem_ip>
      <type>None</type>
    </connections>
    <device>eth0</device>
   <ip>10.80.54.18</ip>
   <mac>F2:64:0A:00:36:1E</mac>
   <state>active</state>
   <type>input</type>
</interface>

JSON

{
   "connections" : {
       "connections[0]" : {
         "loc_ip" : "10.80.54.18",
         "rem_addr" : "F2640A0036350000",
         "rem_ip" : "10.80.54.17",
         "type" : "None",
         "loc_addr" : "F2640A00361E0000"
      }
   },
   "ip" : "10.80.54.18",
   "name" : "in",
   "type" : "input",
   "mac" : "F2:64:0A:00:36:1E",
   "device" : "eth0",
   "state" : "active"
} 

メモ

JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。

UTF8 にエンコードされた JSON 出力をデコードするシンプルな PHP スクリプトの例を以下に示します。

<? 
$json = '{"a": "¥u00e3¥u0081¥u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

HTTP エラー コード

404

エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。

400.4

必要な引数（app）がありません。 リクエストに引数 app=app がありません。

400.4

必要な引数（comp）がありません。 リクエストに引数 comp=comp がありません。

400.4

必要な引数（iface）がありません。 リクエストに引数 iface=iface がありません。

404

インターフェース test:main.vpn.ctl の情報を表示できませんでした。存在しません。 リクエストで無効なインターフェース、アプリケーションまたはコンポーネントが指定されているか、アプリケーションが停止状態にあります。

404

インターフェース test:main.srv の情報を表示できませんでした。詳細はログを参照してください。 リクエストで指定されたコンポーネントは実行されていません。