本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeSeparateInstanceRules

処理概要

指定したサーバーセパレートの設定情報を取得します。
サーバーセパレートを指定するためには、サーバーセパレート名が必要です。指定しない場合は、取得可能なサーバーセパレートの設定情報を取得します。

指定するパラメーター

パラメーター 説明 必須 サンプル値
SeparateInstanceRuleName.n 対象のサーバーセパレート名
Type : String
  separate1
Filter.n.Name 絞り込み条件の項目名
Type : String
値 : description(メモ) | instanceId(サーバー名) | instanceUniqueId(サーバーユニークID)
Default : なし
   
Filter.n.Value.m 絞り込み条件の値
Type : String
Default : なし
   

応答フィールド

フィールド 説明 サンプル値
NiftyDescribeSeparateInstanceRulesResponse NiftyDescribeSeparateInstanceRulesResponseレスポンス
Type : NiftyDescribeSeparateInstanceRulesResponseType
Ancestor : なし
Children : requestId, separateInstanceRulesInfo
 
requestId リクエスト識別子
Type : xsd : string
Ancestor : NiftyDescribeSeparateInstanceRulesResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
separateInstanceRulesInfo サーバーセパレート情報セット
Type : SeparateInstanceRuleSetType
Ancestor : NiftyDescribeSeparateInstanceRulesResponse
Children : item
 
item サーバーセパレート情報
Type : SeparateInstanceRuleItemType
Ancestor : separateInstanceRulesInfo
Children : separateInstanceRuleName, separateInstanceRuleDescription, separateInstanceRuleStatus, instancesSet, availabilityZone
 
separateInstanceRuleName サーバーセパレート名
Type : xsd : string
Ancestor : item
Children : なし
 
separateInstanceRuleDescription サーバーセパレートのメモ
Type : xsd : string
Ancestor : item
Children : なし
 
separateInstanceRuleStatus サーバーセパレートの現在のステータス
Type : xsd : string
値 : pending(設定中) | available(設定完了) | unavailable(未使用)
Ancestor : item
Children : なし
 
instancesSet 適用しているサーバー情報セット
Type : InstanceIdSetType
Ancestor : item
Children : item
 
item 適用しているサーバー情報
Type : InstanceIdType
Ancestor : instancesSet
Children : instanceId, instanceUniqueId
 
instanceId サーバー名
Type : xsd : string
Ancestor : item
Children :なし
 
instanceUniqueId サーバーユニークID
Type : xsd : string
Ancestor : item
Children :なし
 
availabilityZone ゾーン情報
Type : xsd : string
Ancestor : item
Children :なし
 

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDescribeSeparateInstanceRules&SeparateInstanceRuleName.1=separateRule1&&Filter.1.Name=description&Filter.1.Value.1=web*&CommonParams

応答サンプル

<NiftyDescribeSeparateInstanceRulesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <separateInstanceRulesInfo>
    <item>
      <separateInstanceRuleName>separateRule1</separateInstanceRuleName>
      <separateInstanceRuleDescription>webサーバールール</separateInstanceRuleDescription>
      <separateInstanceRuleStatus>available</separateInstanceRuleStatus>
      <instancesSet>
        <item>
          <instanceId>server01</instanceId>
          <instanceUniqueId>i-a1b2c3d4e</instanceUniqueId>
        </item>
        <item>
          <instanceId>server02</instanceId>
          <instanceUniqueId>i-a6b7c8d9e</instanceUniqueId>
        </item>
      </instancesSet>
      <availabilityZone>east-12</availabilityZone>
    </item>
  </separateInstanceRulesInfo>
</NiftyDescribeSeparateInstanceRulesResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上