思维导图备注

apiListExperimentsResponse


page_token	A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListExperiment call or can be omitted when fetching the first page.	query	string
page_size	The number of experiments to be listed per page. If there are more experiments than this number, the response message will contain a nextPageToken field you can use to fetch the next page.	query	integer (int32)
sort_by	Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.	query	string
filter	A url-encoded, JSON-serialized Filter protocol buffer (see filter.proto).	query	string
resource_reference_key.type	The type of the resource that referred to.	query	string , x ∈ { UNKNOWN_RESOURCE_TYPE (default) , EXPERIMENT , JOB , PIPELINE , PIPELINE_VERSION , NAMESPACE }
resource_reference_key.id	The ID of the resource that referred to.	query	string

Uses default content-types: application/json

200 OK

A successful response.

default

Creates a new experiment.

POST /apis/v1beta1/experiments

Uses default content-types: application/json

The experiment to be created.

Uses default content-types: application/json

200 OK

A successful response.

default

Deletes an experiment without deleting the experiment’s runs and jobs. To avoid unexpected behaviors, delete an experiment’s runs and jobs before deleting the experiment.

DELETE /apis/v1beta1/experiments/{id}


id	The ID of the experiment to be deleted.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Finds a specific experiment by ID.

GET /apis/v1beta1/experiments/{id}


id	The ID of the experiment to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Archives an experiment and the experiment’s runs and jobs.

POST /apis/v1beta1/experiments/{id}:archive


id	The ID of the experiment to be archived.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Restores an archived experiment. The experiment’s archived runs and jobs will stay archived.

POST /apis/v1beta1/experiments/{id}:unarchive


id	The ID of the experiment to be restored.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Finds all jobs.

GET /apis/v1beta1/jobs

Tags: JobService


page_token	A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListJobs call or can be omitted when fetching the first page.	query	string
page_size	The number of jobs to be listed per page. If there are more jobs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.	query	integer (int32)
sort_by	Can be format of “field_name”, “field_name asc” or “field_name desc”. Ascending by default.	query	string
resource_reference_key.type	The type of the resource that referred to.	query	string , x ∈ { UNKNOWN_RESOURCE_TYPE (default) , EXPERIMENT , JOB , PIPELINE , PIPELINE_VERSION , NAMESPACE }
resource_reference_key.id	The ID of the resource that referred to.	query	string
filter	A url-encoded, JSON-serialized Filter protocol buffer (see filter.proto).	query	string

Uses default content-types: application/json

200 OK

A successful response.

apiListJobsResponse

default

Creates a new job.

POST /apis/v1beta1/jobs

Tags: JobService

Uses default content-types: application/json

The job to be created

Uses default content-types: application/json

200 OK

A successful response.

default

Deletes a job.

DELETE /apis/v1beta1/jobs/{id}

Tags: JobService


id	The ID of the job to be deleted	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Finds a specific job by ID.

GET /apis/v1beta1/jobs/{id}

Tags: JobService


id	The ID of the job to be retrieved	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Stops a job and all its associated runs. The job is not deleted.

POST /apis/v1beta1/jobs/{id}/disable

Tags: JobService


id	The ID of the job to be disabled	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Restarts a job that was previously stopped. All runs associated with the job will continue.

POST /apis/v1beta1/jobs/{id}/enable

Tags: JobService


id	The ID of the job to be enabled	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Lists all pipeline versions of a given pipeline.

GET /apis/v1beta1/pipeline_versions

apiListPipelineVersionsResponse


resource_key.type	The type of the resource that referred to.	query	string , x ∈ { UNKNOWN_RESOURCE_TYPE (default) , EXPERIMENT , JOB , PIPELINE , PIPELINE_VERSION , NAMESPACE }
resource_key.id	The ID of the resource that referred to.	query	string
page_size	The number of pipeline versions to be listed per page. If there are more pipeline versions than this number, the response message will contain a nextPageToken field you can use to fetch the next page.	query	integer (int32)
page_token	A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelineVersions call or can be omitted when fetching the first page.	query	string
sort_by	Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.	query	string
filter	A base-64 encoded, JSON-serialized Filter protocol buffer (see filter.proto).	query	string

Uses default content-types: application/json

200 OK

A successful response.

default

Adds a pipeline version to the specified pipeline.

