Oracle Enterprise ManagerのREST API

モニタリング資格証明の検索

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/actions/searchMonitoringCredential

リクエスト・ペイロードで提供されるフィルタに基づいて、一致するモニタリング資格証明を検索します。

リクエスト

問合せパラメータ

includeTotal: boolean
結果の合計数を返すかどうか。
例:
```
true
```
limit: integer
最小値: 1

最大値: 2000

フェッチされるモニタリング資格証明の数

デフォルト値: 20
例:
```
20
```
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
sort: string
方向付きの結果セットの順序。使用可能なソート・フィールドは、targetTypeName、setNameです。指定可能な方向はASCとDESCです。複数のフィールドをソートするには、field1:direction1,field2:direction2のようにカンマ区切りの値を指定します
例:
```
type:ASC,name:DESC
```

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

application/json

ルート・スキーマ: schema

型: object

モニタリング資格証明の検索ペイロードを保持するスキーマ・オブジェクト

ソースの表示

setName: array setName

資格証明セット名
setNameContains: array setNameContains

フィルタ処理する優先資格証明セット名のパターン。大/小文字が区別されます。
targetName: array targetName

モニタリング資格証明のターゲット名
targetNameContains: array targetNameContains

フィルタ処理するモニタリング資格証明ターゲット名
targetTypeName: array targetTypeName

モニタリング資格証明のtargetType
targetTypeNameContains: array targetTypeNameContains

フィルタ処理するターゲット・タイプ名

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential search payload",
    "properties":{
        "targetNameContains":{
            "type":"array",
            "description":"Monitoring credetnail target name to be filtered",
            "items":{
                "type":"string",
                "example":"myHostName1, myHostName2"
            }
        },
        "targetTypeNameContains":{
            "type":"array",
            "description":"target type name to be filtered",
            "items":{
                "type":"string",
                "example":"type1, type2"
            }
        },
        "setNameContains":{
            "type":"array",
            "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
            "items":{
                "type":"string",
                "example":"set1, set2"
            }
        },
        "setName":{
            "type":"array",
            "description":"credential set name",
            "items":{
                "type":"string",
                "example":"CREDSET1, CREDSET2"
            }
        },
        "targetName":{
            "type":"array",
            "description":"target name of monitoring credential",
            "items":{
                "type":"string",
                "example":"www.myhost.com1, www.myhost.com2"
            }
        },
        "targetTypeName":{
            "type":"array",
            "description":"targetType of monitoring credential",
            "items":{
                "type":"string",
                "example":"host1, host2"
            }
        }
    }
}

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

型: array

資格証明セット名

ソースの表示

配列: string

例: CREDSET1, CREDSET2

{
    "type":"array",
    "description":"credential set name",
    "items":{
        "type":"string",
        "example":"CREDSET1, CREDSET2"
    }
}

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

型: array

フィルタ処理する優先資格証明セット名のパターン。大/小文字が区別されます。

ソースの表示

配列: string

例: set1, set2

{
    "type":"array",
    "description":"Preferred credential set name pattern to be filtered. Case sensitive.",
    "items":{
        "type":"string",
        "example":"set1, set2"
    }
}

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

型: array

モニタリング資格証明のターゲット名

ソースの表示

配列: string

例: www.myhost.com1, www.myhost.com2

{
    "type":"array",
    "description":"target name of monitoring credential",
    "items":{
        "type":"string",
        "example":"www.myhost.com1, www.myhost.com2"
    }
}

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

型: array

フィルタ処理するモニタリング資格証明ターゲット名

ソースの表示

配列: string

例: myHostName1, myHostName2

{
    "type":"array",
    "description":"Monitoring credetnail target name to be filtered",
    "items":{
        "type":"string",
        "example":"myHostName1, myHostName2"
    }
}

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

型: array

モニタリング資格証明のtargetType

ソースの表示

配列: string

例: host1, host2

{
    "type":"array",
    "description":"targetType of monitoring credential",
    "items":{
        "type":"string",
        "example":"host1, host2"
    }
}

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

型: array

フィルタ処理するターゲット・タイプ名

ソースの表示

