Skip to main content
API docs by Redocly

public/portworx/pds/dataservicedeployment/apiv1/dataservicedeployment.proto (version not set)

Download OpenAPI specification:Download

DataServiceDeploymentService

GetDataServiceDeployment API returns the DataService Deployment resource.

path Parameters
id
required
string

UID of the DataService Deployment.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

DeleteDataServiceDeployment API deletes the DataService Deployment resource.

path Parameters
id
required
string

UID of the DataService Deployment.

query Parameters
force
boolean

Force flag to delete backup configuration from control plane only.

Responses

Response samples

Content type
application/json
{ }

GetDataServiceDeploymentCredentials API returns the Credentials to be used to access the DataService Deployment.

path Parameters
id
required
string

UID of the DataService Deployment.

Responses

Response samples

Content type
application/json
{
  • "secret": "string"
}

GetKeyPerformanceIndicator API return the analytics of the DataService Deployment resources.

Request Body schema: application/json
required

Request to list the data service deployment resources.

tenantId
required
string

tenant ID for which data service deployments need to be fetched.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1ResourceSelector)

ResourceSelector is used to query resources using the associated infra resources.

object (v1Sort)

The details of the attribute for which the requested list of resource to be sorted.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

object (v1PDSApplicationSelector)

PDSApplicationSelector is used to query deployments using the associated application reesources.

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "labelSelector": {
    },
  • "fieldSelector": {
    },
  • "infraResourceSelector": {
    },
  • "sort": {
    },
  • "pagination": {
    },
  • "applicationSelector": {
    }
}

Response samples

Content type
application/json
{
  • "dataServiceDeploymentAvailableCount": 0,
  • "dataServiceDeploymentPartiallyAvailableCount": 0,
  • "dataServiceDeploymentUnavailableCount": 0,
  • "dataServiceDeploymentUnknownCount": 0,
  • "dataServiceDeploymentNotApplicableCount": 0,
  • "runningInstances": 0,
  • "notRunningInstances": 0
}

ListDataServiceDeployments API lists the DataService Deployment resources.

Request Body schema: application/json
required

Request to list the data service deployment resources.

tenantId
required
string

tenant ID for which data service deployments need to be fetched.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1ResourceSelector)

ResourceSelector is used to query resources using the associated infra resources.

object (v1Sort)

The details of the attribute for which the requested list of resource to be sorted.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

object (v1PDSApplicationSelector)

PDSApplicationSelector is used to query deployments using the associated application reesources.

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "labelSelector": {
    },
  • "fieldSelector": {
    },
  • "infraResourceSelector": {
    },
  • "sort": {
    },
  • "pagination": {
    },
  • "applicationSelector": {
    }
}

Response samples

Content type
application/json
{
  • "dataServiceDeployments": [
    ],
  • "pagination": {
    }
}

CreateDataServiceDeployment API creates the Deployment resource.

path Parameters
namespaceId
required
string

UID of the namespace resource where this DataService deployment will be created.

Request Body schema: application/json
required
projectId
string

UID of the project.

object (v1DataServiceDeployment)

Resource representing a DataService Deployment.

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "dataServiceDeployment": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

CreateDataServiceDeploymentWithScheduledBackup API creates both Deployment and backup configuration resources.

path Parameters
namespaceId
required
string

UID of the namespace resource where this DataService deployment will be created.

Request Body schema: application/json
required
projectId
required
string

UID of the project.

object (pdsbackupconfigv1Config)

Desired config of the backup configuration.

object (v1DataServiceDeployment)

Resource representing a DataService Deployment.

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "backupConfig": {
    },
  • "dataServiceDeployment": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}