パブリック配信不可: 2025-05-14

移動先

• リクエスト
• レスポンス

指定されたIDのターゲットの削除

delete

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

このAPIは、指定されたIDのターゲットを削除します。アクセス・ポイントが指定されている場合は、そのアクセス・ポイントのみが削除されます。ターゲットがエージェント・ターゲットである場合は、モニター対象ターゲットも削除できます。コンポジット・ターゲットの場合は、メンバー・ターゲットも削除できます。

リクエスト

パス・パラメータ

• targetId(必須): string
  ターゲットID

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ターゲットを削除するペイロード

ソースの表示

• accessPoint: accessPoint
• deleteMonitoredTargets: boolean
  ホスト・ターゲットのモニター対象ターゲットをホスト・ターゲットとともに削除するかどうかを示します。

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to delete a target",
    "type":"object",
    "properties":{
        "accessPoint":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/NameTypePair"
                },
                {
                    "description":"If only an access point is to be deleted this defines its name and type."
                },
                {
                    "example":{
                        "name":"MyAccessPointName",
                        "type":"MyAccessPointType"
                    }
                }
            ]
        },
        "deleteMonitoredTargets":{
            "type":"boolean",
            "description":"Indicates if monitored targets of a host target should get deleted along with the host target."
        }
    }
}

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

すべてに一致

アクセス・ポイントのみを削除する場合は、これにより、その名前とタイプを定義します。

ソースの表示

• object NameTypePair
  名前とタイプのペア。
• アクセス・ポイントのみを削除する場合は、これにより、その名前とタイプを定義します。
• 例: { "name":"MyAccessPointName", "type":"MyAccessPointType" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/NameTypePair"
        },
        {
            "description":"If only an access point is to be deleted this defines its name and type."
        },
        {
            "example":{
                "name":"MyAccessPointName",
                "type":"MyAccessPointType"
            }
        }
    ]
}

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

先頭に戻る

レスポンス

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

• application/json

204レスポンス

OK。ターゲットが削除されました

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

404レスポンス

ターゲットが見つからないか、権限がありません

本文()

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

先頭に戻る