Oracle Enterprise ManagerのREST API

新しいターゲットを作成します

post

https://EM_HOST:8080/em/api/targets

このAPIは、指定されたデータで新しいターゲット・リソースを作成します。そのリソースがすでに存在する場合は、エラーが返されます。

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

ターゲット作成リクエストに必要なペイロード。

ソースの表示

accessPoint: object NameTypePair

名前とタイプのペア。
credentials: object credentials

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

ターゲット資格証明
displayName: string

ターゲット表示名
hostName: string

ターゲットのホスト名
instances: array instances

ターゲットを接続するインスタンス(RACターゲットの場合のみ適用可能)
monitoringCredentials: array monitoringCredentials

ターゲット・モニタリング資格証明
name(必須): string

ターゲット名
properties: array properties

ターゲット・プロパティこれには、グローバル・ターゲット・プロパティ、タイプ固有のターゲット・プロパティ、またはユーザー定義のプロパティを指定できます
timezoneRegion: string

ターゲットのタイムゾーン
typeName: string

ターゲット・タイプ

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload needed for a target creation request.",
    "type":"object",
    "required":[
        "name",
        "type"
    ],
    "properties":{
        "name":{
            "description":"the target name",
            "type":"string"
        },
        "typeName":{
            "description":"the target type",
            "type":"string"
        },
        "displayName":{
            "description":"the target display name",
            "type":"string"
        },
        "timezoneRegion":{
            "description":"the timezone of the target",
            "type":"string"
        },
        "properties":{
            "description":"the target properties. This can be global target properties, type specific target properties or user defined properties",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            }
        },
        "credentials":{
            "description":"the target credentials",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "instances":{
            "description":"the instances that the target shall be connected to (only applicable for RAC targets)",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NameTypePair"
            }
        },
        "hostName":{
            "description":"the host name of the target",
            "type":"string"
        },
        "monitoringCredentials":{
            "description":"the targets monitoring credentials",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MonitoringCredential"
            }
        },
        "accessPoint":{
            "$ref":"#/components/schemas/NameTypePair"
        }
    }
}

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

型: object

名前とタイプのペア。

ソースの表示

name: string

名前
type: string

タイプ

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

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

型: object

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

ソースの表示

string

{
    "description":"the target credentials",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

ターゲット資格証明

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

型: array

ターゲットを接続するインスタンス(RACターゲットの場合のみ適用可能)

ソースの表示

配列: object NameTypePair

名前とタイプのペア。

{
    "description":"the instances that the target shall be connected to (only applicable for RAC targets)",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameTypePair"
    }
}

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

型: array

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

ソースの表示

配列: object MonitoringCredential

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

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

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

型: array

ターゲット・プロパティこれには、グローバル・ターゲット・プロパティ、タイプ固有のターゲット・プロパティ、またはユーザー定義のプロパティを指定できます

ソースの表示

配列: object TargetPropertySummary

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

{
    "description":"the target properties. This can be global target properties, type specific target properties or user defined properties",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    }
}

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

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

先頭に戻る

レスポンス

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

application/json

201レスポンス

作成されました

ルート・スキーマ: schema

型: object

ターゲットの詳細

ソースの表示

targetName: string

ターゲットの名前

例: sales_db1
targetType: string

ターゲットのタイプ

例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

400レスポンス

引数が無効かリソース定義が不完全です

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

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

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

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

先頭に戻る