Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

List the namespaces for a managed cluster

10/23/2024 Colaboradores

PDF

GET /accounts/{account_id}/topology/v1/managedClusters/{managedCluster_id}/namespaces

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}}
managedCluster_id	string	path	True	ID of the containing managedCluster 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: id,name,kubernetesLabels
limit	string	query	False	Indicates the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2"
filter	string	query	False	Indicates which fields should be matched in order to return a resource when listing a collection. Supported operators are: eq - Equality lt/gt - Less than/Greater than lte/gte - Less than or equals to/Greater than or equals to URL example: "filter=field%20eq%20%27value%27" OpenAPI examples: "field eq 'value'"

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

managedCluster_id

string

path

True

ID of the containing managedCluster 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: id,name,kubernetesLabels

limit

string

query

False

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

URL examples: "limit=2"

OpenAPI examples: "2"

filter

string

query

False

Indicates which fields should be matched in order to return a resource when listing a collection.

Supported operators are:

eq - Equality
lt/gt - Less than/Greater than
lte/gte - Less than or equals to/Greater than or equals to

URL example: "filter=field%20eq%20%27value%27"

OpenAPI examples: "field eq 'value'"

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: namespace_1.1_get_response_body, array[]]	True
metadata	type_astra_metadata_list	True

Name

Type

Required

Description

items

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

True

metadata

type_astra_metadata_list

True

Example response

{
  "type": "application/astra-namespaces",
  "version": "1.1",
  "items": [
    [
      "7d451d2f-196e-4234-aee9-7e2376047e63",
      "kube-system",
      [
        {
          "name": "app.kubernetes.io/environment",
          "value": "dev"
        }
      ]
    ],
    [
      "66b0873b-214f-4ac7-89d8-922432f941eb",
      "jenkins",
      [
        {
          "name": "app.kubernetes.io/environment",
          "value": "dev"
        }
      ]
    ]
  ],
  "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

targetSchema

accept-post

accept-put

hints

Name	Type	Required
status	string	False
allow	array[string]	False
accept-post	accept-post	False
permissions	array[string]	False
accept-put	accept-put	False

Name

Type

Required

Description

status

string

False

allow

array[string]

False

accept-post

False

permissions

array[string]

False

accept-put

False

type_astra_link

Name	Type	Required
rel	string	True
href	string	True
type	string	False
targetSchema	targetSchema	False
title	string	False
hints	hints	False

Name

Type

Required

Description

rel

string

True

href

string

True

type

string

False

targetSchema

False

title

string

False

hints

False

type_astra_stateDetail

Name	Type	Required
type	string	True
title	string	True
detail	string	True

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

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

namespace_1.1_get_response_body

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-namespace"
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
links	array[type_astra_link]	True	Links describing supported operations against the resource.
name	string	True	JSON string containing a value indicating the name of the namespace. Defined values are: Minimum length: 1 Maximum length: 255
namespaceState	string	True	JSON string containing a value indicating the state of the namespace. Defined values are: "discovered" - The namespace has been found in the cluster "removed" - The namespace has been deleted from the cluster, or the cluster is not managed but there might be resources referring to the namespace
namespaceStateDetails	array[type_astra_stateDetail]	True	JSON array of JSON objects that lists additional details about why "state" transitioned into "state a", "state b", or "state c". If no details are available, this array will be empty. Defined values are: Minimum items: 0
kubernetesLabels	array[type_astra_label]	False	JSON array of JSON objects, each containing a Kubernetes label associated with the namespace. Defined values are: Conforms to the Kubernetes Label Array Schema
clusterID	string	True	JSON string containing a globally unique identifier of the cluster that the namespace is contained in. Defined values are: Conforms to the Astra Identifier Schema
systemType	string	False	JSON string that denotes that the namespace is a type of system namespace. This field identifies what type of system namespace, if any, the namespace is (version 1.1 only). Defined values are: "kubernetes" - A generic Kubernetes (K8s) system namespace, for example, "kube-system" "netapp" - A NetApp system namespace, for example, "trident" or "netapp-monitoring" "openshift" - An OpenShift system namespace, for example, "openshift-monitoring" "rke" - A Rancher namespace, for example, "cattle-logging" "other" - Common system namespaces that don't necessarily fit elsewhere, for example, "ingress-nginx", "tekton-system"
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-namespace"

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

links

array[type_astra_link]

True

Links describing supported operations against the resource.

name

string

True

JSON string containing a value indicating the name of the namespace. Defined values are:

Minimum length: 1
Maximum length: 255

namespaceState

string

True

JSON string containing a value indicating the state of the namespace. Defined values are:

"discovered" - The namespace has been found in the cluster
"removed" - The namespace has been deleted from the cluster, or the cluster is not managed but there might be resources referring to the namespace

namespaceStateDetails

array[type_astra_stateDetail]

True

JSON array of JSON objects that lists additional details about why "state" transitioned into "state a", "state b", or "state c". If no details are available, this array will be empty. Defined values are:

Minimum items: 0

kubernetesLabels

array[type_astra_label]

False

JSON array of JSON objects, each containing a Kubernetes label associated with the namespace. Defined values are:

Conforms to the Kubernetes Label Array Schema

clusterID

string

True

JSON string containing a globally unique identifier of the cluster that the namespace is contained in. Defined values are:

Conforms to the Astra Identifier Schema

systemType

string

False

JSON string that denotes that the namespace is a type of system namespace. This field identifies what type of system namespace, if any, the namespace is (version 1.1 only). Defined values are:

"kubernetes" - A generic Kubernetes (K8s) system namespace, for example, "kube-system"
"netapp" - A NetApp system namespace, for example, "trident" or "netapp-monitoring"
"openshift" - An OpenShift system namespace, for example, "openshift-monitoring"
"rke" - A Rancher namespace, for example, "cattle-logging"
"other" - Common system namespaces that don't necessarily fit elsewhere, for example, "ingress-nginx", "tekton-system"

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 the namespaces for a managed cluster

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions