List application assets for an application snapshot

10/21/2024 Contributors

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/appSnaps/{appSnap_id}/appAssets

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name	Type	In	Required	Description
account_id	string	path	True	ID of the containing account resource example: {{.Account}}
app_id	string	path	True	ID of the containing app resource
appSnap_id	string	path	True	ID of the containing appSnap resource
include	string	query	False	Indicates which fields should be returned when listing a collection. URL examples: "include=id", "include=id,name" OpenAPI examples: "id" example: assetType,assetName
limit	string	query	False	Indicates the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2"

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

app_id

string

path

True

ID of the containing app resource

appSnap_id

string

path

True

ID of the containing appSnap resource

include

string

query

False

Indicates which fields should be returned when listing a collection.

URL examples: "include=id", "include=id,name"

OpenAPI examples: "id"

example: assetType,assetName

limit

string

query

False

Indicates the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Name	Type	Required	Description
items	array[Any of: appAsset_1.1_get_response_body, array[]]	True
metadata	type_astra_metadata_list	True

Name

Type

Required

Description

items

array[Any of: appAsset_1.1_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True

Example response

{
  "type": "application/astra-appAssets",
  "version": "1.1",
  "items": [
    [
      "Pod",
      "mediawiki-69c6fcf864-2wx6l"
    ],
    [
      "ReplicaSet",
      "mediawiki-69c6fcf864"
    ],
    [
      "Service",
      "mediawiki"
    ],
    [
      "Deployment",
      "mediawiki"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found

Name	Type	Required
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

Example error response

{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

GVK

JSON object containing a Kubernetes group/version/kind.

Name	Type	Required	Description
group	string	False	JSON string containing a group identifier assigned by Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254
kind	string	False	JSON string containing a kind identifier assigned by Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254
version	string	False	JSON string containing a version identifier assigned by Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254

Name

Type

Required

Description

group

string

False

JSON string containing a group identifier assigned by Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

kind

string

False

JSON string containing a kind identifier assigned by Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

version

string

False

JSON string containing a version identifier assigned by Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

type_json

JSON object containing the entire content of the Kubernetes resource definition.

labels

Name	Type	Required	Description
name	string	True	JSON string containing the label name Defined values are: Minimum length: 1 Maximum length: 63 Defined regex is: "^([\S.]{1,253}\/)?([a-z0-9A-Z_.-]){1,63}$"
value	string	True	JSON string containing the label value Defined values are: Minimum length: 1 Maximum length: 63 Defined regex is: "^([a-z0-9A-Z_.-]){1,63}$"

Name

Type

Required

Description

name

string

True

JSON string containing the label name Defined values are:

Minimum length: 1
Maximum length: 63
Defined regex is: "^([\S.]{1,253}\/)?([a-z0-9A-Z_.-]){1,63}$"

value

string

True

JSON string containing the label value Defined values are:

Minimum length: 1
Maximum length: 63
Defined regex is: "^([a-z0-9A-Z_.-]){1,63}$"

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

Name

Type

Required

Description

name

string

True

value

string

True

type_astra_metadata

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema

Name	Type	Required
labels	array[type_astra_label]	True
creationTimestamp	string	True
modificationTimestamp	string	True
createdBy	string	True
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

modifiedBy

string

False

appAsset_1.1_get_response_body

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-appAsset"
version	string	True	Version of the resource. Defined values are: "1.0" "1.1"
id	string	True	Globally unique identifier of the resource. Defined values are: Conforms to the UUIDv4 Schema
assetType	string	True	JSON string containing a value indicating what type of asset is being described as obtained from Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254
creationTimestamp	string	True	JSON string containing a timestamp indicating when the Kubernetes metadata was created. Defined values are: Conforms to the ISO-8601 Date Time Schema
GVK	GVK	True	JSON object containing a Kubernetes group/version/kind.
resource	type_json	False	JSON object containing the entire content of the Kubernetes resource definition.
assetID	string	True	JSON string containing an identifier assigned by Kubernetes. Defined values are: Conforms to the Astra Identifier Schema
labels	array[labels]	True	JSON array of JSON objects, each containing a Kubernetes labels associated with the asset. If no details are available, this array will be empty. Minimum items: 0
assetName	string	True	JSON string containing a name assigned by Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254
namespace	string	False	JSON string containing a namespace assigned by Kubernetes. Defined values are: Minimum length: 1 Maximum length: 254
metadata	type_astra_metadata	True	Client and service-specified metadata associated with the resource. Defined values are: Conforms to the Astra Metadata Schema

Name

Type

Required

Description

type

string

True

Media type of the resource. Defined values are:

"application/astra-appAsset"

version

string

True

Version of the resource. Defined values are:

"1.0"
"1.1"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

assetType

string

True

JSON string containing a value indicating what type of asset is being described as obtained from Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

creationTimestamp

string

True

JSON string containing a timestamp indicating when the Kubernetes metadata was created. Defined values are:

Conforms to the ISO-8601 Date Time Schema

GVK

True

JSON object containing a Kubernetes group/version/kind.

resource

type_json

False

JSON object containing the entire content of the Kubernetes resource definition.

assetID

string

True

JSON string containing an identifier assigned by Kubernetes. Defined values are:

Conforms to the Astra Identifier Schema

labels

array[labels]

True

JSON array of JSON objects, each containing a Kubernetes labels associated with the asset. If no details are available, this array will be empty.

Minimum items: 0

assetName

string

True

JSON string containing a name assigned by Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

namespace

string

False

JSON string containing a namespace assigned by Kubernetes. Defined values are:

Minimum length: 1
Maximum length: 254

metadata

type_astra_metadata

True

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema

type_astra_metadata_list

Name	Type	Required
continue	string	False
count	number	False
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name	Type	Required	Description
name	string	True	Name of the invalid query parameter
reason	string	True	Reason why the query parameter is invalid

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

List application assets for an application snapshot

Parameters

Response

Response

Response

Response

Error

Definitions

Parameters

Headers

Body

Code

Response

List application assets for an application snapshot

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions

Parameters

Headers

Body

Code

Response