computing / Client / describe_volumes

describe_volumes

computing.Client.describe_volumes(**kwargs)

指定したディスクの情報を取得します。

ディスクを指定するためには、ディスク名が必要です。 削除済みのディスクを指定した、管理外のディスクを指定したなど、無効なディスクを指定した場合は、エラーが返されます。

ディスクを指定しない場合、取得できるすべてのディスク情報を取得します。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_volumes(
    VolumeId=[
        'string',
    ]
)

Parameters:

VolumeId (list) –

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VolumeSet': [
        {
            'AccountingType': 'string',
            'AttachmentSet': [
                {
                    'AttachTime': 'string',
                    'DeleteOnTermination': 'string',
                    'Device': 'string',
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string',
                    'Status': 'string',
                    'VolumeId': 'string',
                    'VolumeUniqueId': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'DiskType': 'string',
            'NextMonthAccountingType': 'string',
            'Size': 'string',
            'SnapshotId': 'string',
            'Status': 'string',
            'VolumeId': 'string',
            'VolumeUniqueId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • VolumeSet (list) –

    • (dict) –

      • AccountingType (string) –

      • AttachmentSet (list) –

        • (dict) –

          • AttachTime (string) –

          • DeleteOnTermination (string) –

          • Device (string) –

          • InstanceId (string) –

          • InstanceUniqueId (string) –

          • Status (string) –

          • VolumeId (string) –

          • VolumeUniqueId (string) –

      • AvailabilityZone (string) –

      • CreateTime (datetime) –

      • Description (string) –

      • DiskType (string) –

      • NextMonthAccountingType (string) –

      • Size (string) –

      • SnapshotId (string) –

      • Status (string) –

      • VolumeId (string) –

      • VolumeUniqueId (string) –