ページの先頭行へ戻る
Systemwalker Software Configuration Manager V14g リファレンスガイド API編
Systemwalker

4.7.16 CancelError

指定した任意のバックアップまたはリストアタスクのエラー状態を解除します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

CFMG APIのバージョンID

string ASCII

設定内容

固定。「1.0」を指定してください。

Locale

説明

CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

string ASCII

設定内容

以下から選択します。
・「ja」: 日本語
・「en」: 英語

Action

説明

実行するCFMG APIの名称

string ASCII

設定内容

固定。「CancelError」を指定してください。

userId

説明

CFMG APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

CFMG APIを実行するユーザーの組織ID

string ASCII

設定内容

8文字以内

vsysId

説明

システムID

string ASCII

設定内容

32文字以内

taskId

説明

エラー状態を解除するバックアップまたはリストアタスクID

string ASCII

設定内容

32文字以内


レスポンス

《ステータスコード》

正常に終了した場合に「200 OK」を返します。


《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</CancelErrorResponse>

《要素》

要素名

項目

項目説明

CancelErrorResponse

説明

レスポンスの情報を持つ要素

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録B レスポンスステータス・エラーコード一覧」を参照してください。

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<CancelErrorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</CancelErrorResponse>