仮想ホストの強制停止
機能
指定した仮想ホストを強制停止します。このAPIを実行すると,強制停止のタスクが登録されます。
利用期間ではない仮想ホストは強制停止できません。
APIのサポートバージョン
このAPIは,01.00以降で提供します。
HTTPリクエスト形式
仮想ホストを強制停止するAPIのHTTPリクエスト形式を次の表に示します。
項目 | 値 |
---|---|
Method | POST |
URI※ | /jp1itrm/api/instances/リソースID/powerOff |
Query String※ | realm=業務グループID |
HTTPステータスコード
202 Accepted,またはエラーを示すステータスコードが出力されます。
詳細については,「API共通の仕様」の「HTTPステータスコード」を参照してください。
XMLのネームスペース
HTTPステータスコードが,202 Acceptedの場合,XMLデータは返却されません。
タスクの実行結果に関する注意事項
使用例
認証情報にユーザー名「portal01」,パスワード「password」を指定して,業務グループID「1」に属する,リソースID「1」の仮想ホストを強制停止する場合の使用例を示します。
POST△/jp1itrm/api/instances/1/powerOff?realm=1△HTTP/1.0
Authorization:△Basic△cG9ydGFsMDE6cGFzc3dvcmQwMQ==
(凡例) △:半角スペース
出力例
業務グループID「1」に属する,リソースID「1」の仮想ホストを強制停止する場合の出力例を示します。
HTTP/1.1 202 Accepted
Content-Length: 0
Content-Type: application/xml