8.1 すべてのIPアドレス範囲を取得する

指定したIPアドレスバージョン,またはすべてのIPアドレス範囲を取得します。

ロール

All-Resources-Admin

リクエストライン

GET http://<host>:<port>/ComputeSystemsManager/v1/objects/IPAddressRanges?ipVersion=バージョン

クエリーパラメーターに指定できる値を次の表に示します。

パラメーター説明
ipVersion取得するIPアドレス範囲のIPアドレスバージョンを指定します。指定しない場合はすべてのIPアドレス範囲を取得します。
  • v4
  • v6

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

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

IPAddressRange

{
   "IPAddressRange":[{
       "instanceID":"...",
       "ipAddressRangeName":"...",
       "description":"...",
       "ipVersion":"...",
       "startIPaddress":"...",
       "endIPaddress":"...",
       "ipv6Specifiers":{
           "ipAddress":["...", ...]
       },
       "usePing":"...",
       "credential":[{
           "instanceID":"..."
       },
       :
       ]
   },
   :
   ]
}

属性データ型説明
instanceIDstring1Compute Systems Managerによって割り当てられた識別キー。
ipAddressRangeNamestring1IPアドレス範囲の名前(1~32バイト)。
descriptionstring1IPアドレス範囲の説明。
  • 0-500 byte String
ipVersionstring1IPアドレスバージョン。
  • v4
  • v6
startIPaddressstring1探索開始IPアドレス(書式:IPv4形式)。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。
endIPaddressstring1探索終了IPアドレス(書式:IPv4 形式)。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。
ipv6SpecifiersIPv6Specifier1探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。
usePingstring1PINGを使用するかどうか。
  • Disable
  • Enable
credentialCredentialSpecifier1~10認証情報のリスト。

ipv6Specifiers

属性データ型説明
ipAddressstring0~1024探索対象のIPアドレス(書式:IPv6形式)。

credential

属性データ型説明
instanceIDstring1関連する認証情報のinstanceID。

リターンコード

HTTPステータスコード結果コード詳細コード説明
200--正常終了。
40110001HTTPヘッダーのAuthorizationが指定されていません。
40110002HTTPヘッダーのAuthorizationの値が不正です(Basic認証,HSSOセッション認証のどちらでもありません)。
40110003HTTPヘッダーのAuthorizationのBasic認証の値が不正です(認証情報のフォーマットが不正です)。
40110004ログインに失敗しました。
40110021ログインセッションが切断されました。または,不正なHSSOトークンが指定されました。
40310031基本ライセンスが登録されていない,または有効期限を過ぎています。
40320171管理対象を参照する権限がありません。
405--サポートされていないメソッドです。
40620101HTTPヘッダーのAcceptの値が不正です。
415--HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500--HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。
50010001ログインに失敗しました(内部エラー)。
50320201要求の数がAPIの同時最大接続数を超えました。