computing / Client / describe_images

describe_images

computing.Client.describe_images(**kwargs)

OSイメージの情報を取得します。

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_images(
    ExecutableBy=[
        'string',
    ],
    ImageId=[
        'string',
    ],
    ImageName=[
        'string',
    ],
    Owner=[
        'string',
    ]
)

Parameters:

• ExecutableBy (list) –

  • (string) –

• ImageId (list) –

  • (string) –

• ImageName (list) –

  • (string) –

• Owner (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ImagesSet': [
        {
            'Architecture': 'string',
            'BlockDeviceMapping': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'DeleteOnTermination': 'string',
                        'DiskType': 'string',
                        'SnapshotId': 'string',
                        'VolumeSize': 123
                    }
                },
            ],
            'Description': 'string',
            'DetailDescription': 'string',
            'ImageId': 'string',
            'ImageLocation': 'string',
            'ImageOwnerAlias': 'string',
            'ImageOwnerId': 'string',
            'ImageState': 'string',
            'ImageType': 'string',
            'IsGpuConfigurable': True|False,
            'IsPublic': True|False,
            'KernelId': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Name': 'string',
            'NiftyContactUrl': 'string',
            'NiftyDistributionIds': [
                {
                    'DistributionId': 'string'
                },
            ],
            'NiftyImageSize': 'string',
            'NiftyIsAllowedDistribution': True|False,
            'Placement': {
                'AvailabilityZone': 'string',
                'RegionName': 'string'
            },
            'Platform': 'string',
            'ProductCodes': [
                {
                    'ProductCode': 'string'
                },
            ],
            'RamdiskId': 'string',
            'Redistributable': True|False,
            'RootDeviceName': 'string',
            'RootDeviceType': 'string',
            'StateReason': {
                'Code': 'string',
                'Message': 'string'
            }
        },
    ],
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • ImagesSet (list) –

    • (dict) –

      • Architecture (string) –

      • BlockDeviceMapping (list) –

        • (dict) –

          • DeviceName (string) –

          • Ebs (dict) –

            • DeleteOnTermination (string) –

            • DiskType (string) –

            • SnapshotId (string) –

            • VolumeSize (integer) –

      • Description (string) –

      • DetailDescription (string) –

      • ImageId (string) –

      • ImageLocation (string) –

      • ImageOwnerAlias (string) –

      • ImageOwnerId (string) –

      • ImageState (string) –

      • ImageType (string) –

      • IsGpuConfigurable (boolean) –

      • IsPublic (boolean) –

      • KernelId (string) –

      • LaunchTime (datetime) –

      • Name (string) –

      • NiftyContactUrl (string) –

      • NiftyDistributionIds (list) –

        • (dict) –

          • DistributionId (string) –

      • NiftyImageSize (string) –

      • NiftyIsAllowedDistribution (boolean) –

      • Placement (dict) –

        • AvailabilityZone (string) –

        • RegionName (string) –

      • Platform (string) –

      • ProductCodes (list) –

        • (dict) –

          • ProductCode (string) –

      • RamdiskId (string) –

      • Redistributable (boolean) –

      • RootDeviceName (string) –

      • RootDeviceType (string) –

      • StateReason (dict) –

        • Code (string) –

        • Message (string) –

  • RequestId (string) –