Type Alias ListPlacementGroupsRequest

ListPlacementGroupsRequest: {
    name?: string;
    organization?: string;
    page?: number;
    perPage?: number;
    project?: string;
    tags?: string[];
    zone?: Zone;
}

Type declaration

  • Optionalname?: string

    Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo").

  • Optionalorganization?: string

    List only placement groups of this Organization ID.

  • Optionalpage?: number

    A positive integer to choose the page to return.

  • OptionalperPage?: number

    A positive integer lower or equal to 100 to select the number of items to return.

  • Optionalproject?: string

    List only placement groups of this Project ID.

  • Optionaltags?: string[]

    List placement groups with these exact tags (to filter with several tags, use commas to separate them).

  • Optionalzone?: Zone

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

Settings