Skip to main content
API Explorer|API Explorer
Platform O&M/Cloud Monitoring/Monitoring and Alarm/SNS/ZWatch Operations/Metric Operations
GETMetric OperationsSince 3.9.0SynchronousAuth Required

GetAllMetricMetadata

GetAllMetricMetadata

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • nameString

    Optional. The name of the metric.

  • namespaceString

    Optional. The namespace of the metric.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The system tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • metricsListRequired

    See metrics.

    • namespaceStringRequired

      The namespace.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The description of the metric.

    • labelNamesListRequired

      The label names.

Endpoint

GET/zstack/v1/zwatch/metrics/meta-data

/zstack/v1/zwatch/metrics/meta-data

Operation ID

GetAllMetricMetadata

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/zwatch/metrics/meta-data?name=<name>&namespace=<namespace>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "metrics": [ { "namespace": "ZStack/VM", "name": "org.zstack.zwatch.datatype.Metric@4efa6b58", "description": "CPUIdleUtilization", "labelNames": [ "VMUuid", "CPUNum" ], "driver": "PrometheusDatabaseDriver" } ] }

Change History

This API has no change history records yet.

View all change history