Jump to

• Request
• Response

List Environment Group Metrics

get

/rpa/v1/environmentGroups/metrics

Gets a list of all available environment groups metrics in a service instance.

Request

Query Parameters

• environmentGroupId: string
  Environment Group Identifier
• limit: integer
  Minimum Value: 1

  Maximum Value: 100

  The maximum number of items to return.

  Default Value: 100
• page: string
  Minimum Length: 1

  A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
• period: string
  time period from the current time for which metrics to be queried.

  Default Value: HOUR_1

  Allowed Values: [ "HOUR_1", "HOUR_6", "HOUR_12", "HOUR_24" ]
• projectId(required): string
  Project identifier
• sortBy: string
  The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

  Default Value: TIME_CREATED

  Allowed Values: [ "TIME_CREATED", "DISPLAY_NAME" ]
• sortOrder: string
  The sort order to use, either 'ASC' or 'DESC'.

  Allowed Values: [ "ASC", "DESC" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of Environment Group Summary objects.

Headers

• opc-next-page:
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : EnvironmentGroupMetricsCollection

Type: object

Results of a environmentGroup list metrics operation. Contains EnvironmentGroupMetricSummary items.

Show Source

• items(required): array items
  List of EnvironmentGroupMetricSummary objects

{
    "type":"object",
    "description":"Results of a environmentGroup list metrics operation. Contains EnvironmentGroupMetricSummary items.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of EnvironmentGroupMetricSummary objects",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnvironmentGroupMetricSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of EnvironmentGroupMetricSummary objects

Show Source

• Array of: object EnvironmentGroupMetricSummary
  Summary of an environment group utilization metrics

{
    "description":"List of EnvironmentGroupMetricSummary objects",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnvironmentGroupMetricSummary"
    }
}

Nested Schema : EnvironmentGroupMetricSummary

Type: object

Summary of an environment group utilization metrics

Show Source

• dataPoints: array dataPoints
  T2 metrics DataPoints for Utilization.
• displayName(required): string
  Maximum Length: 50

  User friendly display name for the environment group
• identifier(required): string
  Maximum Length: 32

  Envrinoment Group identifier
• projectId(required): string
  Minimum Length: 1

  Maximum Length: 32

  Envrinoment Group project id

{
    "description":"Summary of an environment group utilization metrics",
    "type":"object",
    "required":[
        "projectId",
        "identifier",
        "displayName"
    ],
    "properties":{
        "projectId":{
            "description":"Envrinoment Group project id",
            "type":"string",
            "minLength":1,
            "maxLength":32
        },
        "identifier":{
            "description":"Envrinoment Group identifier",
            "type":"string",
            "maxLength":32
        },
        "displayName":{
            "description":"User friendly display name for the environment group",
            "type":"string",
            "maxLength":50
        },
        "dataPoints":{
            "description":"T2 metrics DataPoints for Utilization.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnvironmentGroupMetricDataPoints"
            }
        }
    }
}

Nested Schema : dataPoints

Type: array

T2 metrics DataPoints for Utilization.

Show Source

• Array of: object EnvironmentGroupMetricDataPoints
  EnvironmentGroupMetricDataPoints items.

{
    "description":"T2 metrics DataPoints for Utilization.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnvironmentGroupMetricDataPoints"
    }
}

Nested Schema : EnvironmentGroupMetricDataPoints

Type: object

EnvironmentGroupMetricDataPoints items.

Show Source

• timestamp(required): string (date-time)
  timestamp
• value(required): integer (int64)
  utilization percentage value

{
    "type":"object",
    "description":"EnvironmentGroupMetricDataPoints items.",
    "required":[
        "timestamp",
        "value"
    ],
    "properties":{
        "timestamp":{
            "description":"timestamp",
            "type":"string",
            "format":"date-time"
        },
        "value":{
            "description":"utilization percentage value",
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Bad Request

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Back to Top