詳細ホスト情報の取得
詳細ホスト情報を取得します。
Request Interface
https://ControlURL/api/v1/managements/hosts/detail/{id}
WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。
詳細は以下を参照してください。
PATH PARAMETERS
- id : string
-
ホストID （必須）
登録済みIDを指定
Response Interface
200 管理情報の取得に成功
RESPONSE HEADERS
- X-Request-ID : string
-
WebAPI履歴のリクエストID
RESPONSE SCHEMA : application/json
- id : string
-
ホストID
- meta : object
-
メタ情報
- modified_datetime : string <date-time>
-
更新日時
- modified_user : string
-
更新ユーザー
- request_user : object
-
ロール情報
- systems_role : string
-
APIを実行したユーザーの「ユーザーの権限」
- managements_id_role : string
-
APIを実行したユーザーの「管理情報の権限」
- display_name : string
-
表示名
- comment : string
-
コメント
- valid_term : object
-
管理情報の有効期間
- start : string <date-time>
-
有効期間 (開始)
- end : string <date-time>
-
有効期間 (終了)
- authorities : Array of objects
-
権限情報
以下の構造の情報（Array[]）が複数（～100）取得されます。
Array[
- type : string
-
ユーザーグループID/ユーザーID
以下のいずれかが取得されます。
- group
-
: ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定
- user
-
: ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定
- name : string
-
権限付与対象名
- role : string
-
管理情報の権限
以下のいずれかが取得されます。
- owner
-
: 所有者（管理情報に対してすべての操作が可能なユーザー）
- contributor
-
: 更新者（管理情報の情報を更新可能なユーザー）
- executor
-
: 実行者（管理情報を使用して、転送を開始できるユーザー）
- reader
-
: 閲覧者（管理情報を参照できるユーザー）
- auditor
-
: 監視者（履歴だけを参照できるユーザー）
]
- name : string
-
ホスト名
- port : integer
-
ポート番号
- type : string
-
ホスト種
以下のいずれかが取得されます。
- unix
-
: Container Services、Container Platform、Linux、UNIX、NonStop
- windows
-
: Windows
- host
-
: 汎用機
- code_set : string
-
転送コードセット
以下のいずれかが取得されます。
- utf8
-
: UTF-8
- sjis
-
: Shift-JIS
- euc_jp
-
: EUC-JP
- ibm_japan
-
: IBM漢字
- gb18030
-
: GB18030
- standard_for_japanese : string
-
日本語規格
以下のいずれかが取得されます。
- jis83
-
: JIS 83年度
- jis78
-
: JIS 78年度
- protocol : string
-
接続時プロトコル
以下のいずれかが取得されます。
- wss
-
: WebSocket Secureを使用
- hulft
-
: HULFT独自のプロトコルを使用
- proxy : object
-
HULFT Proxy URL
- url : string
-
HULFT Proxy URL
- notify_user : string
-
ユーザーの通知
以下のいずれかが取得されます。
- none
-
: ユーザーの通知を有効にしない
- allow
-
: ユーザーの通知を有効にする
- authentication_key : string <password>
-
認証キー
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)) or (Error3(object or null))
-
"Error1"、"Error2"、"Error3"のいずれかが取得されます。
- Error1
-
- message : string
-
エラーメッセージ
- tables : Array of strings
-
テーブル情報
- query : string
-
クエリ情報
- Error2
-
- hulft_id : string
-
HULFT ID
- code : integer
-
実行結果
- detail : integer
-
詳細コード
- message : string
-
エラーメッセージ
- Error3
-
- message : string
-
エラーメッセージ
- fields : string
-
クエリ情報
]
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
-
詳細エラー情報
- additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))
-
"Error1"、"Error2"、"Error3"のいずれかが取得されます。
- Error1
-
- message : string
-
エラーメッセージ
- tables : Array of strings
-
テーブル情報
- query : string
-
クエリ情報
- Error2
-
- hulft_id : string
-
HULFT ID
- code : integer
-
実行結果
- detail : integer
-
詳細コード
- message : string
-
エラーメッセージ
- Error3
-
- message : string
-
エラーメッセージ
- fields : string
-
クエリ情報
]
404 指定したIDまたは参照先の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
-
詳細エラー情報
- additional : (Error1(object or null)) or (Error2(object or null)) or (Error3(object or null))
-
"Error1"、"Error2"、"Error3"のいずれかが取得されます。
- Error1
-
- message : string
-
エラーメッセージ
- tables : Array of strings
-
テーブル情報
- query : string
-
クエリ情報
- Error2
-
- hulft_id : string
-
HULFT ID
- code : integer
-
実行結果
- detail : integer
-
詳細コード
- message : string
-
エラーメッセージ
- Error3
-
- message : string
-
エラーメッセージ
- fields : string
-
クエリ情報
]