La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Retrieve an application asset for an app

10/21/2024 Contributeurs

PDF

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/appAssets/{appAsset_id}

Returns the stored Application Asset API resource in the JSON response body.

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
appAsset_id	string	path	True	ID of the appAsset collection to list

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

appAsset_id

string

path

True

ID of the appAsset collection to list

Response

Status: 200, Returns the stored Application Asset API resource in the JSON 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

Example response

{
  "type": "application/astra-appAsset",
  "version": "1.1",
  "id": "6415e851-b820-553b-9432-ebd057d1917d",
  "assetType": "Pod",
  "creationTimestamp": "2020-08-06T12:24:52.256624Z",
  "GVK": {
    "group": "apps",
    "kind": "Pod",
    "version": "v1"
  },
  "assetID": "93ec0c61-d993-4aa1-bb08-f4dcdd5e97f6",
  "labels": [
    {
      "name": "app",
      "value": "mediawiki"
    },
    {
      "name": "pod-template-hash",
      "value": "69c6fcf864"
    }
  ],
  "assetName": "mediawiki-69c6fcf864-2wx6l",
  "namespace": "wiki",
  "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	Description
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False
invalidParams	array[invalidParams]	False	List of invalid query parameters

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters

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

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

Retrieve an application asset for an app

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions