Class SummarizeHostInsightResourceStatisticsRequest

Inheritance

object

SummarizeHostInsightResourceStatisticsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OpsiService.Requests

Assembly: OCI.DotNetSDK.Opsi.dll

Syntax

public class SummarizeHostInsightResourceStatisticsRequest : IOciRequest

Examples

Click here to see an example of how to use SummarizeHostInsightResourceStatistics 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

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	A flag to search all resources within a given compartment and all sub-compartments.

DefinedTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "definedTagEquals", CollectionFormatType.Multi)]
public List<string> DefinedTagEquals { get; set; }

Property Value

Type	Description
List<string>	A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

Type

Description

List<string>

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

DefinedTagExists

Declaration

[HttpConverter(TargetEnum.Query, "definedTagExists", CollectionFormatType.Multi)]
public List<string> DefinedTagExists { get; set; }

Property Value

Type	Description
List<string>	A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

Type

Description

List<string>

A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

ExadataInsightId

Declaration

[HttpConverter(TargetEnum.Query, "exadataInsightId", CollectionFormatType.Multi)]
public List<string> ExadataInsightId { get; set; }

Property Value

Type	Description
List<string>	Optional list of exadata insight resource OCIDs.

ForecastDays

Declaration

[HttpConverter(TargetEnum.Query, "forecastDays")]
public int? ForecastDays { get; set; }

Property Value

Type	Description
int?	Number of days used for utilization forecast analysis.

FreeformTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "freeformTagEquals", CollectionFormatType.Multi)]
public List<string> FreeformTagEquals { get; set; }

Property Value

Type	Description
List<string>	A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

FreeformTagExists

Declaration

[HttpConverter(TargetEnum.Query, "freeformTagExists", CollectionFormatType.Multi)]
public List<string> FreeformTagExists { get; set; }

Property Value

Type	Description
List<string>	A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".

HighUtilizationThreshold

Declaration

[HttpConverter(TargetEnum.Query, "highUtilizationThreshold")]
public int? HighUtilizationThreshold { get; set; }

Property Value

Type	Description
int?	Percent value in which a resource metric is considered highly utilized.

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

[HttpConverter(TargetEnum.Query, "id", CollectionFormatType.Multi)]
public List<string> Id { get; set; }

Property Value

Type	Description
List<string>	Optional list of host insight resource OCIDs.

InsightBy

Declaration

[HttpConverter(TargetEnum.Query, "insightBy")]
public string InsightBy { get; set; }

Property Value

Type	Description
string	Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast

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

LowUtilizationThreshold

Declaration

[HttpConverter(TargetEnum.Query, "lowUtilizationThreshold")]
public int? LowUtilizationThreshold { get; set; }

Property Value

Type	Description
int?	Percent value in which a resource metric is considered low utilized.

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.

Percentile

Declaration

[HttpConverter(TargetEnum.Query, "percentile")]
public int? Percentile { get; set; }

Property Value

Type	Description
int?	Percentile values of daily usage to be used for computing the aggregate resource usage.

PlatformType

Declaration

[HttpConverter(TargetEnum.Query, "platformType", CollectionFormatType.Multi)]
public List<SummarizeHostInsightResourceStatisticsRequest.PlatformTypeEnum> PlatformType { get; set; }

Property Value

Type	Description
List<SummarizeHostInsightResourceStatisticsRequest.PlatformTypeEnum>	Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX].

ResourceMetric

Declaration

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

Property Value

Type	Description
string	Filter by host resource metric. Supported values are CPU, MEMORY, LOGICAL_MEMORY, STORAGE and NETWORK.

Remarks

Required

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public SummarizeHostInsightResourceStatisticsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
SummarizeHostInsightResourceStatisticsRequest.SortByEnum?	The order in which resource statistics records are listed.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	The sort order to use, either ascending (`ASC`) or descending (`DESC`).

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.

VmclusterName

Declaration

[HttpConverter(TargetEnum.Query, "vmclusterName", CollectionFormatType.Multi)]
public List<string> VmclusterName { get; set; }

Property Value

Type	Description
List<string>	Optional list of Exadata Insight VM cluster name.

Implements

IOciRequest