Oracle Enterprise ManagerのREST API

ターゲットのサブスクリプション・レポートの取得

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/targetsSubscriptionReport

ターゲットのサブスクリプション詳細の取得

リクエスト

この操作にはリクエスト・パラメータはありません。

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

application/json

ルート・スキーマ: schema

型: object

ソースの表示

exclusions: array exclusions

レスポンスで除外される詳細の配列
limit: number

現在のフェッチの制限(アイテムの合計数のみをフェッチするには、limit=0を設定する必要があります)

例: 10
page: string

Base 64でエンコードされたページ

例: b2Zmc2V0OjA
sort: string

オプションのソート方向に従ってフィールドをソートします。ソートでサポートされる属性は、'targetName'、'targetType'、'hostName'、'dataguardRole'、'release'、'platform'、'targetStatus'、'clusterName'、'isSubscribed'、'dbMachineName'です。有効なソート方向には、昇順と降順があります。ソート方向を指定しない場合、デフォルトでascが使用されます。

例: name:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsSubscriptionReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "exclusions":{
            "description":"Array of details to be excluded in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "TARGETS_DISTRIBUTION",
                    "TOTAL"
                ]
            }
        }
    }
}

すべてに一致

ソースの表示

object TargetsSubscriptionReportFilter

ターゲットのサブスクリプション・レポートのフィルタ

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsSubscriptionReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "exclusions":{
            "description":"Array of details to be excluded in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "TARGETS_DISTRIBUTION",
                    "TOTAL"
                ]
            }
        }
    }
}

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

型: array

レスポンスで除外される詳細の配列

ソースの表示

配列: string

指定可能な値: [ "TARGETS_DISTRIBUTION", "TOTAL" ]

{
    "description":"Array of details to be excluded in response",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "TARGETS_DISTRIBUTION",
            "TOTAL"
        ]
    }
}

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

型: object

ターゲットのサブスクリプション・レポートのフィルタ

ソースの表示

platform: string

ターゲットのプラットフォーム

例: linux_x64_86
releaseMatches: string

ターゲットのリリースでのワイルドカード検索

例: 19.14%
subscriptionType: string

デフォルト値: BOTH

指定可能な値: [ "SUBSCRIBED", "NOT_SUBSCRIBED", "BOTH" ]

サブスクリプション・タイプを表します
targetNameMatches: string

ターゲット名のワイルドカード検索

例: %orcl%
targetProperties: object targetProperties

ターゲットのプロパティ
targetTypes: array targetTypes

ターゲット・タイプの配列

{
    "description":"Filters for targets subscription report",
    "type":"object",
    "properties":{
        "targetTypes":{
            "description":"Array of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Properties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ],
            "type":"object"
        },
        "targetNameMatches":{
            "description":"Wildcard search on the target name",
            "type":"string",
            "example":"%orcl%"
        },
        "releaseMatches":{
            "description":"Wildcard search on release of the target",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x64_86"
        },
        "subscriptionType":{
            "description":"It describes the subscription type",
            "type":"string",
            "enum":[
                "SUBSCRIBED",
                "NOT_SUBSCRIBED",
                "BOTH"
            ],
            "default":"BOTH"
        }
    }
}

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

型: object

ターゲットのプロパティ

すべてに一致

ソースの表示

object TargetPropertyFilter

ターゲット・プロパティのフィルタ

{
    "description":"Properties of target",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPropertyFilter"
        }
    ],
    "type":"object"
}

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

型: array

ターゲット・タイプの配列

ソースの表示

配列:

指定可能な値: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"Array of target types",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

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

型: object

ターゲット・プロパティのフィルタ

ソースの表示

contactList: array contactList

連絡先のリスト
costCenterList: array costCenterList

コスト・センターのリスト
departmentList: array departmentList

部門のリスト
downtimeContactList: array downtimeContactList

停止時の連絡先のリスト
lifecycleStatusList: array lifecycleStatusList

ライフサイクルステータスのリスト
lineOfBusinessList: array lineOfBusinessList

ライン・オブ・ビジネスのリスト
locationList: array locationList

場所のリスト
siteList: array siteList

サイトのリスト

