移動先

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

失敗したステップの引数を更新して、そのステップを再試行します。

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/deploymentProcedureInstances/{deploymentProcedureInstanceId}/actions/updateAndRetryStep

実行IDが指定されていない場合は、デプロイメント・プロシージャ・インスタンスの最新実行の失敗したステップの引数を更新し、失敗したステップを再試行します。また、実行IDが指定されている場合は、特定の実行IDのステップが再試行されます。これは、emcliの'update_and_retry_step'に相当します。

リクエスト

パス・パラメータ

• deploymentProcedureInstanceId(必須): string
  インスタンスのID。

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

• application/json

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

ルート・スキーマ: schema

型: object

stateId、実行IDおよび引数が含まれます。

ソースの表示

• arguments: string
  引数の書式は名前/値のペアです。名前と値はコロンで区切り、各ペアはセミコロンで区切ります

  例: command:ls
• executionId: string
  デプロイメント・プロシージャ・インスタンスのexecutionIdを表します。

  例: CC1871802C4343A3E053E00F4B640972
• stateId(必須): string
  失敗したステップのstateId。

  例: CC1871802C4343A3E053E00F4B640973

{
    "description":"Includes stateId, execution Id and args.",
    "type":"object",
    "required":[
        "stateId"
    ],
    "properties":{
        "stateId":{
            "type":"string",
            "description":"stateId of the failed step.",
            "example":"CC1871802C4343A3E053E00F4B640973"
        },
        "arguments":{
            "type":"string",
            "description":"The format of the arguments are name value pairs. Name and value are separated by colon and each pair is separated by semicolon",
            "example":"command:ls"
        },
        "executionId":{
            "type":"string",
            "description":"Represents executionId of a deployment procedure instance.",
            "example":"CC1871802C4343A3E053E00F4B640972"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

202レスポンス

引数を更新し、失敗したステップを再試行するリクエストが受け入れられました

ヘッダー

• Location:
  ステップ更新および再試行アクションのステータスを取得するためのURL。

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• code: string
  コード

  例: 202
• message: string
  ステップ更新および再試行用のREST APIメッセージ。

  例: A request to update the arguments and retry the failed steps was accepted

{
    "type":"object",
    "properties":{
        "code":{
            "description":"code",
            "type":"string",
            "example":"202"
        },
        "message":{
            "description":"Rest Api message for update and retry step.",
            "type":"string",
            "example":"A request to update the arguments and retry the failed steps was accepted"
        }
    }
}

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

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

先頭に戻る