詳細ホスト情報の登録および更新

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

Examples

REQUEST EXAMPLE

サンプルは以下となります。

{
  "id": "HOSTID",
  "meta": {
    "display_name": "display name",
    "comment": "sample comment",
    "valid_term": {
      "start": "2025-10-03T03:04:05+09:00",
      "end": "2025-10-04T03:04:05+09:00"
    }
  },
  "authorities": [
    {
      "type": "user",
      "name": "user_name",
      "role": "owner"
    }
  ],
  "name": "hostname",
  "port": 30000,
  "type": "windows",
  "code_set": "sjis",
  "standard_for_japanese": "jis83",
  "protocol": "hulft",
  "notify_user": "none",
  "authentication_key": "sample_auth_key_123"
}

Request Interface

https://ControlURL/api/v1/managements/hosts/detail

= 備考 =

WebAPIのControlURLで指定するパスはHULFTの管理画面にアクセスするためのURLと同じURLです。

詳細は以下を参照してください。

スタートアップガイド（EC2）: : 導入手順
スタートアップガイド（Fargate）: : 導入手順

REQUEST BODY SCHEMA : application/json

id : string

ホストID （必須）

255バイト以内で指定します。

英数字、“-”、および“.”で指定します。

meta : object

メタ情報（必須）

display_name : string

表示名（必須）

1024バイト以内で指定します。

comment : string

1024バイト以内で指定します。

valid_term : object

管理情報の有効期間

start : string <date-time>

有効期間 (開始)

end : string <date-time>

有効期間 (終了)

「有効期間 (終了)」は「有効期間 (開始)」より後の時間を指定します。

authorities : Array of objects

権限情報

最大権限情報数：100

以下の構造の情報（Array[]）を複数（～100）設定可能です。

Array[

type : string

ユーザーグループID/ユーザーID （必須）

管理情報に対する権限を保持している、ユーザーグループおよびユーザーのID

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

group: : ユーザーグループIDを、3バイトから255バイトの英数字、および半角スペース、“-”、“/”、“*”を除く記号で指定
user: : ユーザーIDを、1024バイト以内の英数字、および“/”を除く記号で指定

name : string

権限付与対象名（必須）

role : string

管理情報の権限（必須）

「ユーザーグループID」および「ユーザーID」の、管理情報に対する権限

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

owner: : 所有者（管理情報に対してすべての操作が可能なユーザー）
contributor: : 更新者（管理情報の情報を更新可能なユーザー）
executor: : 実行者（管理情報を使用して、転送を開始できるユーザー）
reader: : 閲覧者（管理情報を参照できるユーザー）
auditor: : 監視者（履歴だけを参照できるユーザー）

]

name : string

ホスト名（必須）

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

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

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

255バイト以内で指定します。

英数字、“-”、および“.”で指定します。

port : integer

ポート番号

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

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

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

ホスト種により指定可能な値が異なります。詳細は以下を参照してください。

ホスト種がunix

sjis、euc_jp、utf8、gb18030

ホスト種がwindows

sjis、utf8、gb18030

ホスト種がhost

utf8、ibm_japan

standard_for_japanese : string

日本語規格

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

日本語コード変換の場合のみ、設定値が有効となります。

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

jis83: : JIS 83年度
jis78: : JIS 78年度

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

protocol : string

接続時プロトコル

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

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

wss: : WebSocket Secureを使用
hulft: : HULFT独自のプロトコルを使用

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

proxy : object

HULFT Proxy URL

url : string

HULFT Proxy URL

4096バイト以内で指定します。

notify_user : string

ユーザーの通知

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

接続先ホストにユーザーIDを通知するかどうかを指定します。

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

none: : ユーザーの通知を有効にしない
allow: : ユーザーの通知を有効にする

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

authentication_key : string <password>

認証キー

ホスト名を識別するための認証キー

1024バイト以内で指定します。

英数字、および“/”、“*”を除く記号で指定

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>

認証キー

201 新規管理情報の登録に成功

RESPONSE HEADERS

X-Request-ID : string: WebAPI履歴のリクエストID
Location : string: 作成されたリソースのパス

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: クエリ情報

]