--- title: "Retrieve an AnalysisRun" method: GET path: "/v1beta1/projects/{project}/analysis-runs/{analysis-run}" tags: ["Verifications", "Project-Level"] --- # Retrieve an AnalysisRun `GET /v1beta1/projects/{project}/analysis-runs/{analysis-run}` Retrieve an AnalysisRun resource from a project's namespace. ## Path parameters - `project` string, required - `analysis-run` string, required ## Response `200` AnalysisRun custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisRun) - RolloutsAnalysisRun - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional - `metadata` V1ObjectMeta - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional - `managedFields` V1ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic - `apiVersion` string — APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` unknown - `manager` string — Manager is an identifier of the workflow managing these fields. - `operation` string — Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - `subresource` string — Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - `time` string — Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional - `ownerReferences` V1OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid - `apiVersion` string — API version of the referent. - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional - `controller` boolean — If true, this reference points to the managing controller. +optional - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `uid` string — UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids +optional - `spec` RolloutsAnalysisRunSpec - `args` RolloutsArgument[] - `name` string - `value` string - `valueFrom` RolloutsValueFrom - `fieldRef` RolloutsFieldRef - `fieldPath` string — Required: Path of the field to select in the specified API version - `secretKeyRef` RolloutsSecretKeyRef - `key` string - `name` string - `dryRun` RolloutsDryRun[] - `metricName` string - `measurementRetention` RolloutsMeasurementRetention[] - `limit` integer - `metricName` string - `metrics` RolloutsMetric[] - `consecutiveErrorLimit` unknown - `consecutiveSuccessLimit` unknown - `count` unknown - `failureCondition` string - `failureLimit` unknown - `inconclusiveLimit` unknown - `initialDelay` string - `interval` string - `name` string - `provider` RolloutsMetricProvider - `cloudWatch` RolloutsCloudWatchMetric - `interval` string - `metricDataQueries` RolloutsCloudWatchMetricDataQuery[] - `expression` string - `id` string - `label` string - `metricStat` RolloutsCloudWatchMetricStat - … - `period` unknown - `returnData` boolean - `datadog` RolloutsDatadogMetric - `aggregator` string - `apiVersion` string - `formula` string - `interval` string - `queries` object - `query` string - `secretRef` RolloutsSecretRef - `name` string - `namespaced` boolean - `graphite` RolloutsGraphiteMetric - `address` string - `query` string - `influxdb` RolloutsInfluxdbMetric - `profile` string - `query` string - `job` RolloutsJobMetric - `metadata` V1ObjectMeta - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional - `managedFields` V1ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic - … - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional - `ownerReferences` V1OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid - … - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional - `uid` string — UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids +optional - `spec` V1JobSpec - `activeDeadlineSeconds` integer — Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. +optional - `backoffLimit` integer — Specifies the number of retries before marking this job failed. Defaults to 6, unless backoffLimitPerIndex (only Indexed Job) is specified. When backoffLimitPerIndex is specified, backoffLimit defaults to 2147483647. +optional - `backoffLimitPerIndex` integer — Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. +optional - `completionMode` 'NonIndexed' | 'Indexed' - `completions` integer — Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional - `managedBy` string — ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable. +optional - `manualSelector` boolean — manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector +optional - `maxFailedIndexes` integer — Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. +optional - `parallelism` integer — Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ +optional - `podFailurePolicy` V1PodFailurePolicy - … - `podReplacementPolicy` 'TerminatingOrFailed' | 'Failed' - `selector` V1LabelSelector - … - `successPolicy` V1SuccessPolicy - … - `suspend` boolean — suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. +optional - `template` V1PodTemplateSpec - … - `ttlSecondsAfterFinished` integer — ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. +optional - `kayenta` RolloutsKayentaMetric - `address` string - `application` string - `canaryConfigName` string - `configurationAccountName` string - `lookback` boolean - `metricsAccountName` string - `scopes` RolloutsKayentaScope[] - `controlScope` RolloutsScopeDetail - … - `experimentScope` RolloutsScopeDetail - … - `name` string - `storageAccountName` string - `threshold` RolloutsKayentaThreshold - `marginal` integer - `pass` integer - `newRelic` RolloutsNewRelicMetric - `profile` string - `query` string - `timeout` integer - `plugin` object - `prometheus` RolloutsPrometheusMetric - `address` string - `authentication` RolloutsAuthentication - `oauth2` RolloutsOAuth2Config - … - `sigv4` RolloutsSigv4Config - … - `headers` RolloutsWebMetricHeader[] - `key` string - `value` string - `insecure` boolean - `query` string - `rangeQuery` RolloutsPrometheusRangeQueryArgs - `end` string - `start` string - `step` string - `timeout` integer - `skywalking` RolloutsSkyWalkingMetric - `address` string - `interval` string - `query` string - `wavefront` RolloutsWavefrontMetric - `address` string - `query` string - `web` RolloutsWebMetric - `authentication` RolloutsAuthentication - `oauth2` RolloutsOAuth2Config - … - `sigv4` RolloutsSigv4Config - … - `body` string - `headers` RolloutsWebMetricHeader[] - `key` string - `value` string - `insecure` boolean - `jsonBody` integer[] - `jsonPath` string - `method` string - `timeoutSeconds` integer - `url` string — URL is the address of the web metric - `successCondition` string - `terminate` boolean - `ttlStrategy` RolloutsTTLStrategy - `secondsAfterCompletion` integer - `secondsAfterFailure` integer - `secondsAfterSuccess` integer - `status` RolloutsAnalysisRunStatus - `completedAt` string - `dryRunSummary` RolloutsRunSummary - `count` integer - `error` integer - `failed` integer - `inconclusive` integer - `successful` integer - `message` string - `metricResults` RolloutsMetricResult[] - `consecutiveError` integer - `consecutiveSuccess` integer - `count` integer - `dryRun` boolean - `error` integer - `failed` integer - `inconclusive` integer - `measurements` RolloutsMeasurement[] - `finishedAt` string - `message` string - `metadata` object - `phase` string - `resumeAt` string - `startedAt` string - `value` string - `message` string - `metadata` object - `name` string - `phase` string - `successful` integer - `phase` string - `runSummary` RolloutsRunSummary - `count` integer - `error` integer - `failed` integer - `inconclusive` integer - `successful` integer - `startedAt` string --- [API](https://skmtc.net/akuity/apis/kargo-api.md) · [All operations](https://skmtc.net/akuity/apis/kargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akuity/kargo-api/revisions/c53f80933e09/schema)