前のトピック: info メソッド(quota オブジェクト)

次のトピック: modify メソッド(quota オブジェクト)


put メソッド(quota オブジェクト)
説明

ユーザまたはグループにクォータ情報を設定します。

構文
/api/v1/quota/put?principal=a-principal&vdc=controller-name 
引数
vdc

ターゲットの仮想データ センターの名前

プリンシパル

クォータ情報を設定するユーザまたはグループ。 principal に指定できる値は以下のいずれかです。

<name>

ローカル ユーザまたはグループ

/<name>

グローバル ユーザまたはグループ。

<scope>:<type>:<name>

完全修飾プリンシパル名

各項目は以下のとおりです。

  • <scope>global または local です
  • <type>group または user です
  • <name> はグループまたはユーザ名です
説明

任意の印刷可能な ASCII 文字の文字列。 URL 構文に従って、スペースなどの文字をそれらの 16 進数表現(%hh)で置換します。

tags=tag1,tag2,…,tagN

タグのカンマ区切りリストを請求目的で使用することがあります。

parent=group-name

親グループのクォータへの参照。 ユーザは自身の親グループをプライマリ グループに設定しているため、この引数はグループに対してのみ設定できます。

cpu=value

プロセッサに対するリソースの使用制限。

mem=value

メモリに対するリソースの使用制限(バイト数)。

bw=value

帯域幅に対するリソースの使用制限(バイト数/秒)。

disk=value

ディスク容量に対するリソースの使用制限(バイト数)。

warn=percentage

対象とするプリンシパルに対して警告を発生するリソース使用量のしきい値(利用可能な全リソースのパーセンテージ)。

burst=percentage

対象とするプリンシパルに対してバーストを発生するリソース使用量のしきい値(利用可能な全リソースのパーセンテージ)。

トランザクション タイプ

同期

リクエスト タイプ

GET

グリッド mygrid の john という名前のローカル ユーザにクォータ値を設定します。

Get http://192.168.123.200/api/v1/quota/put?principal=local:user:john&vdc=mygrid&cpu=4&mem=200000000&bw=1000&disk=100000000000
サンプル出力
XML:
成功した場合:

<message></message>
クォータを超過した場合:

<opt>
  <error>404.1</error>
  <message>エンティティが見つかりません - エラー: ユーザ Daniel は、その帯域幅クォータの 100.00 Mbps に達しました。</message>
</opt>
JSON:
{
   "message" : ""
}

HTTP エラー コード
404

エンティティ vdc mygrid が見つかりません。WS_API アプリケーションに設定されていない VDC 名が指定されました。

400.8

ユーザ principal は、その resource クォータの value に達しました。

400.7

無効な値 value がパラメータ resource に対して存在します。 warn または burst パラメータに割り当てられた値が範囲外です。

404.1

エンティティが見つかりません - principal に一致するプリンシパル名はありません。

400.4

不正なリクエスト構文(URL) - 必要な引数(principal)がありません。