Backup Location Resource Service List

List BackupLocations.

Request

URI

GET

https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/dataprotection/providers/{searchScope.providerName}/backuplocations

COPY

Path Parameters

string

searchScope.providerName

Required

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

Query Parameters

string

searchScope.name

Optional

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

string

searchScope.credentialName

Optional

Filter backup locations by a credential name; supports globbing; default (*).

string

searchScope.assignedGroupName

Optional

Filter backup locations by an assigned group 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.dataprotection.provider.backuplocation.ListBackupLocationsResponse of type(s) */*

{
    "backupLocations": [
        {
            "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",
                "providerName": "string",
                "name": "string"
            },
            "spec": {
                "targetProvider": "string",
                "config": {
                    "s3Config": {
                        "s3ForcePathStyle": false,
                        "s3Url": "string",
                        "publicUrl": "string"
                    },
                    "azureConfig": {
                        "resourceGroup": "string",
                        "storageAccount": "string",
                        "subscriptionId": "string"
                    }
                },
                "bucket": "string",
                "region": "string",
                "credential": {
                    "orgId": "string",
                    "name": "string"
                },
                "assignedGroups": [
                    {
                        "clustergroup": {
                            "orgId": "string",
                            "name": "string"
                        },
                        "cluster": {
                            "orgId": "string",
                            "managementClusterName": "string",
                            "provisionerName": "string",
                            "name": "string"
                        }
                    }
                ],
                "caCert": "string"
            },
            "status": {
                "observedGeneration": "string",
                "phase": "string",
                "phaseInfo": "string",
                "availablePhases": [
                    "string"
                ],
                "type": "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

Backup Location Resource Service Operations

POST

Backup Location Resource Service Create

DELETE