Compute Systems Manager REST API リファレンスガイド
指定した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":"..." }, : ] }, : ] }
属性 データ型 数 説明 instanceID string 1 Compute Systems Managerによって割り当てられた識別キー。 ipAddressRangeName string 1 IPアドレス範囲の名前(1~32バイト)。 description string 1 IPアドレス範囲の説明。
- 0-500 byte String
ipVersion string 1 IPアドレスバージョン。
- v4
- v6
startIPaddress string 1 探索開始IPアドレス(書式:IPv4形式)。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。 endIPaddress string 1 探索終了IPアドレス(書式:IPv4 形式)。ipVersionが'v4'の場合に使用します。ipVersionが'v6'の場合は空文字列です。 ipv6Specifiers IPv6Specifier 1 探索対象IPアドレス。ipVersionが'v6'の場合に使用します。ipVersionが'v4'の場合はnullです。 usePing string 1 PINGを使用するかどうか。
- Disable
- Enable
credential CredentialSpecifier 1~10 認証情報のリスト。 ipv6Specifiers
属性 データ型 数 説明 ipAddress string 0~1024 探索対象のIPアドレス(書式:IPv6形式)。 credential
属性 データ型 数 説明 instanceID string 1 関連する認証情報のinstanceID。
HTTPステータスコード 結果コード 詳細コード 説明 200 - - 正常終了。 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 管理対象を参照する権限がありません。 405 - - サポートされていないメソッドです。 406 2010 1 HTTPヘッダーのAcceptの値が不正です。 415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。 500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。 500 1000 1 ログインに失敗しました(内部エラー)。 503 2020 1 要求の数がAPIの同時最大接続数を超えました。
All Rights Reserved. Copyright© 2016, Hitachi, Ltd.