Metric

Package : spaceone.api.inventory.v1

Metric

Metric Methods:

Method
Request
Response

create

POST /inventory/v1/metric/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

CreateMetricRequest

  • name (string) Required

  • metric_type (MetricType) Required

  • query_options (AnalyzeQuery) Required

  • namespace_id (string) Required

  • resource_group (ResourceGroup) Required

  • metric_id (string)

  • resource_type (string)

  • date_field (string)

  • unit (string)

  • tags (Struct)

  • workspace_id (string)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

MetricInfo

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

POST /inventory/v1/metric/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

UpdateMetricRequest

  • metric_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • date_field (string)

  • unit (string)

  • tags (Struct)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

MetricInfo

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

POST /inventory/v1/metric/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

MetricRequest

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

run

POST /inventory/v1/metric/run

{{< tabs " run " >}}

{{< tab "Request Example" >}}

MetricRequest

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

test

POST /inventory/v1/metric/test

{{< tabs " test " >}}

{{< tab "Request Example" >}}

MetricTestRequest

  • metric_id (string) Required

  • query_options (AnalyzeQuery) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

POST /inventory/v1/metric/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

MetricRequest

  • metric_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

MetricInfo

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

POST /inventory/v1/metric/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

MetricQuery

  • query (Query)

  • metric_id (string)

  • metric_type (MetricType)

  • resource_type (string)

  • is_managed (string)

  • workspace_id (string)

  • namespace_id (string)

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /inventory/v1/metric/stat

Message

CreateMetricRequest

  • name (string) Required

  • metric_type (MetricType) Required

  • query_options (AnalyzeQuery) Required

  • namespace_id (string) Required

  • resource_group (ResourceGroup) Required

  • metric_id (string)

  • resource_type (string)

  • date_field (string)

  • unit (string)

  • tags (Struct)

  • workspace_id (string)

MetricInfo

  • metric_id (string) Required

  • name (string) Required

  • metric_type (MetricType) Required

  • resource_type (string) Required

  • query_options (AnalyzeQuery) Required

  • date_field (string) Required

  • unit (string) Required

  • tags (Struct) Required

  • labels_info (Struct) Repeated Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • namespace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

MetricQuery

  • query (Query)

  • metric_id (string)

  • metric_type (MetricType)

  • resource_type (string)

  • is_managed (string)

  • workspace_id (string)

  • namespace_id (string)

MetricRequest

  • metric_id (string) Required

MetricStatQuery

  • query (StatisticsQuery) Required

MetricTestRequest

  • metric_id (string) Required

  • query_options (AnalyzeQuery) Required

MetricsInfo

  • results (MetricInfo) Repeated Required

  • total_count (int32) Required

UpdateMetricRequest

  • metric_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • date_field (string)

  • unit (string)

  • tags (Struct)

PreviousJobTaskNextMetricData

Last updated