HULFT接続確認

接続先ホストへの接続確認を行います。

Examples

RESPONSE EXAMPLE

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

接続先v10

{
  "meta": {
    "request_user_role": "admin"
  },
  "os_type": "windows",
  "version": "v10",
  "product_version": "V10L02R00P00",
  "huladmin_version": "V10L02",
  "is_connectable": true,
  "strong_key_mode": "disable",
  "need_to_be_loggedin": false
}

接続先v7（接続サポート対象外）

{
  "meta": {
    "request_user_role": "admin"
  },
  "os_type": "unsupported",
  "version": "v7",
  "is_connectable": false
}

接続先v8（接続サポート対象外）

{
  "meta": {
    "request_user_role": "admin"
  },
  "os_type": "windows",
  "version": "v8",
  "product_version": "V08L05R02PA0",
  "huladmin_version": "V08L04",
  "is_connectable": false,
  "strong_key_mode": "enable",
  "need_to_be_loggedin": false
}

Request Interface

http://ControlURL/api/v1/hulft/{hulft-host-id}/health

= 備考 =

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

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

Response Interface

200 OK

RESPONSE HEADERS

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

RESPONSE SCHEMA : application/json

meta : object

request_user_role : string

API実行ユーザーの権限

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

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

os_type : string

接続先ホスト機種

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

windows: : Windows環境
linux: : Linux/AIX環境
ibmi: : IBM i（AS/400）環境
zos: : z/OS（汎用機）環境
unsupported: : 上記以外の環境

version : string

バージョン

接続先HULFTのメジャーバージョン

通信の内容から接続先HULFTのバージョンを推測します。

product_version : string

製品バージョン

接続先HULFTの製品バージョン

取得が可能だった場合のみ表示。

huladmin_version : string

HULADMINバージョン

接続先HULFTが対応しているHULADMINバージョン

取得が可能だった場合のみ表示。

is_connectable : boolean

接続サポート有無

strong_key_mode : string

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

有効な場合は、配信管理情報登録時および集信管理情報登録時に64桁の暗号キーの指定が必須

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

disable: : 無効
enable: : 有効

need_to_be_loggedin : boolean

パスワードチェック有無

管理画面セキュリティのパスワードチェックが有効な環境には接続できません。

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: 詳細エラー情報

]

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: 詳細エラー情報

]