# 詳細ホスト情報の更新

登録済みの詳細ホスト情報を更新します。

## Examples

REQUEST EXAMPLE

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

    {
      "comment": "MFHOST2",
      "receive_port": 40000,
      "observe_port": 41000,
      "send_multiplex_level": 15,
      "proxy_server": {
        "name": "MYPROXY2",
        "port": 60000
      },
      "security_setting": {
        "allow_instant_transfer": "allow"
      }
    }

## Request Interface

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

= 備考 =

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

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

PATH PARAMETERS

id : string

  ホスト名 （必須）

  詳細ホスト情報に登録済みの「ホスト名」を指定

REQUEST BODY SCHEMA : application/json

comment : string

  コメント

  ホストに対するコメント

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

host_type : string

  ホスト種

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

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

  mainframe (H)

    : 汎用機

  linux (L)

    : Linux/UNIX

  unix (L)

    : Linux/UNIX

  windows (W)

    : WindowsNT系OS

  ibmi (I)

    : IBM i

  windows9x (9)

    : Windows9x系OS(HULFT8のみ使用可能)

  k (K)

    : 富士通Kシリーズ(HULFT8のみ使用可能)

  接続先ホストのバージョンに合わせて、ホスト種を指定してください。

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簡体字

  keis (K)

    : KEIS

  nec (N)

    : NEC

  ホスト種と接続先のバージョンにより指定可能な値が異なります。詳細は以下を参照してください。

  ホスト種が“mainframe”

  - HULFT10: "jef"、"utf8"、"ibm_japan"

  - HULFT8: "jef"、"utf8"、"ibm_japan"、"keis"、"nec"

  ホスト種が“linux”もしくは“unix”

  - “sjis”、“euc_jp”、“utf8”、“gb18030”

  ホスト種が“windows”

  - “sjis”、“utf8”、“gb18030”

  ホスト種が“ibmi”

  - “ibm_japan”、“utf8”、“ibm_simplified_chinese”

  ホスト種が“windows9x”

  - “sjis”

  ホスト種が“k”

  - “jef”

receive_port : integer

  集信ポートNO.

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

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

observe_port : integer

  要求受付ポートNO.

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

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

send_multiplex_level : integer

  ホスト別配信多重度

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

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

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

  「ホスト別配信多重度」には、システム動作環境設定の「配信起動タスク数（TASK-CNT）」以下の値を設定するようにしてください。

  HULFT8 for XSP、あるいはHULFT8 for MSPを接続している場合、0～50の範囲で指定してください。

standard_for_japanese : string

  日本語規格

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

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

  78jis (0)

    : JIS78

  83jis (1)

    : JIS83

connect_type : string

  接続形態

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

  以下の値を指定します。

  lan (L)

    : LAN接続

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

hulft7_mode : string

  HULFT7通信モード

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

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

  enable (Y)

    : 最初からHULFT7の通信方法で接続する

  disable (N)

    : まずHULFT8の通信方法で接続し、相手ホストが下位バージョンだった場合はHULFT7の通信方法に切り替える

proxy_server : object

  Proxyサーバー

  name : string

    Proxyサーバー名 （必須）

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

  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_huljob : string

    集信後ジョブ結果参照

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

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

    allow (Y)

      : サービスを受け付ける

    none (N)

      : サービスの受け付けを拒否する

  allow_hulsndrc : string

    ジョブ実行結果通知

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

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

    allow (Y)

      : サービスを受け付ける

    none (N)

      : サービスの受け付けを拒否する

  allow_hulrjob : string

    リモートジョブ実行

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

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

    allow (Y)

      : サービスを受け付ける

    none (N)

      : サービスの受け付けを拒否する

  allow_instant_transfer : string

    簡易転送要求

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

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

    allow (Y)

      : 簡易転送を受け付ける

    none (N)

      : 簡易転送の受け付けを拒否する

notify_user : string

  ユーザIDを通知

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

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

  allow (Y)

    : 通知する

  none (N)

    : 通知しない

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

## Response Interface

### 200 OK 情報更新

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

      : 汎用機環境管理情報

  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)

    : WindowsNT系OS

  ibmi (I)

    : IBM i

  windows9x (9)

    : Windows9x系OS(HULFT8のみ使用可能)

  k (K)

    : 富士通Kシリーズ(HULFT8のみ使用可能)

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簡体字

  keis (K)

    : KEIS

  nec (N)

    : NEC

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

    詳細エラー情報

  ]

### 404 指定した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

    詳細エラー情報

  ]