Get Metric Entities

Get Metric Entities

Provides details of the metric type model belonging to one/more domain.

Request
URI
GET
https://{api_host}/tcsa.host.com/v2/catalog/metric-entities
COPY
Query Parameters
integer
offset
Optional

Offset from first result to fetch.

integer
limit
Optional

Maximum number of results per page.

string
sort_by
Optional

Sorting is allowed only on deviceType and entityType fields, eg sort_by=deviceType desc

string
deviceType
Required

Device type to be fetched.

deviceType example 
BladeEnclosureManager
string
entityType
Optional

Entity type to be fetched.

entityType example 
Interface
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MetricEntitiesResponse of type(s) application/json 
{
    "total": 1,
    "page_count": 1,
    "entity": [
        {
            "deviceType": "BladeEnclosureManager",
            "entityType": "Memory",
            "metrics": [
                {
                    "name": "SharedCommon",
                    "description": "Memory shared by virtual machines",
                    "unit": "MB",
                    "mode": "static"
                },
                {
                    "name": "UsedMemory",
                    "description": "Used Memory",
                    "unit": "MB",
                    "mode": "static"
                }
            ],
            "properties": [
                {
                    "name": "entityName",
                    "description": " "
                },
                {
                    "name": "dataSource"
                },
                {
                    "name": "deviceName",
                    "description": " "
                },
                {
                    "name": "entityType",
                    "description": " ",
                    "values": [
                        "Memory"
                    ]
                },
                {
                    "name": "deviceType",
                    "description": " ",
                    "values": [
                        "BladeEnclosureManager"
                    ]
                }
            ],
            "tags": [
                {
                    "name": "zip"
                },
                {
                    "name": "model"
                },
                {
                    "name": "city"
                },
                {
                    "name": "customer"
                },
                {
                    "name": "address",
                    "description": " "
                },
                {
                    "name": "region",
                    "description": " "
                },
                {
                    "name": "deviceCoordinates"
                },
                {
                    "name": "version"
                },
                {
                    "name": "location",
                    "description": " "
                },
                {
                    "name": "hostname",
                    "description": " "
                },
                {
                    "name": "hypervsr",
                    "description": " "
                }
            ],
            "tco_internal": [
                "type",
                "colltimestamp",
                "instance",
                "processedTimestamp"
            ]
        }
    ]
}
integer As int64 As int64
total
Required

Total number of metric entities

integer As int64 As int64
page_count
Required

Total number of pages in response

array of MetricModel
entity
Optional

Describes the deviceType, entityType, metrics, tco internal


400

Invalid Request sent by the user

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


401

User authentication failed

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


403

Access to the requested resource/operation is forbidden

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


404

Cannot find requested resource

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


500

Internal server error

Returns ErrorDetails of type(s) application/json 
{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}
string
errorCode
Required

Error code for the failed request

string
message
Required

Short summary of the error occurred

string
detailedMessage
Optional

Detailed message with probable solution


On This Page
Catalog Operations
GET
Get Metric Entities
GET
Get Metrics Model Metadata