Oracle Enterprise ManagerのREST API

モニタリング資格証明の作成

post

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

ターゲット・タイプまたはターゲット・インスタンスのモニタリングとして名前付き資格証明を作成し、ペイロードで指定された名前を設定します。

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

setMonitoringCredentialアクションに必要なモニタリング資格証明データを保持するスキーマ・オブジェクト。

ソースの表示

authenticationTargetType: string

認証ターゲット・タイプ。デフォルトはtargetTypeNameです

例: host
isAuthenticationRequired: boolean

資格証明の保存前に認証が必要な場合はtrue

例: false
targetNames: array targetNames

複数のターゲットに対して設定する必要がある場合、ターゲット・リスト

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential data required in the setMonitoringCredential action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MonitoringCredentialCommon"
        }
    ],
    "properties":{
        "targetNames":{
            "type":"array",
            "description":"the targets list, if needed to set for multiple targets",
            "items":{
                "type":"string",
                "example":"com.my.host1, com.my.host2"
            }
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

すべてに一致

ソースの表示

object allOf MonitoringCredentialCommon

モニタリング資格証明を作成するための入力

{
    "type":"object",
    "description":"Schema object to hold Monitoring Credential data required in the setMonitoringCredential action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/MonitoringCredentialCommon"
        }
    ],
    "properties":{
        "targetNames":{
            "type":"array",
            "description":"the targets list, if needed to set for multiple targets",
            "items":{
                "type":"string",
                "example":"com.my.host1, com.my.host2"
            }
        },
        "isAuthenticationRequired":{
            "type":"boolean",
            "description":"true if authentication is required before saving credential",
            "example":false
        },
        "authenticationTargetType":{
            "type":"string",
            "description":"The authenticating target type. Defaults to targetTypeName",
            "example":"host"
        }
    }
}

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

型: array

複数のターゲットに対して設定する必要がある場合、ターゲット・リスト

ソースの表示

配列: string

例: com.my.host1, com.my.host2

{
    "type":"array",
    "description":"the targets list, if needed to set for multiple targets",
    "items":{
        "type":"string",
        "example":"com.my.host1, com.my.host2"
    }
}

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

型: object

モニタリング資格証明を作成するための入力

ソースの表示

attributes(必須): object attributes

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

モニタリング資格証明の属性の名前/値のマップを表します
credentialType(必須): string

資格証明のタイプ

例: HostSSHCreds

{
    "type":"object",
    "description":"Input for creating a Monitoring Credential",
    "required":[
        "credentialType",
        "attributes"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetAndSetCommon"
        }
    ],
    "properties":{
        "credentialType":{
            "type":"string",
            "description":"credential type",
            "example":"HostSSHCreds"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the monitoring credential",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

すべてに一致

ソースの表示

object TargetAndSetCommon

モニタリング資格証明を作成するための入力

{
    "type":"object",
    "description":"Input for creating a Monitoring Credential",
    "required":[
        "credentialType",
        "attributes"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetAndSetCommon"
        }
    ],
    "properties":{
        "credentialType":{
            "type":"string",
            "description":"credential type",
            "example":"HostSSHCreds"
        },
        "attributes":{
            "type":"object",
            "description":"Represents a map of name-value for the attributes for the monitoring credential",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

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

型: object

モニタリング資格証明を作成するための入力

ソースの表示

setName(必須): string

資格証明セット名

例: CREDSET1
targetGuid: string

優先資格証明のターゲット・インスタンスID。

例: A3CDDE587FD221E2F3539013290B7F05
targetName: string

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

例: www.myhost.com
targetTypeName: string

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

例: oracle_database

{
    "type":"object",
    "required":[
        "setName"
    ],
    "description":"Input for creating a Monitoring Credential",
    "properties":{
        "setName":{
            "type":"string",
            "description":"credential set name",
            "example":"CREDSET1"
        },
        "targetTypeName":{
            "type":"string",
            "description":"name of the target type of the monitoring credential",
            "example":"oracle_database"
        },
        "targetName":{
            "type":"string",
            "description":"target name of monitoring credential",
            "example":"www.myhost.com"
        },
        "targetGuid":{
            "type":"string",
            "description":"Target instance id of a preferred credential.",
            "example":"A3CDDE587FD221E2F3539013290B7F05"
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

モニタリング資格証明が正常に作成されました

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

例

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

409レスポンス

競合

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

先頭に戻る