詳細ホスト情報の登録

詳細ホスト情報を登録します。

Examples

REQUEST EXAMPLE

HULFT for Linux/AIX のサンプルは以下となります。

{
  "hostname": "HOSTNAME",
  "comment": "linux host",
  "host_type": "linux",
  "code_set": "utf8",
  "receive_port": 30000,
  "observe_port": 31000,
  "send_multiplex_level": 10,
  "standard_for_japanese": "83jis",
  "connect_type": "lan",
  "hulft7_mode": "disable",
  "proxy_server": {
    "name": "myproxy",
    "port": 50000
  },
  "security_setting": {
    "allow_send_request": "allow",
    "allow_huljob": "allow",
    "allow_hulsndrc": "allow",
    "allow_hulrjob": "allow",
    "allow_instant_transfer": "none"
  },
  "notify_user": "none"
}

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/managements/hosts/detail

= 備考 =

上のRequest InterfaceのURLで、斜体の文字部分に指定するパスについては以下を参照してください。

HULFT10 API Gateway ガイド : Request Interfaceの指定

REQUEST BODY SCHEMA : application/json

hostname : string

ホスト名（必須）

配信側または集信側のホスト名

1～68バイト以内で指定します。

配信する場合、このホスト名と転送グループ情報のホスト名が関連づけされます。

集信する場合、このホスト名と配信側の自ホスト名が関連づけされます。

英数字および“-（ハイフン）”、“.（ピリオド）”が使用可能。

comment : string

ホストに対するコメント

0～60バイト以内で指定します。

host_type : string

ホスト種（必須）

「ホスト名」で指定したホストのOS種別

以下のいずれかを指定します。

mainframe (H): : 汎用機
linux (L): : Linux/UNIX
unix (L): : Linux/UNIX
windows (W): : Windows
ibmi (I): : IBM i

code_set : string

転送コードセット（必須）

「ホスト名」で指定したホストの文字コード

以下のいずれかを指定します。

sjis (S): : SHIFT-JIS
jef (J): : JEF
euc_jp (E): : EUC-JP
ibm_japan (I): : IBM漢字
utf8 (8): : UTF-8
gb18030 (G): : GB18030
ibm_simplified_chinese (C): : IBM簡体字

ホスト種が“mainframe”の場合、転送コードセットは“jef”、“utf8”、“ibm_japan”を選択できます。

ホスト種が“linux”もしくは“unix”の場合、転送コードセットは“sjis”、“euc_jp”、“utf8”、“gb18030”を選択できます。

ホスト種が“windows”の場合、転送コードセットが“sjis”、“utf8”、“gb18030”を選択できます。

ホスト種が“ibmi”の場合、転送コードセットが“ibm_japan”、“utf8”、“ibm_simplified_chinese”を選択できます。

receive_port : integer

集信ポートNo.

「ホスト名」で指定したホストの集信ポート番号

1～65535の値を指定します。

省略すると、“30000”が設定されます。

observe_port : integer

要求受付ポートNo.

「ホスト名」で指定したホストの要求受付ポート番号

1～65535の値を指定します。

省略すると、“31000”が設定されます。

send_multiplex_level : integer

ホスト別配信多重度

「ホスト名」で指定したホストへの配信多重度

0～9999の値を指定します。

省略すると、“0”が設定されます。

“0”を設定した場合、ホスト別配信多重度の制御は行われません。

「ホスト別配信多重度」には、システム動作環境設定の「配信プロセスの多重度」以下の値を設定するようにしてください。

standard_for_japanese : string

日本語規格

「転送コードセット」で指定した文字コードのJIS年度

以下のいずれかを指定します。

78jis (0): : JIS78
83jis (1): : JIS83

省略すると、“83jis”が設定されます。

connect_type : string

接続形態

「ホスト名」で指定したホストの接続形態

以下の値を指定します。

lan (L): : LAN接続

“lan”のみ設定できます。

hulft7_mode : string

HULFT7通信モード

「ホスト名」で指定したホストとの通信方法

以下のいずれかを指定します。

enable (Y): : 最初からHULFT7の通信方法で接続する
disable (N): : まずHULFT8の通信方法で接続し、相手ホストが下位バージョンだった場合はHULFT7の通信方法に切り替える

省略すると、“disable”が設定されます。

proxy_server : object

Proxyサーバー

name : string

Proxyサーバー名（必須）

0～68バイト以内で指定します。

port : integer

ProxyポートNo. （必須）

0～65535の値を指定します。

HULFT-HUBまたはHULFT-WebConnectを使用したときに設定される項目

「Proxyサーバー名」、「ProxyポートNo.」の指定はセットで行う必要があります。どちらか片方に空の値を指定した場合はProxyサーバーを使用しない設定として扱います。

security_setting : object

セキュリティ

allow_send_request : string

送信要求・再送要求

送信要求（SEND）および再送要求（RESEND）のサービス受付可否

以下のいずれかを指定します。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

省略すると、“allow”が設定されます。

allow_huljob : string

集信後ジョブ結果参照

集信後ジョブ結果参照要求（HULJOB）のサービス受付可否

以下のいずれかを指定します。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

省略すると、“allow”が設定されます。

allow_hulsndrc : string

ジョブ実行結果通知

ジョブ実行結果通知（HULSNDRC）のサービス受付可否

