computing / Client / describe_usage

describe_usage

computing.Client.describe_usage(**kwargs)

リソースの利用状況を返却します。

存在する情報のみ、レスポンス内にタグが生成されます。

取得対象リージョンを設定した場合はサーバー利用情報などそのリージョンに属する個別情報を、指定しなかった場合はSSL証明書利用情報などリージョン共通情報と東日本リージョンの個別情報を返却します。

IsCharge=trueを指定した場合、レスポンスの各リソースに対して利用料金が返却されます。

Request Syntax

response = client.describe_usage(
    IsCharge=True|False,
    Region='string',
    YearMonth='string'
)

Parameters:

IsCharge (boolean) –
Region (string) –
YearMonth (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AutoScaleInfo': {
        'AutoScaleCount': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'RunningScaleOutInstanceSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RunningScaleOutOsSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedScaleOutInstanceSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedScaleOutOsSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ChargeDetailInfo': {
        'ChargeDetail': {
            'Charge': 123,
            'Value': 123
        }
    },
    'CopyInfo': {
        'InstanceCopy': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'ElasticIpInfo': {
        'ElasticIpSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ElasticLoadBalancerInfo': {
        'Vip': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipMeasuredRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ExtraChargeInfo': {
        'ExtraChargeMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ImageInfo': {
        'CreateImage': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'KeepImageSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'InstanceBackupInfo': {
        'InstanceBackupBaseSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'InstanceBackupImportInstanceDiskSet': {
            'Charge': 123,
            'Unit': 'string',
            'Value': 123
        },
        'InstanceBackupVolumeSet': {
            'Charge': 123,
            'Unit': 'string',
            'Value': 123
        }
    },
    'InstanceInfo': {
        'DynamicIpMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'DynamicIpMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'InstanceMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'MultiIpMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'OsMeasuredRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'OsMonthlyRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RunningInstanceMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedInstanceMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'InternetVpnInfo': {
        'InternetVpnInitial': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'InternetVpnMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Value': 123
            },
        ]
    },
    'LicenseInfo': {
        'LicenseMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'LiveMigrationInfo': {
        'LiveMigrationHubMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'LiveMigrationOperationMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'LoadBalancerInfo': {
        'OptionSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'MultiAccountInfo': {
        'MultiAccount': {
            'Charge': 123,
            'Unit': 'string',
            'Value': 123
        }
    },
    'MultiIpAddressInfo': {
        'MultiIpAddressMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'NetworkInfo': {
        'NetworkFlowSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'NetworkInterfaceInfo': {
        'NetworkInterfaceMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'OptionCommonInfo': [
        {
            'OptionName': 'string',
            'OptionSet': [
                {
                    'Charge': 123,
                    'Type': 'string',
                    'Unit': 'string',
                    'Value': 123
                },
            ]
        },
    ],
    'OptionInfo': [
        {
            'OptionName': 'string',
            'OptionSet': [
                {
                    'Charge': 123,
                    'Type': 'string',
                    'Unit': 'string',
                    'Value': 123
                },
            ]
        },
    ],
    'OsOptionChargeInfo': {
        'OsOptionChargeMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PatternAuthInfo': {
        'PatternAuthSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PremiumSupportInfo': {
        'PremiumSupportSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PrivateLanInfo': {
        'PrivateLan': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'PrivateNetworkInfo': {
        'PrivateNetworkMeasuredRate': {
            'Charge': 123,
            'Unit': 'string',
            'Value': 123
        },
        'PrivateNetworkMonthlyRate': {
            'Charge': 123,
            'Value': 123
        }
    },
    'RemoteAccessVpnGatewayInfo': {
        'RemoteAccessVpnGatewayMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RemoteAccessVpnGatewayMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'RequestId': 'string',
    'RouterInfo': {
        'RouterMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RouterMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'SecurityGroupInfo': {
        'OptionSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'SecurityGroupApplyTime': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'SnapshotInfo': {
        'SnapShot': {
            'Charge': 123,
            'Unit': 'string',
            'Value': 123
        }
    },
    'SslCertInfo': {
        'CreateSslCertSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'VolumeInfo': {
        'ImportInstanceDiskMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'ImportInstanceDiskMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'VolumeMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VolumeSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'VpnGatewayInfo': {
        'VpnGatewayMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VpnGatewayMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'YearMonth': 'string'
}

Response Structure

(dict) –
- AutoScaleInfo (dict) –
  - AutoScaleCount (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - RunningScaleOutInstanceSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - RunningScaleOutOsSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - StoppedScaleOutInstanceSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - StoppedScaleOutOsSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- ChargeDetailInfo (dict) –
  - ChargeDetail (dict) –
    - Charge (integer) –
    - Value (integer) –
- CopyInfo (dict) –
  - InstanceCopy (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
- ElasticIpInfo (dict) –
  - ElasticIpSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- ElasticLoadBalancerInfo (dict) –
  - Vip (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - VipMeasuredRate (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- ExtraChargeInfo (dict) –
  - ExtraChargeMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- ImageInfo (dict) –
  - CreateImage (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - KeepImageSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- InstanceBackupInfo (dict) –
  - InstanceBackupBaseSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - InstanceBackupImportInstanceDiskSet (dict) –
    - Charge (integer) –
    - Unit (string) –
    - Value (integer) –
  - InstanceBackupVolumeSet (dict) –
    - Charge (integer) –
    - Unit (string) –
    - Value (integer) –
- InstanceInfo (dict) –
  - DynamicIpMeasuredRate (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - DynamicIpMonthlyRate (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - InstanceMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - MultiIpMonthlyRate (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - OsMeasuredRate (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - OsMonthlyRate (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - RunningInstanceMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - StoppedInstanceMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- InternetVpnInfo (dict) –
  - InternetVpnInitial (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - InternetVpnMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Value (integer) –
- LicenseInfo (dict) –
  - LicenseMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- LiveMigrationInfo (dict) –
  - LiveMigrationHubMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - LiveMigrationOperationMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- LoadBalancerInfo (dict) –
  - OptionSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - VipMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - VipSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- MultiAccountInfo (dict) –
  - MultiAccount (dict) –
    - Charge (integer) –
    - Unit (string) –
    - Value (integer) –
- MultiIpAddressInfo (dict) –
  - MultiIpAddressMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- NetworkInfo (dict) –
  - NetworkFlowSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- NetworkInterfaceInfo (dict) –
  - NetworkInterfaceMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- OptionCommonInfo (list) –
  - (dict) –
    - OptionName (string) –
    - OptionSet (list) –
      - (dict) –
        
        Charge (integer) –
        
        Type (string) –
        
        Unit (string) –
        
        Value (integer) –
- OptionInfo (list) –
  - (dict) –
    - OptionName (string) –
    - OptionSet (list) –
      - (dict) –
        
        Charge (integer) –
        
        Type (string) –
        
        Unit (string) –
        
        Value (integer) –
- OsOptionChargeInfo (dict) –
  - OsOptionChargeMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- PatternAuthInfo (dict) –
  - PatternAuthSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- PremiumSupportInfo (dict) –
  - PremiumSupportSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- PrivateLanInfo (dict) –
  - PrivateLan (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
- PrivateNetworkInfo (dict) –
  - PrivateNetworkMeasuredRate (dict) –
    - Charge (integer) –
    - Unit (string) –
    - Value (integer) –
  - PrivateNetworkMonthlyRate (dict) –
    - Charge (integer) –
    - Value (integer) –
- RemoteAccessVpnGatewayInfo (dict) –
  - RemoteAccessVpnGatewayMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - RemoteAccessVpnGatewayMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- RequestId (string) –
- RouterInfo (dict) –
  - RouterMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - RouterMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- SecurityGroupInfo (dict) –
  - OptionSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - SecurityGroupApplyTime (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
- SnapshotInfo (dict) –
  - SnapShot (dict) –
    - Charge (integer) –
    - Unit (string) –
    - Value (integer) –
- SslCertInfo (dict) –
  - CreateSslCertSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- VolumeInfo (dict) –
  - ImportInstanceDiskMeasuredRate (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - ImportInstanceDiskMonthlyRate (dict) –
    - Charge (integer) –
    - Type (string) –
    - Unit (string) –
    - Value (integer) –
  - VolumeMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - VolumeSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- VpnGatewayInfo (dict) –
  - VpnGatewayMeasuredRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
  - VpnGatewayMonthlyRateSet (list) –
    - (dict) –
      - Charge (integer) –
      - Type (string) –
      - Unit (string) –
      - Value (integer) –
- YearMonth (string) –