Oracle Enterprise ManagerのREST API

ターゲット・プロパティの取得

get

https://EM_HOST:8080/em/api/targets/{targetId}/properties

このAPIは、指定されたIDによって特定したターゲットのターゲット・プロパティを返します。クライアントは、オプションで、名前またはIDを指定することで特定の一連のプロパティの詳細を問い合せることができます。サポートされていないプロパティが指定された場合でも、エラーは報告されません。

リクエスト

パス・パラメータ

targetId(必須): string

ターゲットID

問合せパラメータ

id: array[string]

プロパティのID
limit: integer(int32)
最小値: 1

最大値: 2000

返される行の数を制限するため。結果セットがそれより大きい場合は、結果内のpreviousリンクとnextリンクに従います。
例:
```
20
```
name: array[string]

プロパティの名前
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
sort: string
ソート・フィールドと方向。指定可能なソート・フィールドはnameとidです。指定可能な方向はDESCとASCです
例:
```
id:ASC
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: TargetPropertyCollection

型: object

これはターゲット参照のリストを表すものです。

ソースの表示

count(必須): integer

このページにあるアイテムの数

例: 20
items(必須): array items

ターゲット参照
links(必須): object links

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

結果の合計数

例: 42

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of list of target references.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of items in this page",
            "example":"20"
        },
        "total":{
            "type":"integer",
            "description":"the total number of results",
            "example":"42"
        },
        "items":{
            "type":"array",
            "description":"the target references",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            }
        },
        "links":{
            "type":"object",
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the curent page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGET_ID/properties?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the previous page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGET_ID/properties?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the next page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGET_ID/properties?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: array

ターゲット参照

ソースの表示

配列: object TargetPropertySummary

ターゲット・プロパティでは、ターゲットのプロパティがID、名前、表示名および値によって説明されます。

{
    "type":"array",
    "description":"the target references",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    }
}

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

型: object

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

ソースの表示

next: next
previous: previous
self: self

{
    "type":"object",
    "description":"the result set navigation links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the curent page in the result set"
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGET_ID/properties?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the previous page in the result set"
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGET_ID/properties?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the next page in the result set"
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGET_ID/properties?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

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

型: object

ターゲット・プロパティでは、ターゲットのプロパティがID、名前、表示名および値によって説明されます。

ソースの表示

displayName: string

クライアント・ロケールでのプロパティ名。クライアントロケールが不明またはサポートされていない場合、これは名前と同じです。
id: string

プロパティID。これはプロパティの内部名です
name: string

英語のプロパティ名。
value: string

プロパティ値。

{
    "x-em-sdk-level":"emSDK",
    "description":"A target property describes a property of a target by id, name, display name and the value",
    "type":"object",
    "properties":{
        "id":{
            "description":"the property id. This is the internal name of the property",
            "type":"string"
        },
        "name":{
            "description":"the English property name.",
            "type":"string"
        },
        "displayName":{
            "description":"the property name in the client locale. If the client locale is unknown or not supported this is the same as the name.",
            "type":"string"
        },
        "value":{
            "description":"the property value.",
            "type":"string"
        }
    }
}

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

すべてに一致

結果セット内の次ページへのリンク

ソースの表示

object Link

REST APIを参照するリンク。
結果セット内の次ページへのリンク
例: { "href":"/em/api/targets/TARGET_ID/properties?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the next page in the result set"
        },
        {
            "example":{
                "href":"/em/api/targets/TARGET_ID/properties?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

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

すべてに一致

結果セット内の前ページへのリンク

ソースの表示

object Link

REST APIを参照するリンク。
結果セット内の前ページへのリンク
例: { "href":"/em/api/targets/TARGET_ID/properties?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the previous page in the result set"
        },
        {
            "example":{
                "href":"/em/api/targets/TARGET_ID/properties?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

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

すべてに一致

結果セット内の現在のページへのリンク

ソースの表示

object Link

REST APIを参照するリンク。
結果セット内の現在のページへのリンク
例: { "href":"/em/api/targets/TARGET_ID/properties?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the curent page in the result set"
        },
        {
            "example":{
                "href":"/em/api/targets/TARGET_ID/properties?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

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

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レスポンス

リソースが見つからないか、権限がありません

ルート・スキーマ: 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レスポンス

リクエスト処理中の内部エラー。

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る