Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

DataServiceDeploymentConfigUpdateService

ListDataServiceDeploymentConfigUpdates API returns a list of data service deployment config updates.

query Parameters
dataServiceDeploymentId
string

UID of the DataService Deployment.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

Responses

Response samples

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

GetDataServiceDeploymentConfigUpdate API returns a DataService deployment config update by id.

path Parameters
id
required
string

UID of the DataService deployment config update.

Responses

Response samples

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

RetryDataServiceDeploymentConfigUpdate API retries a data service deployment config update.

path Parameters
id
required
string

UID of the DataService deployment config update.

Request Body schema: application/json
required
object (DataServiceDeploymentConfigUpdateServiceRetryDataServiceDeploymentConfigUpdateBody)

RetryDataServiceDeploymentConfigUpdateRequest is the request for RetryDataServiceDeploymentConfigUpdate.

Responses

Request samples

Content type
application/json
{ }

Response samples

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

CreateDataServiceDeploymentConfigUpdate API creates config update for deployment.

path Parameters
dataServiceDeploymentConfigUpdate.config.dataServiceDeploymentMeta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

DataServiceDeploymentConfigUpdate of the DataService config deployment update request.

object (v1Meta)

Meta holds general resource metadata.

object (Config of the DataService deployment for which config update is requested.)

Config of the DataService deployment for which config update is requested.

object (pdsdataservicedeploymentconfigupdatev1Status)

Status of the DataService deployment config update.

Responses

Request samples

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

Response samples

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