Oracle Enterprise ManagerのREST API

デプロイメント・プロシージャ実行(複数)の取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances/{deploymentProcedureInstanceId}/executions

指定されたフィルタ基準に対するデプロイメント・プロシージャ実行のリストを返します。デフォルトでは、直近20回の実行を示します。

リクエスト

パス・パラメータ

deploymentProcedureInstanceId(必須): string

インスタンスのID。

問合せパラメータ

include: string

include=runtimeDataの場合、ランタイム・データに関する情報がレスポンスに含まれます
limit: integer

最小値: 1

最大値: 2000

リストのページ分割用。ページ当たりの最大結果数、またはページ分割される"List"コールで返すアイテムの最大数。このAPIでは、limitとして指定した数より多を返すことはありませんが、その数が必ずしも返されるというわけではありません。

デフォルト値: 20
page: string

ページのシステム生成ページ・トークン。
sort: string

ソートされたデプロイメント・プロシージャ実行を返します。指定可能なフィールドは、実行GUIDです。指定可能な方向はDESCとASCです

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

実行のリストが正常に返されました

ルート・スキーマ: ExecutionCollection

型: object

これは、実行のリストを表すものです。

ソースの表示

items(必須): array items

実行のリスト

{
    "description":"This is the representation of list of Executions.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of executions",
            "items":{
                "$ref":"#/components/schemas/ExecutionSummary"
            }
        }
    }
}

すべてに一致

これは、実行のリストを表すものです。

ソースの表示

object CountLinks

これは、countやlinksなどのページ区切りプロパティを表します。

{
    "description":"This is the representation of list of Executions.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CountLinks"
        }
    ],
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of executions",
            "items":{
                "$ref":"#/components/schemas/ExecutionSummary"
            }
        }
    }
}

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

型: array

実行のリスト

ソースの表示

配列: object ExecutionSummary

これは、実行を表すものです。

{
    "type":"array",
    "description":"The list of executions",
    "items":{
        "$ref":"#/components/schemas/ExecutionSummary"
    }
}

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

型: object

これは、countやlinksなどのページ区切りプロパティを表します。

ソースの表示

count: integer

これは、ページ内の要素の合計数を表します。

例: 20
links: object links

読取り専用: true

結果セットのナビゲーション・リンク

{
    "description":"This represents pagination properties like count and links.",
    "properties":{
        "count":{
            "description":"This represents total number of elements in a page.",
            "type":"integer",
            "example":"20"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"The result set navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

これは、実行を表すものです。

すべてに一致

これは、実行を表すものです。

ソースの表示

object ExecutionDetails

実行を表します。

{
    "description":"This is the representation of an Execution.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExecutionDetails"
        }
    ]
}

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

型: object

実行を表します。

ソースの表示

id: string

実行の一意の識別子

例: CDAAE80FDD3D7987E053E00F4B64DEBB
links: object links

実行関連リンク
name: string

インスタンスの名前

例: hostcmd-executiontest
runtimeData: object runtimeData

実行のランタイム・データ
status: string

実行のステータスを表します

例: COMPLETED

{
    "description":"It represents an execution.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for an execution",
            "example":"CDAAE80FDD3D7987E053E00F4B64DEBB"
        },
        "name":{
            "type":"string",
            "description":"Name of of an instance",
            "example":"hostcmd-executiontest"
        },
        "status":{
            "type":"string",
            "description":"Represents status of an execution",
            "example":"COMPLETED"
        },
        "runtimeData":{
            "type":"object",
            "description":"Execution run time data",
            "allOf":[
                {
                    "$ref":"#/components/schemas/InstanceData"
                }
            ]
        },
        "links":{
            "type":"object",
            "description":"the Execution related links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

実行関連リンク

ソースの表示

self: object Link

REST APIを参照するリンク。

{
    "type":"object",
    "description":"the Execution related links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

実行のランタイム・データ

すべてに一致

実行のランタイム・データ

ソースの表示

object allOf InstanceData

これは、インスタンス発行データを表すものです。

{
    "type":"object",
    "description":"Execution run time data",
    "allOf":[
        {
            "$ref":"#/components/schemas/InstanceData"
        }
    ]
}

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

型: object

REST APIを参照するリンク。

ソースの表示

href: string

リンクURL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

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

型: object

これは、インスタンス発行データを表すものです。

すべてに一致

これは、インスタンス発行データを表すものです。

ソースの表示

array DeploymentProcedureTargetList

プロシージャ・ターゲットのリストの定義
object DeploymentProcedureVariableCollection

プロシージャ変数のコレクション

{
    "description":"This is the representation of instance submission data.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetList"
        },
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableCollection"
        }
    ]
}

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

型: array

プロシージャ・ターゲットのリストの定義

ソースの表示

配列: object items

{
    "description":"Defining list of procedure targets",
    "type":"array",
    "items":{
        "properties":{
            "name":{
                "type":"string",
                "description":"name of target type",
                "example":"host"
            },
            "targets":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
            }
        }
    }
}

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

型: object

プロシージャ変数のコレクション

ソースの表示

items: array items

プロシージャ変数のリスト

