Scan Resource Service Get

Get a Scan.

Request

URI

GET

https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clusters/{fullName.clusterName}/inspection/scans/{fullName.name}

COPY

Path Parameters

string

fullName.clusterName

Required

Name of Cluster.

string

fullName.name

Required

Name of the inspection scan.

Query Parameters

string

fullName.orgId

Optional

Org ID of the inspection scan.

string

fullName.managementClusterName

Optional

Name of management cluster.

string

fullName.provisionerName

Optional

Name of Provisioner.

Responses

200

A successful response.

Returns vmware.tanzu.manage.v1alpha1.cluster.inspection.scan.GetScanResponse of type(s) */*

{
    "scan": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "clusterName": "string",
            "name": "string"
        },
        "spec": {
            "cisSpec": {
                "cisTargets": [
                    "string"
                ]
            }
        },
        "status": {
            "report": {
                "info": {
                    "reportId": "string",
                    "runDatetime": "string",
                    "scanType": "string",
                    "numInspections": "string",
                    "numFailed": "string",
                    "result": "string",
                    "numWarning": "string",
                    "progressInfo": {
                        "totalNumTests": "string",
                        "numTestsCompleted": "string"
                    },
                    "kubeServerVersion": "string"
                },
                "tarballDownloadUrl": "string"
            },
            "phase": "string",
            "phaseInfo": "string",
            "availablePhases": [
                "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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

Scan Resource Service Operations

POST

Scan Resource Service Create

DELETE