Snapshot Location Resource Service List

List SnapshotLocations.

Request

URI

GET

https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clusters/{searchScope.clusterName}/dataprotection/snapshotlocations

COPY

Path Parameters

string

searchScope.clusterName

Required

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

Query Parameters

string

searchScope.managementClusterName

Optional

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

string

searchScope.provisionerName

Optional

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

string

searchScope.name

Optional

Scope search to the specified 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.

Returns vmware.tanzu.manage.v1alpha1.cluster.dataprotection.snapshotlocation.ListSnapshotLocationsResponse of type(s) */*

{
    "snapshotLocations": [
        {
            "type": {
                "kind": "string",
                "version": "string",
                "package": "string"
            },
            "fullName": {
                "orgId": "string",
                "managementClusterName": "string",
                "provisionerName": "string",
                "clusterName": "string",
                "name": "string"
            },
            "meta": {
                "uid": "string",
                "generation": "string",
                "resourceVersion": "string",
                "creationTime": "string",
                "updateTime": "string",
                "description": "string",
                "parentReferences": [
                    {
                        "rid": "string",
                        "uid": "string"
                    }
                ]
            },
            "spec": {
                "volumeProvider": "string",
                "config": {
                    "awsConfig": {
                        "region": "string"
                    },
                    "azureConfig": {
                        "apiTimeout": "string",
                        "resourceGroup": "string",
                        "subscriptionId": "string"
                    }
                },
                "credentialName": "string"
            },
            "status": {
                "observedGeneration": "string",
                "phase": "string",
                "phaseInfo": "string",
                "availablePhases": [
                    "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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

Snapshot Location Resource Service Operations

GET

Snapshot Location Resource Service Get

GET

Snapshot Location Resource Service List