computing / Client / describe_instances

describe_instances

computing.Client.describe_instances(**kwargs)

指定したサーバーの情報を取得します。1回のリクエストで、複数のサーバー情報を取得できます。

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_instances(
    InstanceId=[
        'string',
    ],
    Tenancy=[
        'string',
    ]
)

Parameters:

• InstanceId (list) –

  • (string) –

• Tenancy (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'ReservationSet': [
        {
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'InstancesSet': [
                {
                    'AccountingType': 'string',
                    'AmiLaunchIndex': 'string',
                    'Architecture': 'string',
                    'Autoscaling': {
                        'AutoScalingGroupName': 'string',
                        'ExpireTime': datetime(2015, 1, 1)
                    },
                    'BlockDeviceMapping': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': 'string',
                                'DeleteOnTermination': 'string',
                                'Status': 'string',
                                'VolumeId': 'string',
                                'VolumeUniqueId': 'string'
                            }
                        },
                    ],
                    'CopyInfo': 'string',
                    'Description': 'string',
                    'DnsName': 'string',
                    'HotAdd': 'string',
                    'ImageId': 'string',
                    'ImageName': 'string',
                    'InstanceBackupRule': {
                        'InstanceBackupRuleId': 'string',
                        'InstanceBackupRuleName': 'string'
                    },
                    'InstanceId': 'string',
                    'InstanceLifecycle': 'string',
                    'InstanceState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'InstanceType': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'IpAddressV6': 'string',
                    'IpType': 'string',
                    'IsGpuConfigurable': True|False,
                    'IsoImageSet': [
                        {
                            'IsoImageId': 'string',
                            'IsoImageName': 'string'
                        },
                    ],
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Loadbalancing': [
                        {
                            'InstancePort': 123,
                            'LoadBalancerName': 'string',
                            'LoadBalancerPort': 123,
                            'State': 'string'
                        },
                    ],
                    'Monitoring': {
                        'State': 'string'
                    },
                    'MultiIpAddressGroup': {
                        'MultiIpAddressGroupId': 'string',
                        'MultiIpAddressGroupName': 'string'
                    },
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': 'string',
                                'AttachmentId': 'string',
                                'DeleteOnTermination': 'string',
                                'DeviceIndex': 'string',
                                'Status': 'string'
                            },
                            'Description': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'MacAddress': 'string',
                            'MultiIpAddressesSet': [
                                {
                                    'IpAddress': 'string'
                                },
                            ],
                            'NetworkInterfaceId': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'NiftyElasticLoadBalancing': [
                        {
                            'ElasticLoadBalancerId': 'string',
                            'ElasticLoadBalancerName': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'InstancePort': 123,
                            'Protocol': 'string'
                        },
                    ],
                    'NiftyPrivateIpType': 'string',
                    'NiftyPrivateNetworkType': 'string',
                    'NiftySnapshotting': [
                        {
                            'State': 'string'
                        },
                    ],
                    'Placement': {
                        'AvailabilityZone': 'string'
                    },
                    'Platform': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'ProductCodes': [
                        {
                            'ProductCode': 'string'
                        },
                    ],
                    'RamdiskId': 'string',
                    'Reason': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'string',
                    'SpotInstanceRequestId': 'string',
                    'StateReason': {
                        'Code': 'string',
                        'Message': 'string'
                    },
                    'SubnetId': 'string',
                    'Tenancy': 'string',
                    'VmTools': {
                        'State': 'string',
                        'Version': 'string'
                    },
                    'VpcId': 'string'
                },
            ],
            'OwnerId': 'string',
            'ReservationId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • ReservationSet (list) –

    • (dict) –

      • GroupSet (list) –

        • (dict) –

          • GroupId (string) –

      • InstancesSet (list) –

        • (dict) –

          • AccountingType (string) –

          • AmiLaunchIndex (string) –

          • Architecture (string) –

          • Autoscaling (dict) –

            • AutoScalingGroupName (string) –

            • ExpireTime (datetime) –

          • BlockDeviceMapping (list) –

            • (dict) –

              • DeviceName (string) –

              • Ebs (dict) –

                • AttachTime (string) –

                • DeleteOnTermination (string) –

                • Status (string) –

                • VolumeId (string) –

                • VolumeUniqueId (string) –

          • CopyInfo (string) –

          • Description (string) –

          • DnsName (string) –

          • HotAdd (string) –

          • ImageId (string) –

          • ImageName (string) –

          • InstanceBackupRule (dict) –

            • InstanceBackupRuleId (string) –

            • InstanceBackupRuleName (string) –

          • InstanceId (string) –

          • InstanceLifecycle (string) –

          • InstanceState (dict) –

            • Code (integer) –

            • Name (string) –

          • InstanceType (string) –

          • InstanceUniqueId (string) –

          • IpAddress (string) –

          • IpAddressV6 (string) –

          • IpType (string) –

          • IsGpuConfigurable (boolean) –

          • IsoImageSet (list) –

            • (dict) –

              • IsoImageId (string) –

              • IsoImageName (string) –

          • KernelId (string) –

          • KeyName (string) –

          • LaunchTime (datetime) –

          • Loadbalancing (list) –

            • (dict) –

              • InstancePort (integer) –

              • LoadBalancerName (string) –

              • LoadBalancerPort (integer) –

              • State (string) –

          • Monitoring (dict) –

            • State (string) –

          • MultiIpAddressGroup (dict) –

            • MultiIpAddressGroupId (string) –

            • MultiIpAddressGroupName (string) –

          • NetworkInterfaceSet (list) –

            • (dict) –

              • Association (dict) –

                • IpOwnerId (string) –

                • PublicDnsName (string) –

                • PublicIp (string) –

                • PublicIpV6 (string) –

              • Attachment (dict) –

                • AttachTime (string) –

                • AttachmentId (string) –

                • DeleteOnTermination (string) –

                • DeviceIndex (string) –

                • Status (string) –

              • Description (string) –

              • GroupSet (list) –

                • (dict) –

                  • GroupId (string) –

              • MacAddress (string) –

              • MultiIpAddressesSet (list) –

                • (dict) –

                  • IpAddress (string) –

              • NetworkInterfaceId (string) –

              • NiftyNetworkId (string) –

              • NiftyNetworkName (string) –

              • OwnerId (string) –

              • PrivateDnsName (string) –

              • PrivateIpAddress (string) –

              • PrivateIpAddressV6 (string) –

              • PrivateIpAddressesSet (list) –

                • (dict) –

                  • Association (dict) –

                    • IpOwnerId (string) –

                    • PublicDnsName (string) –

                    • PublicIp (string) –

                    • PublicIpV6 (string) –

                  • Primary (boolean) –

                  • PrivateDnsName (string) –

                  • PrivateIpAddress (string) –

              • SourceDestCheck (string) –

              • Status (string) –

              • SubnetId (string) –

              • VpcId (string) –

          • NextMonthAccountingType (string) –

          • NiftyElasticLoadBalancing (list) –

            • (dict) –

              • ElasticLoadBalancerId (string) –

              • ElasticLoadBalancerName (string) –

              • ElasticLoadBalancerPort (integer) –

              • InstancePort (integer) –

              • Protocol (string) –

          • NiftyPrivateIpType (string) –

          • NiftyPrivateNetworkType (string) –

          • NiftySnapshotting (list) –

            • (dict) –

              • State (string) –

          • Placement (dict) –

            • AvailabilityZone (string) –

          • Platform (string) –

          • PrivateDnsName (string) –

          • PrivateIpAddress (string) –

          • PrivateIpAddressV6 (string) –

          • ProductCodes (list) –

            • (dict) –

              • ProductCode (string) –

          • RamdiskId (string) –

          • Reason (string) –

          • RootDeviceName (string) –

          • RootDeviceType (string) –

          • SpotInstanceRequestId (string) –

          • StateReason (dict) –

            • Code (string) –

            • Message (string) –

          • SubnetId (string) –

          • Tenancy (string) –

          • VmTools (dict) –

            • State (string) –

            • Version (string) –

          • VpcId (string) –

      • OwnerId (string) –

      • ReservationId (string) –