destroy メソッド（class オブジェクト）

CA 3Tera AppLogic API の有効なオブジェクト › class オブジェクト › destroy メソッド（class オブジェクト）

destroy メソッド（class オブジェクト）

説明

クラスを破棄します。

構文

/api/v1/class/destroy?class=class&vdc=controller-name

引数

class: 破棄されるクラスの名前
controller-name: ターゲットの仮想データセンターの名前

トランザクションタイプ

非同期

リクエストタイプ

GET

例

/test:LUX5 を破壊します。

GET http://192.168.123.200/api/v1/class/destroy?class=/test:LUX5&vdc=mygrid

サンプル出力

XML

<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>

JSON

{
   "job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
}

メモ

JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。

UTF8 にエンコードされた JSON 出力をデコードするシンプルな PHP スクリプトの例を以下に示します。

<? 
$json = '{"a": "¥u00e3¥u0081¥u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

HTTP エラーコード

404: エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。
400.4: 必要な引数（class）がありません。リクエストに引数 class=entity がありません。

メモ

ジョブのステータスを取得するには、/api/v1/job/info? リクエストを発行し、上で返された job_id を引数に指定します。ジョブステータスを取得する方法の詳細については、ジョブオブジェクトを参照してください。

lock メソッド（class オブジェクト）

説明

クラスをロックします。

構文

/api/v1/class/lock?class=class&pwd=password&vdc=controller-name

引数

class: ロックされるクラスの名前
password: パスワード
controller-name: ターゲットの仮想データセンターの名前

トランザクションタイプ

同期

リクエストタイプ

GET

例

クラス /test:IN をロックします。

GET http://192.168.123.200/api/v1/class/lock?class=/test:IN&pwd=password&vdc=mygrid

サンプル出力

XML

<opt></opt>

JSON

{}

メモ

JSON の出力はすべて UTF8 にエンコードされています。 UTF8 デコードを使用して UTF8 にエンコードされた出力をデコードします。

UTF8 にエンコードされた JSON 出力をデコードするシンプルな PHP スクリプトの例を以下に示します。

<? 
$json = '{"a": "¥u00e3¥u0081¥u0082" }'; 
$j = json_decode($json); 
echo utf8_decode($j->{'a'}); 
?>

HTTP エラーコード

404: エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。
400.4: 必要な引数（class）がありません。リクエストに引数 class=entity がありません。
400.4: 必要な引数（pwd）がありません。リクエストに引数 pwd=password がありません。
404: グローバルカタログ test が見つかりません。リクエストで無効なカタログが指定されています。
404: クラス LUX が見つかりません。リクエストで無効なクラスが指定されています。

メモ

クラスをロック解除するには、クラスをロックするために指定したパスワードが必要です。クラスがロックされている場合、管理者以外のユーザは以下の操作を実行できません。
* class branch
* class copy
* class move
* class get_desc
* クラス、またはクラスが含まれるカタログ/アプリケーションのエクスポート
* クラスボリュームの管理/変更/読み取り

このトピックについて CA Technologies に電子メールを送信する