POST /apis/v1beta1/pipeline_versions

Uses default content-types: application/json

ResourceReference inside PipelineVersion specifies the pipeline that this version belongs to.

Uses default content-types: application/json

200 OK

A successful response.

default

Deletes a pipeline version by pipeline version ID. If the deleted pipeline version is the default pipeline version, the pipeline’s default version changes to the pipeline’s most recent pipeline version. If there are no remaining pipeline versions, the pipeline will have no default version. Examines the run_service_api.ipynb notebook to learn more about creating a run using a pipeline version (https://github.com/kubeflow/pipelines/blob/master/tools/benchmarks/run_service_api.ipynb).

DELETE /apis/v1beta1/pipeline_versions/{version_id}


version_id	The ID of the pipeline version to be deleted.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Gets a pipeline version by pipeline version ID.

GET /apis/v1beta1/pipeline_versions/{version_id}


version_id	The ID of the pipeline version to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Returns a YAML template that contains the specified pipeline version’s description, parameters and metadata.

GET /apis/v1beta1/pipeline_versions/{version_id}/templates


version_id	The ID of the pipeline version whose template is to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

apiGetTemplateResponse

default

Finds all pipelines.

GET /apis/v1beta1/pipelines


page_token	A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListPipelines call.	query	string
page_size	The number of pipelines to be listed per page. If there are more pipelines than this number, the response message will contain a valid value in the nextPageToken field.	query	integer (int32)
sort_by	Can be format of “field_name”, “field_name asc” or “field_name desc” Ascending by default.	query	string
filter	A url-encoded, JSON-serialized Filter protocol buffer (see filter.proto).	query	string

Uses default content-types: application/json

200 OK

A successful response.

apiListPipelinesResponse

default

Creates a pipeline.

POST /apis/v1beta1/pipelines

Uses default content-types: application/json

Uses default content-types: application/json

200 OK

A successful response.

default

POST /apis/v1beta1/pipelines/upload

Tags: PipelineUploadService

multipart/form-data


uploadfile	The pipeline to upload. Maximum size of 32MB is supported.	formData	file
name		query	string
description		query	string

application/json

200 OK

default

POST /apis/v1beta1/pipelines/upload_version

Tags: PipelineUploadService

multipart/form-data


uploadfile	The pipeline to upload. Maximum size of 32MB is supported.	formData	file
name		query	string
pipelineid		query	string

application/json

200 OK

default

Deletes a pipeline and its pipeline versions.

DELETE /apis/v1beta1/pipelines/{id}


id	The ID of the pipeline to be deleted.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Finds a specific pipeline by ID.

GET /apis/v1beta1/pipelines/{id}


id	The ID of the pipeline to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Returns a single YAML template that contains the description, parameters, and metadata associated with the pipeline provided.

GET /apis/v1beta1/pipelines/{id}/templates


id	The ID of the pipeline whose template is to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

apiGetTemplateResponse

default

Finds all runs.

GET /apis/v1beta1/runs

Tags: RunService


page_token	A page token to request the next page of results. The token is acquried from the nextPageToken field of the response from the previous ListRuns call or can be omitted when fetching the first page.	query	string
page_size	The number of runs to be listed per page. If there are more runs than this number, the response message will contain a nextPageToken field you can use to fetch the next page.	query	integer (int32)
sort_by	Can be format of “field_name”, “field_name asc” or “field_name desc” (Example, “name asc” or “id desc”). Ascending by default.	query	string
resource_reference_key.type	The type of the resource that referred to.	query	string , x ∈ { UNKNOWN_RESOURCE_TYPE (default) , EXPERIMENT , JOB , PIPELINE , PIPELINE_VERSION , NAMESPACE }
resource_reference_key.id	The ID of the resource that referred to.	query	string
filter	A url-encoded, JSON-serialized Filter protocol buffer (see filter.proto).	query	string

Uses default content-types: application/json

200 OK

A successful response.

apiListRunsResponse

default

Creates a new run.

POST /apis/v1beta1/runs

Tags: RunService

Uses default content-types: application/json

apiRun

Uses default content-types: application/json

200 OK

A successful response.

apiRunDetail

default

Deletes a run.

DELETE /apis/v1beta1/runs/{id}

Tags: RunService


id	The ID of the run to be deleted.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Archives a run.

POST /apis/v1beta1/runs/{id}:archive

Tags: RunService


id	The ID of the run to be archived.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Restores an archived run.

POST /apis/v1beta1/runs/{id}:unarchive

Tags: RunService


id	The ID of the run to be restored.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Finds a specific run by ID.

GET /apis/v1beta1/runs/{run_id}

Tags: RunService


run_id	The ID of the run to be retrieved.	path	string

Uses default content-types: application/json

200 OK

A successful response.

apiRunDetail

default

Finds a run’s artifact data.

GET /apis/v1beta1/runs/{run_id}/nodes/{node_id}/artifacts/{artifact_name}:read

Tags: RunService


run_id	The ID of the run.	path	string
node_id	The ID of the running node.	path	string
artifact_name	The name of the artifact.	path	string

Uses default content-types: application/json

200 OK

A successful response.

apiReadArtifactResponse

default

Re-initiates a failed or terminated run.

POST /apis/v1beta1/runs/{run_id}/retry

Tags: RunService


run_id	The ID of the run to be retried.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

Terminates an active run.

POST /apis/v1beta1/runs/{run_id}/terminate

Tags: RunService


run_id	The ID of the run to be terminated.	path	string

Uses default content-types: application/json

200 OK

A successful response.

default

apiReportRunMetricsRequest

ReportRunMetrics reports metrics of a run. Each metric is reported in its own transaction, so this API accepts partial failures. Metric can be uniquely identified by (run_id, node_id, name). Duplicate reporting will be ignored by the API. First reporting wins.

POST /apis/v1beta1/runs/{run_id}:reportMetrics

Tags: RunService

Uses default content-types: application/json


run_id	Required. The parent run ID of the metric.	path	string

Uses default content-types: application/json

200 OK

A successful response.

apiReportRunMetricsResponse

default

Schema definitions

apiCronSchedule: object

start_time: string (date-time)

end_time: string (date-time)

cron: string

apiExperiment: object

id: string

Output. Unique experiment ID. Generated by API server.

Required input field. Unique experiment name provided by user.

description: string

created_at: string (date-time)

Output. The time that the experiment created.

resource_references: object[]

Optional input field. Specify which resource this run belongs to. For Experiment, the only valid resource reference is a single Namespace.

storage_state: ExperimentStorageState

Output. Specifies whether this experiment is in archived or available state.

apiGetTemplateResponse: object

The template of the pipeline specified in a GetTemplate request, or of a pipeline version specified in a GetPipelinesVersionTemplate request.

apiJob: object

id: string

Output. Unique run ID. Generated by API server.

Required input field. Job name provided by user. Not unique.

description: string

pipeline_spec: apiPipelineSpec

Required input field. Describing what the pipeline manifest and parameters to use for the scheduled job.

resource_references: object[]

Optional input field. Specify which resource this job belongs to.

service_account: string

Optional input field. Specify which Kubernetes service account this job uses.

max_concurrency: string (int64)

trigger: apiTrigger

Required input field. Specify how a run is triggered. Support cron mode or periodic mode.

mode: JobMode

created_at: string (date-time)

Output. The time this job is created.

updated_at: string (date-time)

Output. The last time this job is updated.

status: string

error: string

In case any error happens retrieving a job field, only job ID and the error message is returned. Client has the flexibility of choosing how to handle error. This is especially useful during listing call.

enabled: boolean (boolean)

Input. Whether the job is enabled or not.

no_catchup: boolean (boolean)

Optional input field. Whether the job should catch up if behind schedule. If true, the job will only schedule the latest interval if behind schedule. If false, the job will catch up on each past interval.

apiListExperimentsResponse: object

experiments: object[]

A list of experiments returned.

total_size: integer (int32)

The total number of experiments for the given query.

next_page_token: string

The token to list the next page of experiments.

apiListJobsResponse: object

jobs: object[]

A list of jobs returned.

total_size: integer (int32)

The total number of jobs for the given query.

next_page_token: string

The token to list the next page of jobs.

apiListPipelinesResponse: object

pipelines: object[]

total_size: integer (int32)

The total number of pipelines for the given query.

next_page_token: string

The token to list the next page of pipelines.

apiListPipelineVersionsResponse: object

versions: object[]

next_page_token: string

The token to list the next page of pipeline versions.

total_size: integer (int32)

The total number of pipeline versions for the given query.

apiListRunsResponse: object

runs: object[]

apiRun

total_size: integer (int32)

The total number of runs for the given query.

next_page_token: string

The token to list the next page of runs.

apiParameter: object

value: string

apiPeriodicSchedule: object

start_time: string (date-time)

end_time: string (date-time)

interval_second: string (int64)

apiPipeline: object

id: string

Output. Unique pipeline ID. Generated by API server.

created_at: string (date-time)

Output. The time this pipeline is created.

Optional input field. Pipeline name provided by user. If not specified, file name is used as pipeline name.

description: string

Optional input field. Describing the purpose of the job.

parameters: object[]

Output. The input parameters for this pipeline. TODO(jingzhang36): replace this parameters field with the parameters field inside PipelineVersion when all usage of the former has been changed to use the latter.

apiParameter

url: apiUrl

The URL to the source of the pipeline. This is required when creating the pipeine through CreatePipeline API. TODO(jingzhang36): replace this url field with the code_source_urls field inside PipelineVersion when all usage of the former has been changed to use the latter.

error: string

In case any error happens retrieving a pipeline field, only pipeline ID and the error message is returned. Client has the flexibility of choosing how to handle error. This is especially useful during listing call.

default_version: apiPipelineVersion

apiPipelineRuntime: object

pipeline_manifest: string

Output. The runtime JSON manifest of the pipeline, including the status of pipeline steps and fields need for UI visualization etc.

workflow_manifest: string

Output. The runtime JSON manifest of the argo workflow. This is deprecated after pipeline_runtime_manifest is in use.

apiPipelineSpec: object

pipeline_id: string

Optional input field. The ID of the pipeline user uploaded before.

pipeline_name: string

Optional output field. The name of the pipeline. Not empty if the pipeline id is not empty.

workflow_manifest: string

Optional input field. The marshalled raw argo JSON workflow. This will be deprecated when pipeline_manifest is in use.

pipeline_manifest: string

Optional input field. The raw pipeline JSON spec.

parameters: object[]

The parameter user provide to inject to the pipeline JSON. If a default value of a parameter exist in the JSON, the value user provided here will replace.

apiParameter

apiPipelineVersion: object

id: string

Output. Unique version ID. Generated by API server.

Optional input field. Version name provided by user.

created_at: string (date-time)

Output. The time this pipeline version is created.

parameters: object[]

Output. The input parameters for this pipeline.

apiParameter

code_source_url: string

Input. Optional. Pipeline version code source.

package_url: apiUrl

Input. Required. Pipeline version package url. Whe calling CreatePipelineVersion API method, need to provide one package file location.

resource_references: object[]

Input. Required. E.g., specify which pipeline this pipeline version belongs to.

ReportRunMetricsResponseReportRunMetricResult

apiReadArtifactResponse: object

data: string (byte)

The bytes of the artifact content.

apiRelationship: string , x ∈ { UNKNOWN_RELATIONSHIP (default) , OWNER , CREATOR }

apiReportRunMetricsRequest: object

run_id: string

Required. The parent run ID of the metric.

metrics: object[]

List of metrics to report.

apiRunMetric

apiReportRunMetricsResponse: object

results: object[]

apiResourceKey: object

type: apiResourceType

The type of the resource that referred to.

id: string

The ID of the resource that referred to.

apiResourceReference: object

key: apiResourceKey

The name of the resource that referred to.

relationship: apiRelationship

Required field. The relationship from referred resource to the object.

apiResourceType: string , x ∈ { UNKNOWN_RESOURCE_TYPE (default) , EXPERIMENT , JOB , PIPELINE , PIPELINE_VERSION , NAMESPACE }

apiRun: object

id: string

Output. Unique run ID. Generated by API server.

Required input field. Name provided by user, or auto generated if run is created by scheduled job. Not unique.

storage_state: RunStorageState

Output. Specify whether this run is in archived or available mode.

description: string

pipeline_spec: apiPipelineSpec

Required input field. Describing what the pipeline manifest and parameters to use for the run.

resource_references: object[]

Optional input field. Specify which resource this run belongs to. When creating a run from a particular pipeline version, the pipeline version can be specified here.