Compute Systems Manager REST API リファレンスガイド

[目次][前へ][次へ]

8.4 IPアドレス範囲を編集する

instanceIDに指定したIPアドレス範囲を編集します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞

instanceID:
Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

IPAddressRange 

{
        "ipAddressRangeName":"...",
        "description":"...",
        "startIPaddress":"...",
        "endIPaddress":"...",
        "ipv6Specifiers":{
            "ipAddress":["...", ...]
        },
        "usePing":"...",
        "credential":[{
            "instanceID":"..."
        },
        :
        ]
}
属性 データ型 数 説明
ipAddressRangeName string 0～1 IPアドレス範囲の名前（1～32バイト）。
description string 0～1 IPアドレス範囲の説明。
  • 0-500 byte String
startIPaddress string 0～1 探索開始IPアドレス（書式：IPv4形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。
endIPaddress string 0～1 探索終了IPアドレス（書式：IPv4 形式）。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。
ipv6Specifiers IPv6Specifier 0～1 探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。
usePing string 0～1 PINGを使用するかどうか。
  • Disable
  • Enable
credential CredentialSpecifier 0～10 認証情報のリスト。

ipv6Specifiers

属性 データ型 数 説明
ipAddress string 0～1024 探索対象のIPアドレス（書式：IPv6形式）。

credential

属性 データ型 数 説明
instanceID string 0～1 関連する認証情報のinstanceID。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult 

{
        "id":...
}
属性 データ型 数 説明
id integer 1 編集したIPアドレス範囲のinstanceIDが返ります。

リターンコード

HTTPステータスコード 結果コード 詳細コード 説明
200 - - 正常終了。
400 2010 1 ipAddressRangeNameに無効な値を指定しました。
400 2010 2 descriptionに無効な値を指定しました。
400 2010 10 endIPaddressを指定する場合は，startIPaddressも指定する必要があります。
400 2010 11 startIPaddressを指定する場合は，endIPaddressも指定する必要があります。
400 2010 12 startIPaddressに無効な値を指定しました。
400 2010 13 endIPaddressに無効な値を指定しました。
400 2010 14 startIPaddressとendIPaddressの間に1024個を超えるIPアドレスが含まれています。または，startIPaddressがendIPaddressよりも小さくなっています。
400 2010 21 ipv6Specifiersを指定する場合は，ipAddressも指定する必要があります。ipAddressを1024個以内で指定してください。
400 2010 22 ipAddressに無効な値を指定しました。
400 2010 30 usePingに無効な値を指定しました。
400 2010 32 credentialを指定する場合は，credentialのinstanceIDも指定する必要があります。
400 2010 33 credentialのinstanceIDに無効な値を指定しました（指定された認証情報がありません）。
400 2010 34 ipVersionに'v6'を指定する場合は，credencialのinstanceIDにはsvpCredentialの認証情報だけを指定します。
400 2010 35 credentialのinstanceIDは10個以内です。
400 2010 100 リクエストボディーが指定されていません。
400 2010 101 リクエストボディーの書式が無効です。JSONの書式で記述してください。
401 1000 1 HTTPヘッダーのAuthorizationが指定されていません。
401 1000 2 HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 1000 3 HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 1000 4 ログインに失敗しました。
401 1002 1 ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 1003 1 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 2017 1 管理対象を参照する権限がありません。
404 - - 指定したinstanceIDまたはcollectionはありません。
405 - - サポートされていないメソッドです。
406 2010 1 HTTPヘッダーのAcceptの値が不正です。
412 2013 1 指定したipAddressRangeNameはCompute Systems Managerですでに使用済みです。
412 2150 21 指定されたIPアドレス範囲は探索タスクで使用されているため，編集できません。
415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 1000 1 ログインに失敗しました（内部エラー）。
503 2020 1 要求の数がAPIの同時最大接続数を超えました。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.