Jump to

• Request
• Response

Get configuration metric groups for the target

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/configMetricGroups

Lists the configuration metric groups available for the specified target.

Request

Path Parameters

• targetId(required): string
  the target id

Query Parameters

• containerSnapshotId: string
  Container snapshot identifier (optional).
• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 2000

  to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.

  Example:

  20

• page: string
  system generated page token used in the self, next and previous links.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TargetConfigMetricGroupCollection

Type: object

Paged list of configuration metric groups available for a target.

Show Source

• count(required): integer
  Number of items returned in this response.
• items(required): array items
  Configuration metric group summaries.
• links(required): object links
  Result set navigation links.
• total: integer
  Total number of metric groups available.

{
    "x-em-sdk-level":"emSDK",
    "description":"Paged list of configuration metric groups available for a target.",
    "type":"object",
    "required":[
        "links",
        "count",
        "items"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        },
        "count":{
            "type":"integer",
            "description":"Number of items returned in this response."
        },
        "total":{
            "type":"integer",
            "description":"Total number of metric groups available."
        },
        "items":{
            "type":"array",
            "description":"Configuration metric group summaries.",
            "items":{
                "$ref":"#/components/schemas/ConfigMetricSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Configuration metric group summaries.

Show Source

• Array of: object ConfigMetricSummary
  Summary of a configuration metric group.

{
    "type":"array",
    "description":"Configuration metric group summaries.",
    "items":{
        "$ref":"#/components/schemas/ConfigMetricSummary"
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

• next: next
• previous: previous
• self(required): self

{
    "type":"object",
    "description":"Result set navigation links.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : ConfigMetricSummary

Type: object

Summary of a configuration metric group.

Show Source

• configExtension: boolean
  Indicates whether the metric group is a configuration extension.

  Example: true
• displayName: string
  Configuration metric group display name.

  Example: DisplayName
• links: object links
  Result set navigation links.
• name: string
  Configuration metric group name.

  Example: ConfigMetricName

{
    "x-em-sdk-level":"emSDK",
    "description":"Summary of a configuration metric group.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Configuration metric group name.",
            "example":"ConfigMetricName"
        },
        "displayName":{
            "type":"string",
            "description":"Configuration metric group display name.",
            "example":"DisplayName"
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        },
        "configExtension":{
            "type":"boolean",
            "description":"Indicates whether the metric group is a configuration extension.",
            "example":true
        }
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

• next: next
• previous: previous
• self(required): self

{
    "type":"object",
    "description":"Result set navigation links.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : next

Match All

Link to the next page in the result set.

Show Source

• object Link
  A link
• Link to the next page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Link to the previous page in the result set.

Show Source

• object Link
  A link
• Link to the previous page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Link to the current page in the result set.

Show Source

• object Link
  A link
• Link to the current page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups/METRICNAME?ISCONFIGEXTENSION&page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : Link

Type: object

A link

Show Source

• href(required): string
  URL for link

{
    "description":"A link",
    "type":"object",
    "required":[
        "href"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link"
        }
    }
}

Nested Schema : next

Match All

Link to the next page in the result set.

Show Source

• object Link
  A link
• Link to the next page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Link to the previous page in the result set.

Show Source

• object Link
  A link
• Link to the previous page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Link to the current page in the result set.

Show Source

• object Link
  A link
• Link to the current page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/configMetricGroups?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/configMetricGroups?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top