Compute Systems Manager REST API リファレンスガイド
新しいIPアドレス範囲を作成します。
All-Resources-Admin
POST http://<host>:<port>/ComputeSystemsManager/v1/objects/IPAddressRangesリクエストボディーの構造とオブジェクトの属性を次に示します。
IPAddressRange
{ "ipAddressRangeName":"...", "description":"...", "ipVersion":"...", "startIPaddress":"...", "endIPaddress":"...", "ipv6Specifiers":{ "ipAddress":["...", ...] }, "usePing":"...", "credential":[{ "instanceID":"..." }, : ] }
属性 データ型 数 説明 ipAddressRangeName string 0~1 IPアドレス範囲の名前(1~32バイト)。 description string 0~1 IPアドレス範囲の説明。
- 0-500 byte String
ipVersion string 1 IPアドレスバージョン。
- v4
- v6
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ステータスコード 結果コード 詳細コード 説明 201 0 0 正常終了。 400 2010 1 ipAddressRangeNameに無効な値を指定しました。 400 2010 2 descriptionに無効な値を指定しました。 400 2010 10 ipVersionを指定していません。 400 2010 11 ipVersionに無効な値を指定しました。 400 2010 12 ipVersionに'v4'を指定する場合は,startIPaddressも指定する必要があります。 400 2010 13 startIPaddressに無効な値を指定しました。 400 2010 14 ipVersionに'v4'を指定する場合は,endIPaddressも指定する必要があります。 400 2010 15 endIPaddressに無効な値を指定しました。 400 2010 16 startIPaddressとendIPaddressの間に1024個を超えるIPアドレスが含まれています。または,startIPaddressがendIPaddressよりも小さくなっています。 400 2010 20 ipVersionに'v6'を指定する場合は,ipv6Specifiersも指定する必要があります。 400 2010 22 ipVersionに'v6'を指定したのにipAddressを指定していないか,ipAddressに1024個を超えるIPアドレスが含まれています。 400 2010 23 ipAddressに無効な値を指定しました。 400 2010 30 usePingに無効な値を指定しました。 400 2010 31 credentialを指定していません。 400 2010 33 credentialのinstanceIDを指定していません。credentialのinstanceIDは10個以内で指定してください。 400 2010 34 credentialのinstanceIDに無効な値を指定しました(指定された認証情報がありません)。 400 2010 35 ipVersionに'v6'を指定する場合は,credencialのinstanceIDにはsvpCredentialの認証情報だけを指定します。 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 管理対象を参照する権限がありません。 405 - - サポートされていないメソッドです。 406 2010 1 HTTPヘッダーのAcceptの値が不正です。 412 2013 1 指定したipAddressRangeNameはCompute Systems Managerですでに使用済みです。 415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。 500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。 500 1000 1 ログインに失敗しました(内部エラー)。 503 2020 1 要求の数がAPIの同時最大接続数を超えました。
All Rights Reserved. Copyright© 2016, Hitachi, Ltd.