移動先

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

ターゲットに対する名前付き資格証明のテスト

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/namedCredentials/{namedCredentialId}/actions/test

インスタンス資格証明が資格証明のターゲットに対してテストされるため、ここではペイロードは必要ありません。グローバル資格証明がターゲットに対してテストされる場合は、リクエスト・ペイロードが必要です。ユーザーにターゲットの表示権限のみがある場合、ユーザーは資格証明をテストできないため、APIは403エラーを返します。保存前に資格証明をテストする場合、ターゲットが停止していると、APIは503を返します。

リクエスト

パス・パラメータ

• namedCredentialId(必須): string
  名前付き資格証明のID

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

• application/json

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

ルート・スキーマ: schema

型: object

これは、名前付き資格証明をテストするために必要なデータで構成されます

ソースの表示

• authenticationTestTargetName: string
  テスト・ターゲット名

  例: testhost.example.com
• authenticationTestTargetTypeName: string
  テスト・ターゲット・タイプの名前

  例: host
• id: string
  名前付き資格証明の一意の識別子。パス・パラメータとしても渡されます。

  例: B0FBBE587FD201E2E0537013790A7D03

{
    "description":"This consists of data required to test a named credential",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a named credential. Also passed as path parameter.",
            "example":"B0FBBE587FD201E2E0537013790A7D03"
        },
        "authenticationTestTargetName":{
            "type":"string",
            "description":"Test target name",
            "example":"testhost.example.com"
        },
        "authenticationTestTargetTypeName":{
            "type":"string",
            "description":"Name of the test target type",
            "example":"host"
        }
    }
}

先頭に戻る

レスポンス

204レスポンス

名前付き資格証明が正常にテストされました

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

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

本文()

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

先頭に戻る