Skip to main content
24.02
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

クラウドの名前空間を一覧表示する

PDF

GET /accounts/{account_id}/topology/v1/clouds/{cloud_id}/clusters/{cluster_id}/namespaces

コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

cloud_id

string

path（パス）

True

包含するクラウド リソースのID

cluster_id

string

path（パス）

True

含まれるクラスタリソースのID

含める

string

query

False

コレクションを一覧表示する際に、どのフィールドを返すかを指定します。

URLの例："include=id"、"include=id,name"

OpenAPI の例："id"

  • 例：id、name、kubernetesLabels

制限（ Limit ）

string

query

False

コレクションを一覧表示する際に返されるリソースの最大数を示します。

URLの例："limit=2"

OpenAPI の例："2"

フィルタ

string

query

False

コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。

サポートされているオペレータは次のとおりです：

  • eq - 等号

  • lt/gt - より小さい/より大きい

  • lte/gte - 以下/以上

URLの例："filter=field%20eq%20%27value%27"

OpenAPI の例：「field eq 'value'」

応答

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 を入力します 必須 説明

項目

配列[いずれか："namespace_1.2_get_response_body"、配列[]]

True

メタデータ

"type_astra_metadata_list"

True
回答例 
{
  "type": "application/astra-namespaces",
  "version": "1.2",
  "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"
  }
}

応答

Status: 401, Unauthorized
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

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

応答

Status: 400, Bad request
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
回答例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 403, Forbidden
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

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

エラー

Status: 404, Not found
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
エラー応答の例 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

targetSchema

accept-post

accept-put

ヒント

Name を入力します 必須 説明

ステータス

string

False

許可する

array[string]

False

accept-post

"accept-post"

False

権限

array[string]

False

accept-put

"accept-put"

False

type_astra_link

Name を入力します 必須 説明

rel

string

True

href

string

True

を入力します

string

False

targetSchema

"targetSchema"

False

タイトル

string

False

ヒント

"ヒント"

False

additionalDetails

type_astra_stateDetail

Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

additionalDetails

"additionalDetails"

False

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astraメタデータスキーマに準拠

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

True

作成タイムスタンプ

string

True

modificationTimestamp

string

True

作成者

string

True

modifiedBy

string

False

namespace_1.2_get_response_body

Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-namespace"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

  • "1.2"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

リンク

配列["type_astra_link"]

True

リソースに対してサポートされている操作を説明するリンク。

名前

string

True

名前空間の名前を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：255

namespaceState

string

True

名前空間の状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「discovered」 - ネームスペースがクラスター内で検出されました

  • 「削除済み」 - 名前空間がクラスターから削除されたか、クラスターが管理されていないが、名前空間を参照するリソースが存在する可能性がある

namespaceStateDetails

配列["type_astra_stateDetail"]

True

「状態」が「状態 a」、「状態 b」、または「状態 c」に遷移した理由に関する詳細情報をリストした JSON オブジェクトの JSON 配列。詳細情報がない場合は、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

kubernetesLabels

配列["type_astra_label"]

False

JSONオブジェクトのJSON配列。各JSONオブジェクトには、名前空間に関連付けられたKubernetesラベルが含まれています。定義された値は次のとおりです：

  • Kubernetesラベル配列スキーマに準拠

kubernetesUID

string

True

名前空間リソースの Kubernetes 生成 UID を含む JSON 文字列

clusterID

string

True

名前空間が含まれるクラスタのグローバルに一意な識別子を含むJSON文字列。定義済みの値は次のとおりです：

  • Astra識別子スキーマに準拠

systemType

string

False

名前空間がシステム名前空間の一種であることを示すJSON文字列。このフィールドは、システム名前空間の種類（存在する場合）を識別します（バージョン1.1のみ）。定義された値は次のとおりです：

  • 「kubernetes」 - 一般的なKubernetes（K8s）システムの名前空間。例：「kube-system」

  • 「netapp」 - NetAppシステムネームスペース。例：「trident」または「netapp-monitoring」

  • "openshift" - OpenShiftシステム名前空間、例えば、"openshift-monitoring"

  • 「rke」 - Rancherの名前空間。例：「cattle-logging」

  • 「other」 - 他の場所に必ずしも当てはまらない一般的なシステムnamespace（例：「ingress-nginx」、「tekton-system」）

メタデータ

"type_astra_metadata"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astraメタデータスキーマに準拠

type_astra_metadata_list

Name を入力します 必須 説明

続行

string

False

カウント

番号

False

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由