Insight Resource Service List

Insight Resource Service List

List Insights.

Request
URI
GET
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clustergroups/{searchScope.clusterGroupName}/insights
COPY
Query Parameters
string
searchScope.name
Optional

Scope search to the specified name; supports globbing; default (*).

string
searchScope.sourceResourceKind
Optional

Filter by the kind of source resource (eg. integration, gitrepository, helm, policy-settings); supports globbing; default (*).

string
searchScope.sourceResourceUid
Optional

Filter by the uid of source resource; supports globbing; default (*).

string
searchScope.insightType
Optional

Filter by type of insight (ERROR / OVERRIDE); supports globbing; default (*).

string
searchScope.sourceScopeType
Optional

Filter by source scope type (org / cg / c); supports globbing; default (*).

string
searchScope.clusterName
Optional

Filter by cluster name; supports globbing; default (*).

string
sortBy
Optional

Sort Order.

string
query
Optional

TQL query string.

string
pagination.offset
Optional

Offset at which to start returning records.

string
pagination.size
Optional

Number of records to return.

boolean
includeTotalCount
Optional

Include total count.


Responses
200

A successful response.

{
    "insights": [
        {
            "type": {
                "kind": "string",
                "version": "string",
                "package": "string"
            },
            "fullName": {
                "orgId": "string",
                "name": "string"
            },
            "meta": {
                "uid": "string",
                "generation": "string",
                "resourceVersion": "string",
                "creationTime": "string",
                "updateTime": "string",
                "description": "string",
                "parentReferences": [
                    {
                        "rid": "string",
                        "uid": "string"
                    }
                ]
            },
            "data": {
                "type": "string",
                "details": "string",
                "sourceResourceKind": "string",
                "sourceResource": {
                    "rid": "string",
                    "uid": "string"
                },
                "sourceScopeType": "string",
                "sourceScope": {
                    "rid": "string",
                    "uid": "string"
                },
                "cluster": {
                    "rid": "string",
                    "uid": "string"
                }
            }
        }
    ],
    "totalCount": "string"
}

default

An unexpected error response.

Returns grpc.gateway.runtime.Error of type(s) */*
{
    "error": "string",
    "code": 0,
    "message": "string",
    "details": [
        {
            "typeUrl": "string",
            "value": "string"
        }
    ]
}