{
    "description":"Collections of Procedure Variable",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of procedure variables",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
            }
        }
    }
}

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

型: object

ソースの表示

name: string

ターゲット・タイプの名前

例: host
targets: object DeploymentProcedureTargetCollection

プロシージャ・ターゲットのコレクション

{
    "properties":{
        "name":{
            "type":"string",
            "description":"name of target type",
            "example":"host"
        },
        "targets":{
            "$ref":"#/components/schemas/DeploymentProcedureTargetCollection"
        }
    }
}

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

型: object

プロシージャ・ターゲットのコレクション

ソースの表示

items: array items

ターゲットのリスト

{
    "description":"Collections of Procedure Target",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"The list of targets",
            "items":{
                "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
            }
        }
    }
}

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

型: array

ターゲットのリスト

ソースの表示

配列: object DeploymentProcedureTargetSummary

これは、プロシージャ・ターゲットを表すものです

{
    "type":"array",
    "description":"The list of targets",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureTargetSummary"
    }
}

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

型: object

これは、プロシージャ・ターゲットを表すものです

すべてに一致

これは、プロシージャ・ターゲットを表すものです

ソースの表示

object DeploymentProcedureTargetDetails

デプロイメント・プロシージャのターゲットの定義

{
    "description":"This is the representation of Procedure Target",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureTargetDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャのターゲットの定義

ソースの表示

credentialReferences: array CredentialReference

これは、資格証明参照を表すものです。
targetName: string

ターゲット名

例: host1.oracle.com
targetType: string

ターゲット・タイプ

例: host

{
    "description":"Defining Target for Deployment Procedure",
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Target Name",
            "example":"host1.oracle.com"
        },
        "targetType":{
            "type":"string",
            "description":"Target Type",
            "example":"host"
        },
        "credentialReferences":{
            "$ref":"#/components/schemas/CredentialReference"
        }
    }
}

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

型: array

これは、資格証明参照を表すものです。

ソースの表示

配列: object items

{
    "description":"This is the representation of credential references.",
    "type":"array",
    "items":{
        "properties":{
            "usage":{
                "type":"string",
                "description":"Represents credential usage",
                "example":"defaultHostCred"
            },
            "credentialType":{
                "type":"string",
                "description":"Represents type of the credential",
                "example":"NAMED"
            },
            "owner":{
                "type":"string",
                "description":"Represents owner of the credential",
                "example":"SYSMAN"
            },
            "credentialName":{
                "type":"string",
                "description":"Represents credential name",
                "example":"EMGA"
            }
        }
    }
}

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

型: object

ソースの表示

credentialName: string

資格証明名を表します

例: EMGA
credentialType: string

資格証明のタイプを表します

例: NAMED
owner: string

資格証明の所有者を表します

例: SYSMAN
usage: string

資格証明の使用方法を表します

例: defaultHostCred

{
    "properties":{
        "usage":{
            "type":"string",
            "description":"Represents credential usage",
            "example":"defaultHostCred"
        },
        "credentialType":{
            "type":"string",
            "description":"Represents type of the credential",
            "example":"NAMED"
        },
        "owner":{
            "type":"string",
            "description":"Represents owner of the credential",
            "example":"SYSMAN"
        },
        "credentialName":{
            "type":"string",
            "description":"Represents credential name",
            "example":"EMGA"
        }
    }
}

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

型: array

プロシージャ変数のリスト

ソースの表示

配列: object DeploymentProcedureVariableSummary

これは、プロシージャ変数を表すものです

{
    "type":"array",
    "description":"The list of procedure variables",
    "items":{
        "$ref":"#/components/schemas/DeploymentProcedureVariableSummary"
    }
}

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

型: object

これは、プロシージャ変数を表すものです

すべてに一致

これは、プロシージャ変数を表すものです

ソースの表示

object DeploymentProcedureVariableDetails

デプロイメント・プロシージャの変数の定義

{
    "description":"This is the representation of Procedure Variable",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DeploymentProcedureVariableDetails"
        }
    ]
}

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

型: object

デプロイメント・プロシージャの変数の定義

ソースの表示

variableName: string

デプロイメント・プロシージャの変数名を表示します

例: userId
variableValue: string

デプロイメント・プロシージャの変数値を表示します

例: 10001

{
    "description":"Defining Variable for Deployment Procedure",
    "type":"object",
    "properties":{
        "variableName":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale name",
            "example":"userId"
        },
        "variableValue":{
            "type":"string",
            "description":"Displays Deployment Procedure varibale value",
            "example":"10001"
        }
    }
}

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

型: object

読取り専用: true

結果セットのナビゲーション・リンク

ソースの表示

next: object Link

REST APIを参照するリンク。
previous: object Link

REST APIを参照するリンク。
self: object Link

REST APIを参照するリンク。

{
    "type":"object",
    "readOnly":true,
    "description":"The result set navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

400レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503レスポンス

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

ルート・スキーマ: ErrorResponse

型: object

エラー発生時に返送されるレスポンス

ソースの表示

code: string

エラーのステータス・コード。

例: IllegalArgument
message: string

説明的なエラー・メッセージ

例: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

先頭に戻る