Database - Corsair

The GMI Cloud plugin syncs data locally. Use corsair.gmicloud.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Baremetals

Path: gmicloud.db.baremetals.search

const rows = await corsair.gmicloud.db.baremetals.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`consoleReady`	`boolean`	equals
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`idc`	`string`	equals, contains, startsWith, endsWith, in
`image`	`string`	equals, contains, startsWith, endsWith, in
`imageId`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`orgId`	`string`	equals, contains, startsWith, endsWith, in
`product`	`string`	equals, contains, startsWith, endsWith, in
`reason`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Containers

Path: gmicloud.db.containers.search

const rows = await corsair.gmicloud.db.containers.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`eipAddress`	`string`	equals, contains, startsWith, endsWith, in
`eipId`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`modifiedAt`	`string`	equals, contains, startsWith, endsWith, in
`orgId`	`string`	equals, contains, startsWith, endsWith, in
`reason`	`string`	equals, contains, startsWith, endsWith, in
`idc`	`string`	equals, contains, startsWith, endsWith, in
`product`	`string`	equals, contains, startsWith, endsWith, in
`command`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`templateId`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Elastic Ips

Path: gmicloud.db.elasticIps.search

const rows = await corsair.gmicloud.db.elasticIps.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`orgId`	`string`	equals, contains, startsWith, endsWith, in
`maxBandwidth`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`idc`	`string`	equals, contains, startsWith, endsWith, in
`ipAddress`	`string`	equals, contains, startsWith, endsWith, in
`product`	`string`	equals, contains, startsWith, endsWith, in
`instanceID`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Firewalls

Path: gmicloud.db.firewalls.search

const rows = await corsair.gmicloud.db.firewalls.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`idc`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`isPreset`	`boolean`	equals
`orgId`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Media Requests

Path: gmicloud.db.mediaRequests.search

const rows = await corsair.gmicloud.db.mediaRequests.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`requestId`	`string`	equals, contains, startsWith, endsWith, in
`model`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`number`	equals, gt, gte, lt, lte, in
`updatedAt`	`number`	equals, gt, gte, lt, lte, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Models

Path: gmicloud.db.models.search

const rows = await corsair.gmicloud.db.models.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`object`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`created`	`number`	equals, gt, gte, lt, lte, in
`owned_by`	`string`	equals, contains, startsWith, endsWith, in
`context_length`	`number`	equals, gt, gte, lt, lte, in
`quantization`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Sandboxes

Path: gmicloud.db.sandboxes.search

const rows = await corsair.gmicloud.db.sandboxes.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`sandbox_key`	`string`	equals, contains, startsWith, endsWith, in
`template_id`	`string`	equals, contains, startsWith, endsWith, in
`idc_name`	`string`	equals, contains, startsWith, endsWith, in
`product`	`string`	equals, contains, startsWith, endsWith, in
`product_name`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`running_at`	`string`	equals, contains, startsWith, endsWith, in
`started_at`	`string`	equals, contains, startsWith, endsWith, in
`end_at`	`string`	equals, contains, startsWith, endsWith, in
`domain`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Sandbox Templates

Path: gmicloud.db.sandboxTemplates.search

const rows = await corsair.gmicloud.db.sandboxTemplates.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`idc_name`	`string`	equals, contains, startsWith, endsWith, in
`product`	`string`	equals, contains, startsWith, endsWith, in
`current_build_id`	`string`	equals, contains, startsWith, endsWith, in
`latest_build_id`	`string`	equals, contains, startsWith, endsWith, in
`rebuildable`	`boolean`	equals
`deleted_at`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.