以下のいずれかを指定します。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

省略すると、“allow”が設定されます。

allow_hulrjob : string

リモートジョブ実行

リモートジョブ実行（HULRJOB）のサービス受付可否

以下のいずれかを指定します。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

省略すると、“allow”が設定されます。

allow_instant_transfer : string

簡易転送要求

「ホスト名」で指定したホストからの簡易転送の受付可否

以下のいずれかを指定します。

allow (Y): : 簡易転送を受け付ける
none (N): : 簡易転送の受け付けを拒否する

省略すると、“none”が設定されます。

notify_user : string

ユーザIDを通知

ユーザID（OS）とユーザID（管理画面）の接続先ホストへの通知の有無

以下のいずれかを指定します。

allow (Y): : 通知する
none (N): : 通知しない

省略すると、“none”が設定されます。

ユーザIDの詳細は「Linux/AIX アドミニストレーションマニュアル」を参照してください。

Response Interface

201 Created 情報登録

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

meta : object

メタデータ

os_type : string

接続先ホスト機種

以下のいずれかが取得されます。

windows: : Windows環境管理情報
linux: : Linux/AIX環境管理情報
ibmi: : IBM i（AS/400）環境管理情報
zos: : z/OS（汎用機）環境管理情報

request_user_role : string

API実行ユーザーの権限

以下のいずれかが取得されます。

admin: : ユーザーの管理や接続先HULFTの追加を行うことができる権限
member: : 登録済みのHULFTへの接続を行うことができる権限

strong_key_mode : string

高強度暗号強制モードの設定値

以下のいずれかが取得されます。

disable: : 無効
enable: : 有効

product_version : string

製品バージョン

hostname : string

ホスト名

comment : string

host_type : string

ホスト種

以下のいずれかが取得されます。

mainframe (H): : 汎用機
linux (L): : Linux/UNIX
unix (L): : Linux/UNIX
windows (W): : Windows
ibmi (I): : IBM i

code_set : string

転送コードセット

以下のいずれかが取得されます。

sjis (S): : SHIFT-JIS
jef (J): : JEF
euc_jp (E): : EUC-JP
ibm_japan (I): : IBM漢字
utf8 (8): : UTF-8
gb18030 (G): : GB18030
ibm_simplified_chinese (C): : IBM簡体字

receive_port : integer

集信ポートNo.

observe_port : integer

要求受付ポートNo.

send_multiplex_level : integer

ホスト別配信多重度

standard_for_japanese : string

日本語規格

以下のいずれかが取得されます。

78jis (0): : JIS78
83jis (1): : JIS83

connect_type : string

接続形態

以下の値が取得されます。

lan (L): : LAN接続

hulft7_mode : string

HULFT7通信モード

以下のいずれかが取得されます。

enable (Y): : 最初からHULFT7の通信方法で接続する
disable (N): : まずHULFT8の通信方法で接続し、相手ホストが下位バージョンだった場合はHULFT7の通信方法に切り替える

proxy_server : object

Proxyサーバー

name : string: Proxyサーバー名
port : integer: ProxyポートNo.

security_setting : object

セキュリティ

allow_send_request : string

送信要求・再送要求

以下のいずれかが取得されます。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

allow_huljob : string

集信後ジョブ結果参照

以下のいずれかが取得されます。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

allow_hulsndrc : string

ジョブ実行結果通知

以下のいずれかが取得されます。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

allow_hulrjob : string

リモートジョブ実行

以下のいずれかが取得されます。

allow (Y): : サービスを受け付ける
none (N): : サービスの受け付けを拒否する

allow_instant_transfer : string

簡易転送要求

以下のいずれかが取得されます。

allow (Y): : 簡易転送を受け付ける
none (N): : 簡易転送の受け付けを拒否する

notify_user : string

ユーザIDを通知

以下のいずれかが取得されます。

allow (Y): : 通知する
none (N): : 通知しない

400 リクエストエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : (Error1(object or null)) or (Error2(object or null))

"Error1"、"Error2"のいずれかが取得されます。

Error1

message : string: バリデーションエラーメッセージ
fields : string: バリデーションフィールド情報

Error2

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

401 認証エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

403 認可エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

409 登録済みのIDを指定

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

500 サーバー内部エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]

502 HULFT接続エラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string

エラー種別

description : string

エラーの説明

measure : string

対処方法

detail : string

詳細エラー情報

additional : object

HULFTエラー追加情報

code : integer: HULFT実行結果
detail : string: HULFT詳細コード
latest_process_id : string: 最新処理ID
message : string: HULFTエラーメッセージ

]

504 タイムアウトエラー

RESPONSE HEADERS

X-Request-ID : string: WebAPIのリクエストID

RESPONSE SCHEMA : application/json

request_id : string

リクエストID

accept_datetime : string <date-time>

受付日時

api_path : string

APIパス

http_method : string

HTTPリクエストのメソッド形式

以下のいずれかが取得されます。

GET

HEAD

POST

OPTIONS

PUT

DELETE

TRACE

PATCH

LINK

UNLINK

errors : Array of objects

エラー詳細情報

以下の構造の情報（Array[]）が複数取得されます。

Array[

kind : string: エラー種別
description : string: エラーの説明
measure : string: 対処方法
detail : string: 詳細エラー情報

]