#Metrics [monitoring.alauda.io/v1beta1]

/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/metrics#

getGet monitoring metrics of a cluster#

Retrieves monitoring metrics for a specified cluster.

Parameters#

• cluster (in path): string required

  Name of the cluster

• start (in query): integer

  Start time as a 10-digit timestamp

• end (in query): integer

  End time as a 10-digit timestamp

• step (in query): integer

  Step interval

• time (in query): integer

  Timestamp, defaults to current time. Mutually exclusive with start/end/step.

• timeout (in query): integer

  Timeout in seconds, default is 10s

• indicators (in query): string

  Metrics to query, multiple indicators separated by '|'

• expr (in query): string

  Native query expression, mutually exclusive with indicators

• variables (in query): string

  Variables for the query, formatted as 'A=v1,B=v2,C=v3'

Response#

• 200MetricList: Successful response with list of monitoring metrics
• 400Status: Monitoring plugin not deployed
• 503Status: Monitoring plugin unavailable

MetricList#

• indicator: string

  The indicator name

• query: string

  The native query expression

• result: []MetricResult

MetricResult#

• metric: map[string]string
• values: []string

Status#

• kind: string
• apiVersion: string
• metadata: object
• status: string
• message: string
• reason: string
• code: integer

/platform/monitoring.alauda.io/v1beta1/projects/{project}/metrics#

getGet monitoring metrics of a project#

Retrieves monitoring metrics for a specified cluster.

Parameters#

• project (in path): string required

  Name of the project

• start (in query): integer

  Start time as a 10-digit timestamp

• end (in query): integer

  End time as a 10-digit timestamp

• step (in query): integer

  Step interval

• time (in query): integer

  Timestamp, defaults to current time. Mutually exclusive with start/end/step.

• timeout (in query): integer

  Timeout in seconds, default is 10s

• indicators (in query): string

  Metrics to query, multiple indicators separated by '|'

• expr (in query): string

  Native query expression, mutually exclusive with indicators

• variables (in query): string

  Variables for the query, formatted as 'A=v1,B=v2,C=v3'

Response#

• 200MetricList: Successful response with list of monitoring metrics
• 400Status: Monitoring plugin not deployed
• 503Status: Monitoring plugin unavailable

MetricList#

• indicator: string

  The indicator name

• query: string

  The native query expression

• result: []MetricResult

MetricResult#

• metric: map[string]string
• values: []string

Status#

• kind: string
• apiVersion: string
• metadata: object
• status: string
• message: string
• reason: string
• code: integer

/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/metrics#

getGet monitoring metrics of a namespace#

Retrieves monitoring metrics for a specified cluster.

Parameters#

• project (in path): string required

  Name of the project

• cluster (in path): string required

  Name of the cluster

• namespace (in path): string required

  Name of the namespace

• start (in query): integer

  Start time as a 10-digit timestamp

• end (in query): integer

  End time as a 10-digit timestamp

• step (in query): integer

  Step interval

• time (in query): integer

  Timestamp, defaults to current time. Mutually exclusive with start/end/step.

• timeout (in query): integer

  Timeout in seconds, default is 10s

• indicators (in query): string

  Metrics to query, multiple indicators separated by '|'

• expr (in query): string

  Native query expression, mutually exclusive with indicators

• variables (in query): string

  Variables for the query, formatted as 'A=v1,B=v2,C=v3'

Response#

• 200MetricList: Successful response with list of monitoring metrics
• 400Status: Monitoring plugin not deployed
• 503Status: Monitoring plugin unavailable

MetricList#

• indicator: string

  The indicator name

• query: string

  The native query expression

• result: []MetricResult

MetricResult#

• metric: map[string]string
• values: []string

Status#

• kind: string
• apiVersion: string
• metadata: object
• status: string
• message: string
• reason: string
• code: integer