Oracle Enterprise ManagerのREST API

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

スケジュールの詳細

{
    "description":"Input to register the FPP server",
    "type":"object",
    "required":[
        "name",
        "properties",
        "restUser"
    ],
    "properties":{
        "name":{
            "description":"FPP server target name",
            "type":"string"
        },
        "properties":{
            "description":"FPP server properties to be registered",
            "type":"object",
            "required":[
                "restUrl",
                "agentCredential"
            ],
            "properties":{
                "restUrl":{
                    "description":"REST url to be registered with the FPP server",
                    "type":"string",
                    "example":"https://xyz.com:portnumber/em/api/fppServers"
                },
                "agentCredential":{
                    "description":"Named credential of the agent - CREDENTIAL:OWNER, where OWNER is optional",
                    "type":"string",
                    "example":"NC_DEV:ADMIN, NC_DEV"
                }
            }
        },
        "restUser":{
            "$ref":"#/components/schemas/CreateRestUserDetails"
        },
        "schedule":{
            "$ref":"#/components/schemas/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

{
    "description":"FPP server properties to be registered",
    "type":"object",
    "required":[
        "restUrl",
        "agentCredential"
    ],
    "properties":{
        "restUrl":{
            "description":"REST url to be registered with the FPP server",
            "type":"string",
            "example":"https://xyz.com:portnumber/em/api/fppServers"
        },
        "agentCredential":{
            "description":"Named credential of the agent - CREDENTIAL:OWNER, where OWNER is optional",
            "type":"string",
            "example":"NC_DEV:ADMIN, NC_DEV"
        }
    }
}

ネストされたスキーマ: CreateRestUserDetails

型: object

RESTユーザーの詳細

ソースの表示

password(必須): string (password)

FPP REST URLをコールするために必要なREST資格証明をEMで作成するためのパスワード

例: welcome1
username(必須): string

FPPサーバーに登録するRESTユーザー名

{
    "description":"Details of REST user",
    "required":[
        "username",
        "password"
    ],
    "properties":{
        "username":{
            "description":"REST username to be registered with the FPP server",
            "type":"string"
        },
        "password":{
            "description":"Password to create the REST credential in EM, which is required to make a call to the FPP REST URL",
            "type":"string",
            "format":"password",
            "example":"welcome1"
        }
    }
}

ネストされたスキーマ: 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)

開始時間

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":"60"
        }
    }
}

例

先頭に戻る

レスポンス

201レスポンス

FPPサーバーが登録されました。

ヘッダー

Location:
例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る