配列: string

例: type1, type2

{
    "type":"array",
    "description":"target type name to be filtered",
    "items":{
        "type":"string",
        "example":"type1, type2"
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

モニタリング資格証明のリストが正常に返されました

ルート・スキーマ: MonitoringCredentialCollection

型: object

これは、モニタリング資格証明のリストを表すものです。

ソースの表示

count(必須): integer

このページ内のモニタリング資格証明の数

例: 20
items(必須): array items

優先資格証明リスト
links(必須): object links

読取り専用: true

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

使用可能なアイテムの合計数(全ページ)

例: 101

{
    "description":"This is the representation of list of monitoring credentials.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of Monitoring credentials in this page",
            "example":"20"
        },
        "total":{
            "type":"integer",
            "description":"Total number of items that are available (for all the pages)",
            "example":"101"
        },
        "links":{
            "type":"object",
            "readOnly":true,
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "example":{
                                "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
                            }
                        }
                    ]
                }
            }
        },
        "items":{
            "type":"array",
            "description":"the Preferred credentials list",
            "items":{
                "$ref":"#/components/schemas/MonitoringCredential"
            }
        }
    }
}

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

型: array

優先資格証明リスト

ソースの表示

配列: object MonitoringCredential

モニタリング資格証明は、ターゲットへのアクセスにどの資格証明のセットおよび属性を使用するかを説明するために使用します。

{
    "type":"array",
    "description":"the Preferred credentials list",
    "items":{
        "$ref":"#/components/schemas/MonitoringCredential"
    }
}

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

型: object

読取り専用: true

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

ソースの表示

next: next
previous: previous
self: self

{
    "type":"object",
    "readOnly":true,
    "description":"the result set navigation links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "example":{
                        "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
                    }
                }
            ]
        }
    }
}

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

型: object

モニタリング資格証明は、ターゲットへのアクセスにどの資格証明のセットおよび属性を使用するかを説明するために使用します。

ソースの表示

attributes: array attributes

使用可能なその他のプロパティ: additionalProperties

資格証明の属性
authenticatingTargetType: string

セットの認証ターゲット・タイプ
credentialType: string

資格証明タイプ
monitoringCredentialSetName: string

資格証明セットの名前

{
    "x-em-sdk-level":"emSDK",
    "description":"A monitoring credential is used to describe which credential set and attributes is used to access a target.",
    "type":"object",
    "properties":{
        "monitoringCredentialSetName":{
            "description":"the name of the credential set",
            "type":"string"
        },
        "authenticatingTargetType":{
            "description":"the authenticating target type of the set",
            "type":"string"
        },
        "credentialType":{
            "description":"the credential type",
            "type":"string"
        },
        "attributes":{
            "description":"the attributes of the credential",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            },
            "example":[
                {
                    "name":"UserName",
                    "value":"MyUserName"
                },
                {
                    "name":"Password",
                    "value":"MyPassword"
                }
            ],
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: array

使用可能なその他のプロパティ

ソースの表示

string

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

資格証明の属性

ソースの表示

配列: object NameValuePair

名前と値のペア。

{
    "description":"the attributes of the credential",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "example":[
        {
            "name":"UserName",
            "value":"MyUserName"
        },
        {
            "name":"Password",
            "value":"MyPassword"
        }
    ],
    "additionalProperties":{
        "type":"string"
    }
}

例:

[
    {
        "name":"UserName",
        "value":"MyUserName"
    },
    {
        "name":"Password",
        "value":"MyPassword"
    }
]

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

型: object

名前と値のペア。

ソースの表示

name: string

名前
value: string

値

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and value.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "value":{
            "description":"the value",
            "type":"string"
        }
    }
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchMonitoringCredential?page={NEXT_PAGE_TOKEN}"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/actions/searchMonitoringCredential?page={PREVIOUS_PAGE_TOKEN}"
            }
        }
    ]
}

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

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
例: { "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "example":{
                "href":"/em/api/namedCredentials/actions/searchMonitoringCredential?page={CURRENT_PAGE_TOKEN}"
            }
        }
    ]
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

例

先頭に戻る