ニフクラAPI (コンピューティング: DescribeResources)

DescribeResources

処理概要

リソースの利用状況を返却します。
コントロールパネル画面のダッシュボードに当たります。

指定するパラメーター

パラメーター	型	説明	必須

応答フィールド

フィールド (項目)	型	説明
DescribeResourcesResponse	-	DescribeResourcesレスポンス
␣requestId	string	リクエスト識別子
␣resourceInfo	-	リソース情報
␣␣instanceItemSet	-	サーバー情報セット
␣␣␣item	-	サーバー情報
␣␣␣␣type	string	サーバータイプ 値: e-mini mini c-small e-small small c-small2 e-small2 small2 c-small4 e-small4 small4 e-small8 small8 e-small16 small16 c-medium e-medium medium c-medium4 e-medium4 medium4 c-medium8 e-medium8 medium8 e-medium16 medium16 e-medium24 medium24 c-large e-large large c-large8 e-large8 large8 e-large16 large16 e-large24 large24 e-large32 large32 e-extra-large8 extra-large8 e-extra-large16 extra-large16 e-extra-large24 extra-large24 e-extra-large32 extra-large32 e-extra-large48 extra-large48 e-double-large16 double-large16 e-double-large24 double-large24 e-double-large32 double-large32 e-double-large48 double-large48 e-double-large64 double-large64 e-double-large96 double-large96 triple-large32 triple-large48 triple-large64 triple-large96 triple-large128 quad-large64 quad-large96 quad-large128 quad-large256 septa-large128 septa-large256 octa-large256 octa-large384 octa-large512
␣␣␣␣count	integer	サーバー数量
␣␣dynamicIpCount	integer	動的IP数
␣␣customizeImageCount	integer	カスタマイズイメージ数
␣␣addDiskCount	integer	追加ディスク数
␣␣addDiskTotalSize	integer	追加ディスク総容量
␣␣routerItemSet	-	ルーター情報セット
␣␣␣item	-	ルーター情報
␣␣␣␣type	string	ルータータイプ 値: small medium large
␣␣␣␣count	integer	ルーター数量
␣␣vpnGatewayItemSet	-	拠点間VPNゲートウェイ情報セット
␣␣␣item	-	拠点間VPNゲートウェイ情報
␣␣␣␣type	string	拠点間VPNゲートウェイタイプ 値: small medium large
␣␣␣␣count	integer	拠点間VPNゲートウェイ数量
␣␣networkFlowAmount	integer	ネットワーク転送量
␣␣securityGroupCount	integer	ファイアウォールグループ数
␣␣loadBalancerCount	integer	ロードバランサーVIP数
␣␣elasticIpItemSet	-	付替IPアドレス情報セット
␣␣␣item	-	付替IPアドレス情報
␣␣␣␣type	string	IPタイプ 値: public private
␣␣␣␣count	integer	付替IPアドレス数
␣␣sslCertCount	integer	SSL証明書数
␣␣monitoringRuleCount	integer	監視設定ルール数
␣␣autoScaleCount	integer	オートスケール設定数
␣␣privateLanCount	integer	プライベートLAN設定数
␣␣privateLanClassicCount	integer	プライベートLAN設定数（旧）
␣␣premiumSupportSet	-	プレミアムサポート設定情報セット
␣␣␣item	-	設定中のプレミアムサポート
␣␣␣␣supportName	string	設定中のプレミアムサポート名
␣␣niftyMultiAccountCount	integer	マルチアカウント数
␣␣elasticLoadBalancerCount	integer	マルチロードバランサーのVIP数
␣␣networkInterfaceItemSet	-	ネットワークインターフェース情報セット
␣␣␣item	-	ネットワークインターフェース情報
␣␣␣␣type	string	ネットワークインターフェースのタイプ
␣␣␣␣count	integer	ネットワークインターフェースの利用数
␣␣instanceBackupRuleCount	integer	バックアップルール数
␣␣remoteAccessVpnGatewaySet	-	リモートアクセスVPNゲートウェイ情報セット
␣␣␣item	-	リモートアクセスVPNゲートウェイ情報
␣␣␣␣type	string	リモートアクセスVPNゲートウェイタイプ 値: small medium large
␣␣␣␣count	integer	リモートアクセスVPNゲートウェイ数量
␣␣multiIpAddressItemSet	-	マルチIPアドレス情報セット
␣␣␣item	-	マルチIPアドレス情報
␣␣␣␣type	string	IPタイプ 値: public private
␣␣␣␣count	integer	マルチIPアドレス数
␣␣migrationHubItemSet	-	マイグレーションHub情報セット
␣␣␣item	-	マイグレーションHub情報
␣␣␣␣type	string	マイグレーションHubタイプ 値: small medium
␣␣␣␣count	integer	マイグレーションHub数

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeResources
  &CommonParams

  

応答サンプル

    <DescribeResourcesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <resourceInfo>
    <instanceItemSet>
      <item>
        <type>mini</type>
        <count>5</count>
      </item>
    </instanceItemSet>
    <dynamicIpCount>1</dynamicIpCount>
    <customizeImageCount>0</customizeImageCount>
    <addDiskCount>1</addDiskCount>
    <addDiskTotalSize>100</addDiskTotalSize>
    <routerItemSet>
      <item>
        <type>small</type>
        <count>3</count>
      </item>
    </routerItemSet>
    <vpnGatewayItemSet>
      <item>
        <type>small</type>
        <count>2</count>
      </item>
    </vpnGatewayItemSet>
    <networkFlowAmount>1</networkFlowAmount>
    <securityGroupCount>1</securityGroupCount>
    <loadBalancerCount>1</loadBalancerCount>
    <elasticIpItemSet>
      <item>
        <type>public</type>
        <count>2</count>
      </item>
    </elasticIpItemSet>
    <sslCertCount>1</sslCertCount>
    <monitoringRuleCount>1</monitoringRuleCount>
    <autoScaleCount>1</autoScaleCount>
    <privateLanCount>1</privateLanCount>
    <privateLanClassicCount>1</privateLanClassicCount>
    <premiumSupportSet>
      <item>
        <supportName>ヘルプデスク</supportName>
      </item>
    </premiumSupportSet>
    <niftyMultiAccountCount>3</niftyMultiAccountCount>
    <elasticLoadBalancerCount>1</elasticLoadBalancerCount>
    <networkInterfaceItemSet>
      <item>
        <type>private</type>
        <count>2</count>
      </item>
    </networkInterfaceItemSet>
    <instanceBackupRuleCount>1</instanceBackupRuleCount>
    <remoteAccessVpnGatewaySet>
      <item>
        <type>small</type>
        <count>2</count>
      </item>
    </remoteAccessVpnGatewaySet>
    <multiIpAddressItemSet>
      <item>
        <type>public</type>
        <count>2</count>
      </item>
    </multiIpAddressItemSet>
    <migrationHubItemSet>
      <item>
        <type>small</type>
        <count>1</count>
      </item>
    </migrationHubItemSet>
  </resourceInfo>
</DescribeResourcesResponse>