本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeResources

処理概要

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

指定するパラメーター

なし

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeResourcesResponse DescribeResourcesレスポンス
Type : DescribeResourcesResponseType
Ancestor : なし
Children : requestId, resourceInfo
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeResourcesResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
resourceInfo リソース情報
Type : DescribeResourceInfoType
Ancestor : DescribeResourcesResponse
Children : instanceItemSet, dynamicIpCount, customizeImageCount, addDiskCount, addDiskTotalSize, routerItemSet, vpnGatewayItemSet, networkFlowAmount, securityGroupCount, loadBalancerCount, elasticIpItemSet, sslCertCount, monitoringRuleCount, autoScaleCount, privateLanCount, privateLanClassicCount, premiumSupportSet, elasticLoadBalancerCount
 
instanceItemSet サーバー情報セット
Type : ResourceInstanceSetType
Ancestor : resourceInfo
Children : item
 
item サーバー情報
Type : ResourceInstanceItemType
Ancestor : instanceItemSet
Children : type, count
 
type サーバータイプ
Type : xsd:string
値: e-mini | mini | e-small | small | e-small2 | small2 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | e-medium | medium | e-medium4 | medium4 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | e-large | large | 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-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large128 | quad-large256 | septa-large256
Ancestor : item
Children : なし
 
count サーバー数量
Type : xsd:int
Ancestor : item
Children : なし
 
dynamicIpCount 動的IP数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
customizeImageCount カスタマイズイメージ数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
addDiskCount 追加ディスク数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
addDiskTotalSize 追加ディスク総容量
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
routerItemSet ルーター情報セット
Type : ResourceRouterSetType
Ancestor : resourceInfo
Children : item
 
item ルーター情報
Type : ResourceRouterItemType
Ancestor : routerItemSet
Children : type, count
 
type ルータータイプ
Type : xsd:string
Value : small | medium | large
Ancestor : item
Children : なし
 
count ルーター数量
Type : xsd:int
Ancestor : item
Children : なし
 
vpnGatewayItemSet VPNゲートウェイ情報セット
Type : ResourceVpnGatewaySetType
Ancestor : resourceInfo
Children : item
 
item VPNゲートウェイ情報
Type : ResourceVpnGatewayItemType
Ancestor : vpnGatewayItemSet
Children : type, count
 
type VPNゲートウェイタイプ
Type : xsd:string
Value : small | medium | large
Ancestor : item
Children : なし
 
count VPNゲートウェイ数量
Type : xsd:int
Ancestor : item
Children : なし
 
vpnGatewayItemSet VPNゲートウェイ情報セット
Type : ResourceVpnGatewaySetType
Ancestor : resourceInfo
Children : item
 
item VPNゲートウェイ情報
Type : ResourceVpnGatewayItemType
Ancestor : vpnGatewayItemSet
Children : type, count
 
type VPNゲートウェイタイプ
Type : xsd:string
Value : small | medium | large
Ancestor : item
Children : なし
 
count VPNゲートウェイ数量
Type : xsd:int
Ancestor : item
Children : なし
 
networkFlowAmount ネットワーク転送量
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
securityGroupCount ファイアウォールグループ数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
loadBalancerCount ロードバランサーVIP数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
elasticIpItemSet 付替IPアドレス情報セット
Type : ResourceAddressSetType
Ancestor : resourceInfo
Children : item
 
item 付替IPアドレス情報
Type : ResourceAddressItemType
Ancestor : elasticIpItemSet
Children : type, count
 
type IPタイプ
Type : xsd:string
Value : public | private
Ancestor : item
Children : なし
 
count 付替IPアドレス数
Type : xsd:int
Ancestor : item
Children : なし
 
sslCertCount SSL証明書数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
monitoringRuleCount 監視設定ルール数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
autoScaleCount オートスケール設定数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
privateLanCount プライベートLAN設定数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
privateLanClassicCount プライベートLAN設定数(旧)
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
premiumSupportSet プレミアムサポート設定情報セット
Type : ResourceSupportSetType
Ancestor : resourceInfo
Children : item
 
item 設定中のプレミアムサポート
Type : ResourceSupportItemType
Ancestor : premiumSupportSet
Children : supportName
 
supportName 設定中のプレミアムサポート名
Type : xsd:string
Ancestor : item
Children : なし
OSパッチ適用
niftyMultiAccountCount マルチアカウント数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 
elasticLoadBalancerCount マルチロードバランサーのVIP数
Type : xsd:int
Ancestor : resourceInfo
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeResources&CommonParams

応答サンプル

<DescribeResourcesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>b1d415ab-5916-49b2-a428-07ca18548c56</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>mini</type>
        <count>3</count>
      </item>
    </routerItemSet>
    <vpnGatewayItemSet>
      <item>
        <type>mini</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>
  </resourceInfo>
</DescribeResourcesResponse>

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

APIメニュー

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

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