本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> NiftyDescribeSeparateInstanceRules

NiftyDescribeSeparateInstanceRules

処理概要

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

指定するパラメーター

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

応答フィールド

フィールド (項目) 説明
NiftyDescribeSeparateInstanceRulesResponse - NiftyDescribeSeparateInstanceRulesResponseレスポンス
Ancestor: なし
Children: requestId | separateInstanceRulesInfo
requestId string リクエスト識別子
Ancestor: NiftyDescribeSeparateInstanceRulesResponse
Children: なし
separateInstanceRulesInfo - サーバーセパレート情報セット
Ancestor: NiftyDescribeSeparateInstanceRulesResponse
Children: item
item - サーバーセパレート情報
Ancestor: separateInstanceRulesInfo
Children: separateInstanceRuleName | separateInstanceRuleDescription | separateInstanceRuleStatus | instancesSet | availabilityZone
separateInstanceRuleName string サーバーセパレート名
Ancestor: item
Children: なし
separateInstanceRuleDescription string サーバーセパレートのメモ
Ancestor: item
Children: なし
separateInstanceRuleStatus string サーバーセパレートの現在のステータス
値: pending(設定中) | available(設定完了) | unavailable(未使用)
Ancestor: item
Children: なし
instancesSet - 適用しているサーバー情報セット
Ancestor: item
Children: item
item - 適用しているサーバー情報
Ancestor: instancesSet
Children: instanceId | instanceUniqueId
instanceId string サーバー名
Ancestor: item
Children: なし
instanceUniqueId string サーバーユニークID
Ancestor: item
Children: なし
availabilityZone 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://computing.api.nifcloud.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 以上