{
    "description":"Target property filters",
    "type":"object",
    "properties":{
        "contactList":{
            "description":"List of contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "downtimeContactList":{
            "description":"List of downtime contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costCenterList":{
            "description":"List of cost centers",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "departmentList":{
            "description":"List of departments",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineOfBusinessList":{
            "description":"List of line of business",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locationList":{
            "description":"List of locations",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteList":{
            "description":"List of sites",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStatusList":{
            "description":"List of lifecyclestatus",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

連絡先のリスト

ソースの表示

配列: string

{
    "description":"List of contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

コスト・センターのリスト

ソースの表示

配列: string

{
    "description":"List of cost centers",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

部門のリスト

ソースの表示

配列: string

{
    "description":"List of departments",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

停止時の連絡先のリスト

ソースの表示

配列: string

{
    "description":"List of downtime contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ライフサイクルステータスのリスト

ソースの表示

配列: string

{
    "description":"List of lifecyclestatus",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ライン・オブ・ビジネスのリスト

ソースの表示

配列: string

{
    "description":"List of line of business",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

場所のリスト

ソースの表示

配列: string

{
    "description":"List of locations",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

サイトのリスト

ソースの表示

配列: string

{
    "description":"List of sites",
    "type":"array",
    "items":{
        "type":"string"
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。ターゲットのサブスクリプション・レポートが取得されました。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object TargetsSubscriptionReport

ゴールド・イメージにサブスクライブされている/サブスクライブされていないターゲット・サブスクリプションの詳細

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsSubscriptionReport"
        }
    ]
}

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

型: object

ゴールド・イメージにサブスクライブされている/サブスクライブされていないターゲット・サブスクリプションの詳細

ソースの表示

count: number

現在のフェッチ内のターゲット数

例: 10
currentPage: string

Base 64でエンコードされた現在のページ

例: b2Zmc2V0OjA
items: array items

ターゲットの詳細
nextPage: string

Base 64でエンコードされた次のページ

例: b2Zmc2V0OjA
previousPage: string

Base 64でエンコードされた前のページ

例: b2Zmc2V0OjA
targetsDistribution: array targetsDistribution

ターゲット・タイプ、リリースおよびプラットフォーム別にグループ化されたターゲットの統計
total: number

ターゲットの総数

例: 20

{
    "description":"Target subscription details, which are subscribed/not subscribed to gold image",
    "type":"object",
    "properties":{
        "targetsDistribution":{
            "description":"Statistics of targets grouped by targettype, release and platform",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetsDistributionStatistics"
                    }
                ]
            }
        },
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets",
            "type":"number",
            "example":"20"
        },
        "count":{
            "description":"Count of targets in the current fetch",
            "type":"number",
            "example":"10"
        },
        "items":{
            "description":"Target details",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetSubscriptionDetails"
                    }
                ]
            }
        }
    }
}

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

型: array

ターゲットの詳細

ソースの表示

配列: items

{
    "description":"Target details",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetSubscriptionDetails"
            }
        ]
    }
}

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

型: array

ターゲット・タイプ、リリースおよびプラットフォーム別にグループ化されたターゲットの統計

ソースの表示

配列: items

{
    "description":"Statistics of targets grouped by targettype, release and platform",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetsDistributionStatistics"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object allOf TargetSubscriptionDetails

ターゲットの詳細

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetSubscriptionDetails"
        }
    ]
}

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

型: object

ターゲットの詳細

ソースの表示

dbMachineName: string

DBマシン名

例: myDbMachine.oracle.com
isSubscribed: boolean

ターゲットがサブスクライブされているかどうかを示すフラグ

例: false

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "isSubscribed":{
            "description":"Flag to indicate if target is subscribed",
            "type":"boolean",
            "example":false
        },
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

すべてに一致

ソースの表示

object TargetDetails

ターゲットの詳細

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "isSubscribed":{
            "description":"Flag to indicate if target is subscribed",
            "type":"boolean",
            "example":false
        },
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

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

型: object

ターゲットの詳細

ソースの表示

clusterName: string

クラスタの名前

例: phxem0405c
dataguardRole: string

Data Guardロールの列挙
displayName: string

ターゲットの表示名

例: sdb2ra00
hostname: string

ホスト名

例: myHostName.mycompany.com
isCdb: string

DBがCDBかどうかを示すフラグ

例: true
platform: string

ターゲットのプラットフォーム

例: Linux_AMD64
release: string

データベース・リリース

例: 19.14.0.0.0
targetId: string

ターゲットのID

例: 09216A9333889316155C3B7DFF9820C7
targetName: string

ターゲットの名前

例: sdb2ra00
targetStatus: number

ターゲットのステータス

例: 1
targetType: string

指定可能な値: [ "rac_database", "oracle_database", "cluster", "has" ]

ターゲットのタイプ

{
    "description":"details of target",
    "type":"object",
    "properties":{
        "targetId":{
            "description":"Id of the target",
            "type":"string",
            "example":"09216A9333889316155C3B7DFF9820C7"
        },
        "targetName":{
            "description":"name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "targetType":{
            "description":"type of the target",
            "type":"string",
            "enum":[
                "rac_database",
                "oracle_database",
                "cluster",
                "has"
            ]
        },
        "targetStatus":{
            "description":"status of the target",
            "type":"number",
            "example":"1"
        },
        "displayName":{
            "description":"display name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isCdb":{
            "description":"Flag to indicate if the DB is CDB",
            "type":"string",
            "example":"true"
        },
        "hostname":{
            "description":"name of the host",
            "type":"string",
            "example":"myHostName.mycompany.com"
        },
        "clusterName":{
            "description":"name of the cluster",
            "type":"string",
            "example":"phxem0405c"
        },
        "release":{
            "description":"database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"Linux_AMD64"
        }
    }
}

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

すべてに一致

ソースの表示

object TargetsDistributionStatistics

リリースおよびプラットフォームに基づくターゲットの統計

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsDistributionStatistics"
        }
    ]
}

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

型: object

リリースおよびプラットフォームに基づくターゲットの統計

ソースの表示

count: number

ターゲット数

例: 10
platform: string

ターゲットのプラットフォーム

例: linux_x86_64
release: string

データベース・リリース

例: 19.14.0.0.0
targetType: string

指定可能な値: [ "oracle_database", "rac_database", "has", "cluster" ]

ターゲット・タイプ

{
    "description":"Statistics of targets based on release and platform",
    "type":"object",
    "properties":{
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "rac_database",
                "has",
                "cluster"
            ]
        },
        "count":{
            "description":"Count of targets",
            "type":"number",
            "example":"10"
        },
        "release":{
            "description":"Database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x86_64"
        }
    }
}

例

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"
        }
    }
}

先頭に戻る