FPPサーバーの登録
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers
データベース・メンテナンスの実行に必要な詳細とともに、FPPサーバーをEnterprise Managerに登録します
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ: schema
型:
object
FPPサーバーを登録するための入力
ソースの表示
-
name(必須): string
FPPサーバー・ターゲット名
-
properties(必須): object properties
登録するFPPサーバー・プロパティ
-
restUser(必須): CreateRestUserDetails
RESTユーザーの詳細
-
schedule: object Schedule
スケジュールの詳細
ネストされたスキーマ: properties
型:
object
登録するFPPサーバー・プロパティ
ソースの表示
-
agentCredential(必須): string
エージェントの名前付き資格証明 - CREDENTIAL:OWNER (OWNERはオプションです)例:
NC_DEV:ADMIN, NC_DEV
-
restUrl(必須): string
FPPサーバーに登録するREST URL例:
https://xyz.com:portnumber/em/api/fppServers
ネストされたスキーマ: CreateRestUserDetails
型:
object
RESTユーザーの詳細
ソースの表示
-
password(必須): string (password)
FPP REST URLをコールするために必要なREST資格証明をEMで作成するためのパスワード例:
welcome1
-
username(必須): string
FPPサーバーに登録するRESTユーザー名
ネストされたスキーマ: Schedule
型:
object
スケジュールの詳細
ソースの表示
-
isTargetZone: boolean
時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
-
recurring: string
操作を繰り返し実行する必要がある頻度例:
frequency:weekly;days:2,
-
scheduleType: string
現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
-
startGracePeriodInMinutes: integer
開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。例:
60
-
timeToEnd: string (date-time)
終了時間
-
timeToStart: string (date-time)
開始時間
例
先頭に戻る
レスポンス
201レスポンス
400レスポンス
不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
401レスポンス
未認可。ユーザーにはリクエストされた操作を実行する権限がありません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
403レスポンス
禁止。ユーザーは、リクエストされた操作の実行を禁止されています
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
404レスポンス
見つかりません。リクエストされたREST API URLが見つかりません。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
500レスポンス
内部サーバー・エラー。REST APIの実行中に例外が発生しました。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
サービスが使用できません。サーバーはリクエストを処理できません。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列