2.10.5 コンシューマーの更新
指定したコンシューマーの更新を行います。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
PUT http[s]://host:port/Analytics/version/objects/Groups/{id}
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "gradeKey":"...", "description":"...", "urls":["...", ...], "urlDisplayNames":["...", ...], "templateCreatorType":"...", "vmAutoAssignment":"...", "applicationAssignFollow":"..." }
Group (Type: Group)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
コンシューマーの名称。128文字以下の文字列を指定します。 |
gradeKey |
string |
グレードを識別するID。 |
description |
string |
コンシューマーの説明。1000文字以下の文字列を指定します。 |
urls |
string[] |
URL |
urlDisplayNames |
string[] |
URLの表示文字列 |
templateCreatorType |
enum |
コンシューマーの変更種別 (指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
vmAutoAssignment |
boolean |
このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue |
applicationAssignFollow |
boolean |
このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "instanceID":"...", "name":"...", "status":"...", "gradeKey":"...", "gradeName":"...", "gradeDisplayOrder":"...", "description":"...", "urls":["...", ...], "urlDisplayNames":["...", ...], "templateCreatorType":"...", "vmAutoAssignment":"...", "applicationAssignFollow":"...", "numOfVolumes":"...", "numOfVMs":"...", "numOfHosts":"...", "numOfHypervisors":"...", "numOfApplications":"...", "numOfPods":"...", "numOfInstances":"...", "vmAutoAssignFilters":["...", ...], "hostAutoAssignFilters":["...", ...], "podAutoAssignFilters":["...", ...], "instanceAutoAssignFilters":["...", ...] }
Group (Type: Group)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
インスタンスを特定するID。 |
name |
string |
コンシューマーの名称。128文字以下の文字列を指定します。 |
status |
enum |
コンシューマーの状態。 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
gradeKey |
string |
グレードを識別するID。 |
gradeName |
string |
グレードの名称。 |
gradeDisplayOrder |
integer |
グレードの優先順位 |
description |
string |
コンシューマーの説明。1000文字以下の文字列を指定します。 |
urls |
string[] |
URL |
urlDisplayNames |
string[] |
URLの表示文字列 |
templateCreatorType |
enum |
コンシューマーの変更種別 (指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
vmAutoAssignment |
boolean |
このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue |
applicationAssignFollow |
boolean |
このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue |
numOfVolumes |
integer |
コンシューマーが割り当てられているボリュームの数。 |
numOfVMs |
integer |
コンシューマーが割り当てられている仮想マシンの数。 |
numOfHosts |
integer |
コンシューマーが割り当てられているホストの数。 |
numOfHypervisors |
integer |
コンシューマーが割り当てられているハイパーバイザーの数。 |
numOfApplications |
integer |
コンシューマーが割り当てられているアプリケーションの数。 |
numOfPods |
integer |
コンシューマーが割り当てられているポッドの数。 |
numOfInstances |
integer |
コンシューマーが割り当てられているインスタンスの数。 |
vmAutoAssignFilters |
string[] |
仮想サーバに設定されている自動割り当てルールのルール名。 |
hostAutoAssignFilters |
string[] |
ホストに設定されている自動割り当てルールのルール名。 |
podAutoAssignFilters |
string[] |
ポッドに設定されている自動割り当てルールのルール名。 |
instanceAutoAssignFilters |
string[] |
インスタンスに設定されている自動割り当てルールのルール名。 |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
400 |
Bad Request |
リクエストボディ形式不正 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
更新権限がない |
404 |
Not Found |
リソースが存在しない |
409 |
Conflict |
nameが一致するリソースが存在する |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] PUT /Analytics/v1/objects/Groups/162 HTTP/1.1 Host: JP1OAServer:22015 User-Agent: curl/7.63.0 Accept: application/json Accept-Language: ja Content-Type: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= Content-Length: 274 [Request Body] { "name": "A Systems", "gradeKey":"0", "description": "Company: A Systems \nAddress:xxx-xxx-xxx-xxx-xxx\n", "urls": ["https://a-systems-top"], "urlDisplayNames": ["A Systems"], "templateCreatorType": "User", "vmAutoAssignment": true, "applicationAssignFollow": true } [Response Header] HTTP/1.1 200 OK Date: Mon, 09 Sep 2019 05:51:30 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO c128f4e05c042d4a31da328bcfe7486f49b357_ZAlDSFUHGHp9UB8WcRQLdA==_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : 162, "name" : "A Systems", "status" : "Normal", "gradeKey" : "0", "gradeName" : "Platinum", "gradeDisplayOrder" : 0, "description" : "Company: A Systems \nAddress:xxx-xxx-xxx-xxx-xxx\n", "urls" : [ "https://a-systems-top" ], "urlDisplayNames" : [ "A Systems" ], "templateCreatorType" : "User", "vmAutoAssignment" : true, "applicationAssignFollow" : true, "numOfVolumes" : 0, "numOfVMs" : 0, "numOfHosts" : 0, "numOfHypervisors" : 0, "numOfApplications" : 0, "numOfPods" : 0, "numOfInstances" : 0, "volumeAutoAssignFilters" : [ ], "vmAutoAssignFilters" : [ ], "hostAutoAssignFilters" : [ ], "podAutoAssignFilters": [ ], "instanceAutoAssignFilters": [ ] }