Class SummarizeHostInsightTopProcessesUsageRequest

Inheritance
object
SummarizeHostInsightTopProcessesUsageRequest
Implements
Inherited Members
Namespace: Oci.OpsiService.Requests
Assembly: OCI.DotNetSDK.Opsi.dll
Syntax
public class SummarizeHostInsightTopProcessesUsageRequest : IOciRequest
Examples

Click here to see an example of how to use SummarizeHostInsightTopProcessesUsage request.

Properties

AnalysisTimeInterval

Declaration
[HttpConverter(TargetEnum.Query, "analysisTimeInterval")]
public string AnalysisTimeInterval { get; set; }
Property Value
Type Description
string

Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.
Remarks

Required

HostId

Declaration
[HttpConverter(TargetEnum.Query, "hostId")]
public string HostId { get; set; }
Property Value
Type Description
string

Optional OCID of the host (Compute Id)

HostType

Declaration
[HttpConverter(TargetEnum.Query, "hostType", CollectionFormatType.Multi)]
public List<string> HostType { get; set; }
Property Value
Type Description
List<string>

Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type Description
string

Required OCID of the host insight resource.
Remarks

Required

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

ResourceMetric

Declaration
[Required(ErrorMessage = "ResourceMetric is required.")]
[HttpConverter(TargetEnum.Query, "resourceMetric")]
public string ResourceMetric { get; set; }
Property Value
Type Description
string

Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY.
Remarks

Required

Statistic

Declaration
[HttpConverter(TargetEnum.Query, "statistic")]
public SummarizeHostInsightTopProcessesUsageRequest.StatisticEnum? Statistic { get; set; }
Property Value
Type Description
SummarizeHostInsightTopProcessesUsageRequest.StatisticEnum?

Choose the type of statistic metric data to be used for forecasting.

Status

Declaration
[HttpConverter(TargetEnum.Query, "status", CollectionFormatType.Multi)]
public List<ResourceStatus> Status { get; set; }
Property Value
Type Description
List<ResourceStatus>

Resource Status

TimeIntervalEnd

Declaration
[HttpConverter(TargetEnum.Query, "timeIntervalEnd")]
public DateTime? TimeIntervalEnd { get; set; }
Property Value
Type Description
DateTime?

Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.

TimeIntervalStart

Declaration
[HttpConverter(TargetEnum.Query, "timeIntervalStart")]
public DateTime? TimeIntervalStart { get; set; }
Property Value
Type Description
DateTime?

Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.

Timestamp

Declaration
[Required(ErrorMessage = "Timestamp is required.")]
[HttpConverter(TargetEnum.Query, "timestamp")]
public DateTime? Timestamp { get; set; }
Property Value
Type Description
DateTime?

Timestamp at which to gather the top processes. This will be top processes over the hour or over the day pending the time range passed into the query.
Remarks

Required

Implements