Type Alias ListVolumesRequest

ListVolumesRequest: {
    name?: string;
    orderBy?: Block.v1.ListVolumesRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    productResourceId?: string;
    projectId?: string;
    tags?: string[];
    zone?: Zone;
}

Type declaration

  • Optionalname?: string

    Filter the return volumes by their names.

  • OptionalorderBy?: Block.v1.ListVolumesRequestOrderBy

    Criteria to use when ordering the list.

  • OptionalorganizationId?: string

    Filter by Organization ID.

  • Optionalpage?: number

    Page number.

  • OptionalpageSize?: number

    Page size, defines how many entries are returned in one page, must be lower or equal to 100.

  • OptionalproductResourceId?: string

    Filter by a product resource ID linked to this volume (such as an Instance ID).

  • OptionalprojectId?: string

    Filter by Project ID.

  • Optionaltags?: string[]

    Filter by tags. Only volumes with one or more matching tags will be returned.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings