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

DescribeResources

処理概要

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

指定するパラメーター

パラメーター	型	説明	必須

応答フィールド

フィールド (項目)	型	説明
DescribeResourcesResponse	-	DescribeResourcesレスポンス Ancestor: なし Children: requestId | resourceInfo
requestId	string	リクエスト識別子 Ancestor: DescribeResourcesResponse Children: なし
resourceInfo	-	リソース情報 Ancestor: DescribeResourcesResponse Children: instanceItemSet | dynamicIpCount | customizeImageCount | addDiskCount | addDiskTotalSize | routerItemSet | vpnGatewayItemSet | networkFlowAmount | securityGroupCount | loadBalancerCount | elasticIpItemSet | sslCertCount | monitoringRuleCount | autoScaleCount | privateLanCount | privateLanClassicCount | premiumSupportSet | elasticLoadBalancerCount | networkInterfaceItemSet | instanceBackupRuleCount | remoteAccessVpnGatewaySet | multiIpAddressItemSet
instanceItemSet	-	サーバー情報セット Ancestor: resourceInfo Children: item
item	-	サーバー情報 Ancestor: instanceItemSet Children: type | count
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 Ancestor: item Children: なし
count	integer	サーバー数量 Ancestor: item Children: なし
dynamicIpCount	integer	動的IP数 Ancestor: resourceInfo Children: なし
customizeImageCount	integer	カスタマイズイメージ数 Ancestor: resourceInfo Children: なし
addDiskCount	integer	追加ディスク数 Ancestor: resourceInfo Children: なし
addDiskTotalSize	integer	追加ディスク総容量 Ancestor: resourceInfo Children: なし
routerItemSet	-	ルーター情報セット Ancestor: resourceInfo Children: item
item	-	ルーター情報 Ancestor: routerItemSet Children: type | count
type	string	ルータータイプ 値: small medium large Ancestor: item Children: なし
count	integer	ルーター数量 Ancestor: item Children: なし
vpnGatewayItemSet	-	拠点間VPNゲートウェイ情報セット Ancestor: resourceInfo Children: item
item	-	拠点間VPNゲートウェイ情報 Ancestor: vpnGatewayItemSet Children: type | count
type	string	拠点間VPNゲートウェイタイプ 値: small medium large Ancestor: item Children: なし
count	integer	拠点間VPNゲートウェイ数量 Ancestor: item Children: なし
networkFlowAmount	integer	ネットワーク転送量 Ancestor: resourceInfo Children: なし
securityGroupCount	integer	ファイアウォールグループ数 Ancestor: resourceInfo Children: なし
loadBalancerCount	integer	ロードバランサーVIP数 Ancestor: resourceInfo Children: なし
elasticIpItemSet	-	付替IPアドレス情報セット Ancestor: resourceInfo Children: item
item	-	付替IPアドレス情報 Ancestor: elasticIpItemSet Children: type | count
type	string	IPタイプ 値: public private Ancestor: item Children: なし
count	integer	付替IPアドレス数 Ancestor: item Children: なし
sslCertCount	integer	SSL証明書数 Ancestor: resourceInfo Children: なし
monitoringRuleCount	integer	監視設定ルール数 Ancestor: resourceInfo Children: なし
autoScaleCount	integer	オートスケール設定数 Ancestor: resourceInfo Children: なし
privateLanCount	integer	プライベートLAN設定数 Ancestor: resourceInfo Children: なし
privateLanClassicCount	integer	プライベートLAN設定数（旧） Ancestor: resourceInfo Children: なし
premiumSupportSet	-	プレミアムサポート設定情報セット Ancestor: resourceInfo Children: item
item	-	設定中のプレミアムサポート Ancestor: premiumSupportSet Children: supportName
supportName	string	設定中のプレミアムサポート名 Ancestor: item Children: なし
niftyMultiAccountCount	integer	マルチアカウント数 Ancestor: resourceInfo Children: なし
elasticLoadBalancerCount	integer	マルチロードバランサーのVIP数 Ancestor: resourceInfo Children: なし
networkInterfaceItemSet	-	ネットワークインターフェース情報セット Ancestor: resourceInfo Children: item
item	-	ネットワークインターフェース情報 Ancestor: networkInterfaceItemSet Children: type | count
type	string	ネットワークインターフェースのタイプ Ancestor: item Children: なし
count	integer	ネットワークインターフェースの利用数 Ancestor: item Children: なし
instanceBackupRuleCount	integer	バックアップルール数 Ancestor: resourceInfo Children: なし
remoteAccessVpnGatewaySet	-	リモートアクセスVPNゲートウェイ情報セット Ancestor: resourceInfo Children: item
item	-	リモートアクセスVPNゲートウェイ情報 Ancestor: remoteAccessVpnGatewaySet Children: type | count
type	string	リモートアクセスVPNゲートウェイタイプ 値: small medium large Ancestor: item Children: なし
count	integer	リモートアクセスVPNゲートウェイ数量 Ancestor: item Children: なし
multiIpAddressItemSet	-	マルチIPアドレス情報セット Ancestor: resourceInfo Children: item
item	-	マルチIPアドレス情報 Ancestor: multiIpAddressItemSet Children: type | count
type	string	IPタイプ 値: public private Ancestor: item Children: なし
count	integer	マルチIPアドレス数 Ancestor: item Children: なし

リクエストサンプル

    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>
  </resourceInfo>
</DescribeResourcesResponse>