デプロイメント・プロシージャ・インスタンスの詳細の取得
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances/{deploymentProcedureInstanceId}
デプロイメント・プロシージャ・インスタンスの詳細を取得します。前述のAPIを使用して、'get_instance_data'および'get_instance_status'を取得できます。
リクエスト
パス・パラメータ
- deploymentProcedureInstanceId(必須): string
インスタンスのID。
問合せパラメータ
- exclude: string
exclude=executionIdまたはownerの場合は、executionIdまたはownerに関する情報がレスポンスから除外されます
- include: string
include=totalの場合は、返されたレコードの合計数に関する情報がレスポンスに含まれます
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/xml
- application/json
200レスポンス
インスタンスが正常に返されました
ルート・スキーマ: DeploymentProcedureInstance
型:
object
プロシージャ・インスタンスを表します
すべてに一致
プロシージャ・インスタンスを表します
ソースの表示
- object DeploymentProcedureInstanceDetails
これは、インスタンスを表すものです。
ネストされたスキーマ: DeploymentProcedureInstanceDetails
型:
object
これは、インスタンスを表すものです。
ソースの表示
-
executionId: string
インスタンスの実行ID例:
CC67DA5B8AD02268E053E00F4B64265F
-
id: string
インスタンスの一意の識別子例:
B0FBBE587FD201E2E0537013790A7D03
-
instanceData: object instanceData
デプロイメント・プロシージャの発行中に使用されるデータ
-
links: object links
インスタンス関連リンク
-
name: string
インスタンスの名前例:
HOST_COMMAND
-
owner: string
インスタンスの所有者例:
SYSMAN
-
procedureType: string
プロシージャのタイプ例:
UserDefined
-
status: string
インスタンスのステータス例:
Succeeded
-
statusDetails: object statusDetails
デプロイメント・プロシージャ・インスタンスのステータスの詳細
ネストされたスキーマ: instanceData
型:
object
デプロイメント・プロシージャの発行中に使用されるデータ
すべてに一致
デプロイメント・プロシージャの発行中に使用されるデータ
ソースの表示
- object allOf InstanceData
これは、インスタンス発行データを表すものです。
ネストされたスキーマ: statusDetails
型:
object
デプロイメント・プロシージャ・インスタンスのステータスの詳細
すべてに一致
デプロイメント・プロシージャ・インスタンスのステータスの詳細
ソースの表示
- object DeploymentProcedureInstanceStatusDetails
これは、詳細でのプロシージャ・インスタンスのステータスを表すものです。
ネストされたスキーマ: InstanceData
型:
object
これは、インスタンス発行データを表すものです。
すべてに一致
これは、インスタンス発行データを表すものです。
これは、インスタンス発行データを表すものです。
ソースの表示
- array DeploymentProcedureTargetList
プロシージャ・ターゲットのリストの定義
- object DeploymentProcedureVariableCollection
プロシージャ変数のコレクション
ネストされたスキーマ: DeploymentProcedureVariableCollection
型:
object
プロシージャ変数のコレクション
ソースの表示
-
items: array items
プロシージャ変数のリスト
ネストされたスキーマ: items
型:
ソースの表示
object
-
name: string
ターゲット・タイプの名前例:
host
-
targets: object DeploymentProcedureTargetCollection
プロシージャ・ターゲットのコレクション
ネストされたスキーマ: DeploymentProcedureTargetCollection
型:
object
プロシージャ・ターゲットのコレクション
ソースの表示
-
items: array items
ターゲットのリスト
ネストされたスキーマ: items
型:
array
ターゲットのリスト
ソースの表示
- 配列: object DeploymentProcedureTargetSummary
これは、プロシージャ・ターゲットを表すものです
ネストされたスキーマ: DeploymentProcedureTargetSummary
型:
object
これは、プロシージャ・ターゲットを表すものです
すべてに一致
これは、プロシージャ・ターゲットを表すものです
ソースの表示
- object DeploymentProcedureTargetDetails
デプロイメント・プロシージャのターゲットの定義
ネストされたスキーマ: DeploymentProcedureTargetDetails
型:
object
デプロイメント・プロシージャのターゲットの定義
ソースの表示
-
credentialReferences: array CredentialReference
これは、資格証明参照を表すものです。
-
targetName: string
ターゲット名例:
host1.oracle.com
-
targetType: string
ターゲット・タイプ例:
host
ネストされたスキーマ: items
型:
ソースの表示
object
-
credentialName: string
資格証明名を表します例:
EMGA
-
credentialType: string
資格証明のタイプを表します例:
NAMED
-
owner: string
資格証明の所有者を表します例:
SYSMAN
-
usage: string
資格証明の使用方法を表します例:
defaultHostCred
ネストされたスキーマ: items
型:
array
プロシージャ変数のリスト
ソースの表示
- 配列: object DeploymentProcedureVariableSummary
これは、プロシージャ変数を表すものです
ネストされたスキーマ: DeploymentProcedureVariableSummary
型:
object
これは、プロシージャ変数を表すものです
すべてに一致
これは、プロシージャ変数を表すものです
ソースの表示
- object DeploymentProcedureVariableDetails
デプロイメント・プロシージャの変数の定義
ネストされたスキーマ: DeploymentProcedureVariableDetails
型:
object
デプロイメント・プロシージャの変数の定義
ソースの表示
-
variableName: string
デプロイメント・プロシージャの変数名を表示します例:
userId
-
variableValue: string
デプロイメント・プロシージャの変数値を表示します例:
10001
ネストされたスキーマ: DeploymentProcedureInstanceStatusDetails
型:
object
これは、詳細でのプロシージャ・インスタンスのステータスを表すものです。
ソースの表示
-
createdBy: string
インスタンスの所有者例:
SYSMAN
-
dataId: string
データGUIDを表します例:
CC186E3706C349BBE053E00F4B64AB8F
-
elapsedTime: string
インスタンスの経過時間例:
8 seconds
-
errorHandling: string
エラー処理を表します
-
procedureId: string
プロシージャの一意の識別子例:
CC01BDC5DA734370E053E00F4B64B23D
-
status: string
インスタンスのステータス例:
FAILED
-
stepDetails: array stepDetails
ステップの詳細を表します
ネストされたスキーマ: Phase
型:
object
フェーズとそのステップの情報を表します
ソースの表示
-
steps: array steps
ステップを表します
すべてに一致
フェーズとそのステップの情報を表します
ソースの表示
- object PhaseStepDetails
これは、フェーズ・ステップを表すものです。
ネストされたスキーマ: PhaseStepDetails
型:
object
これは、フェーズ・ステップを表すものです。
ソースの表示
-
stepDetails: array stepDetails
ステップの詳細を表します
-
steps: object StepDetails
これは、ステップを表すものです。
ネストされたスキーマ: StepDetails
型:
object
これは、ステップを表すものです。
ソースの表示
-
errorMode: string
エラーのモードを表します例:
stop
-
id: string
ステップIDを表します例:
s1
-
isEnabled: boolean
ステップが有効かどうかを表します例:
true
-
parentId: string
親GUIDを表します。例:
default_phase
-
stateDetails: object StateDetails
これは、状態を表すものです。
-
stepType: string
ステップのタイプを表します例:
Host Command Step
-
timeCompleted: string
ステップの完了時間を表します例:
2021-09-16 07:05:48.0
-
timeStarted: string
ステップの開始時間を表します例:
2021-09-16 07:05:44.0
-
timeUpdated: string
ステップの最終更新時間を表します例:
2021-09-16 07:05:48.0
-
typeStep: string
ステップ・タイプを表します例:
Step
ネストされたスキーマ: StateDetails
型:
object
これは、状態を表すものです。
ソースの表示
-
id: string
状態IDを表します例:
CC1871802C4343A3E053E00F4B640973
-
jobDetails: object JobDetails
これは、ジョブを表すものです
-
parentId: string
親GUIDを表します例:
CC1871802C4243A3E053E00F4B640973
-
phaseDetails: object PhaseDetails
これは、フェーズを表すものです
-
status: string
状態ステータスを表します例:
FAILED
-
timeCompleted: string
状態の完了時間を表します例:
2021-09-16 07:05:48.0
-
timeStarted: string
状態の開始時間を表します例:
2021-09-16 07:05:44.0
-
timeUpdated: string
状態の最終更新時間を表します例:
2021-09-16 07:05:48.0
ネストされたスキーマ: JobDetails
型:
object
これは、ジョブを表すものです
ソースの表示
-
jobDetails: object JobStep
これは、ジョブ・ステップを表すものです
-
jobExecutionId: string
ジョブ実行IDを表します例:
CC1871802C4643A3E053E00F4B640973
-
jobId: string
ジョブIDを表します例:
CC1871802C4443A3E053E00F4B640973
-
jobName: string
ジョブ名を表します例:
S1_CC1871802C4343A3E053E00F4B640973
-
jobStatus: string
ジョブ・ステータスを表します例:
Aborted
-
jobType: string
ジョブ・タイプを表します例:
HostCommand
-
timeStarted: string
ジョブ開始時間を表します例:
2021-09-16 07:05:46 GMT
ネストされたスキーマ: PhaseDetails
型:
object
これは、フェーズを表すものです
ソースの表示
-
targetName: string
ターゲット名を表します例:
host1.us.oracle.com
-
targetType: string
ターゲット・タイプを表します例:
host
ネストされたスキーマ: JobStep
型:
object
これは、ジョブ・ステップを表すものです
ソースの表示
-
command: string
ジョブ・コマンドを表します例:
remoteOp
-
name: string
ジョブ名を表します例:
SS_RemoteOp
-
output: string
ジョブ出力を表します
-
status: string
ジョブ・ステータスを表します例:
Aborted
400レスポンス
不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
401レスポンス
未認可。ユーザーにはリクエストされた操作を実行する権限がありません
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
404レスポンス
見つかりません。リクエストされたREST API URLが見つかりません。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
500レスポンス
内部サーバー・エラー。REST APIの実行中に例外が発生しました。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported
503レスポンス
サービスが使用できません。サーバーはリクエストを処理できません。
ルート・スキーマ: ErrorResponse
型:
object
エラー発生時に返送されるレスポンス
ソースの表示
-
code: string
エラーのステータス・コード。例:
IllegalArgument
-
message: string
説明的なエラー・メッセージ例:
argument given is not supported