作業用コピーの削除
削除
/workingcopies/{workingCopyId}
指定した作業用コピーをサーバーから削除します。
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- workingCopyId: string
作業用コピーの名前。
記述
ルート・スキーマ: DeleteWorkingCopyBody
タイプ:
ソースの表示
object
- auth(optional): string
認証プラグインを使用してリモート・ノードにアクセスします
- authArgs(optional): object authArgs
使用可能なその他のプロパティ: additionalProperties選択した認証プラグインの追加プロパティ
- cc(optional): string
作業用コピーの所有者に加えて、電子メール通知が送信されるユーザーのリスト
- cred(optional): string
リモート・ノードへのアクセスのためのユーザー/パスワード資格証明に関連付ける資格証明名
- force(optional): boolean
データベースの作業用コピーを強制的に削除
- notify(optional): boolean
電子メール通知を送信します
- root(optional): boolean
ルート資格証明を使用してリモート・ノードにアクセスします
- schedule(optional): string
操作を実行する優先時間
- sudoPath(optional): string
sudoバイナリの場所
- sudoUser(optional): string
sudoユーザー名としてスーパーユーザー操作を実行します
- superUserPasswd(optional): string
スーパーユーザー・アカウントのパスワード
- targetNode(optional): string
高速ホーム・プロビジョニング・クライアントを持たないリモート・クラスタ内のノードの名前
- userActionData(optional): string
useractionスクリプトのuseractiondataパラメータに渡される値
セキュリティ
- basicAuthentication: basic
タイプ:
Basic
レスポンス
サポートされるメディア・タイプ
- application/json
202 レスポンス
承認済。進行状況のステータスおよび出力を取得するために承認された操作のジョブ・リソース詳細を含むJSONオブジェクト。
ヘッダー
- Location: string
操作を実行するジョブへのURL
ネストされたスキーマ: singleResourceLinks
タイプ:
ソースの表示
object
- href(optional): string
絶対形式で指定された参照ハイパーリンク要素。
- rel(optional): string
指定できる値:
[ "self", "collection", "up", "describedBy" ]
説明されたリソースを持つリンクの関係のタイプを指定します。
ネストされたスキーマ: collectionResourceLinks
タイプ:
ソースの表示
object
- href(optional): string
正しいURLパラメータを持つ絶対形式で指定された参照ハイパーリンク要素。
- rel(optional): string
指定できる値:
[ "next", "prev", "first", "last" ]
説明されたリソースを持つリンクの関係のタイプを指定します。
400 レスポンス
不正なリクエスト。パラメータ値または名前の解析中に見つかった問題のエラー詳細を含むJSONオブジェクト。
ルート・スキーマ: errorResource
タイプ:
ソースの表示
object
- errorCode(optional): string
tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
- errorDetails(optional): array errorDetails
複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
- errorPath(optional): string
エラーの発生場所を示すXPathまたはJSONパス。
- instance(optional): string
エラーに関する詳細を提供するリンクへのURI。
- status(optional): integer
HTTPステータス・コード。
- title(optional): string
要約エラー・メッセージ。
- type(optional): string
HTTPエラー・コード・ページへのリンク。
デフォルト・レスポンス
予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。
ルート・スキーマ: errorResource
タイプ:
ソースの表示
object
- errorCode(optional): string
tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
- errorDetails(optional): array errorDetails
複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
- errorPath(optional): string
エラーの発生場所を示すXPathまたはJSONパス。
- instance(optional): string
エラーに関する詳細を提供するリンクへのURI。
- status(optional): integer
HTTPステータス・コード。
- title(optional): string
要約エラー・メッセージ。
- type(optional): string
HTTPエラー・コード・ページへのリンク。
例
次の例は、cURLを使用してRESTリソースに対するDELETE
リクエストを発行し、DBWC_1
という名前の作業用コピーを削除する方法を示しています。
curl -u restUser -X DELETE -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/DBWC_1"
HTTPステータス・コードとレスポンス・ヘッダー
レスポンス・ヘッダーの例を次に示します。
HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 168
Date: Tue, 19 Jun 2018 14:03:23 GMT
リクエスト本体(body.json)
{
"force" : true
}
レスポンス本体
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}}