Class ContainersApi

Hierarchy

ContainersApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

listContainers listContainersWithPagination

Constructors

constructor

new ContainersApi(configuration: Configuration, requestFactory?: ContainersApiRequestFactory, responseProcessor?: ContainersApiResponseProcessor): ContainersApi
Parameters
- configuration: Configuration
- Optional requestFactory: ContainersApiRequestFactory
- Optional responseProcessor: ContainersApiResponseProcessor
Returns ContainersApi
- Defined in packages/datadog-api-client-v2/apis/ContainersApi.ts:221

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: ContainersApiRequestFactory

`Private` responseProcessor

responseProcessor: ContainersApiResponseProcessor

Methods

listContainers

listContainers(param?: ContainersApiListContainersRequest, options?: Configuration): Promise<ContainersResponse>
Get all containers for your organization. Use group_by to return container groups with counts. Grouped results are limited by page[size] and do not support pagination.

To get CPU or memory metrics, use a container data source query with /api/v2/query/scalar or /api/v2/query/timeseries.
Parameters
- param: ContainersApiListContainersRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<ContainersResponse>
- Defined in packages/datadog-api-client-v2/apis/ContainersApi.ts:241

listContainersWithPagination

listContainersWithPagination(param?: ContainersApiListContainersRequest, options?: Configuration): AsyncGenerator<ContainerItem, any, unknown>
Provide a paginated version of listContainers returning a generator with all the items.
Parameters
- param: ContainersApiListContainersRequest = {}
- Optional options: Configuration
Returns AsyncGenerator<ContainerItem, any, unknown>
- Defined in packages/datadog-api-client-v2/apis/ContainersApi.ts:265

Generated using TypeDoc