Metrics

List and Create Metrics

Search metrics within tenant.

  • Examples:
    • https://{{server}}/api/v2/tenants/{{tenantId}}/metrics?queryString=scope:client
    • https://{{server}}/api/v2/tenants/{{tenantId}}/metrics?queryString=metricName:esx_problem_vmfs_heartbeat_timedout
    • https://{{server}}/api/v2/tenants/{{tenantId}}/metrics?queryString=groupName:vmware_vsan_host_net_rxPackets

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

Query Parameters

  • queryStringstring

    The query string to prepare query

  • metricNamestring

    Filter on metric name

  • groupNamestring

    Filter on metric group name

  • displayNamestring

    Filter on metric display name

  • scopestring

    Filter metrics within scope. e.g. partner scope lists only partner scoped metrics.'global' scope lists metrics visible to all.

    Enum:
    clientpartnerglobalservice provider

Responses

  • resultsarray

  • totalResultsnumber

  • pageNonumber

  • pageSizenumber

  • totalPagesnumber

  • sortOrderstring

  • sortBystring

Loading Examples...

Create new custom metric.

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

Request Body

application/json

  • metricNamestring

  • groupNamestring

  • typestring

  • resourceTypestring

  • displayNamestring

  • unitstring

  • displayUnitstring

  • factorinteger

  • unitLabelstring

  • descriptionstring

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • adapterTypestring

Loading Examples...

Responses

200Metric already exists

Loading Examples...

Update a basic metric details by metric name

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

Request Body

application/json

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

Loading Examples...

Responses

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

Loading Examples...