1.8. Applications API

1.8.1. 概要

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Application リソースについて説明します。Application リソースには、create、query、delete、update の 4 つの要求を使用できます。

1.8.1.1. バージョン情報

バージョン: 2.9.0

1.8.1.2. URI スキーム

ベースパス: /kubernetes/apis
スキーム: HTTPS

1.8.1.3. タグ

applications.app.k8s.io: アプリケーションを作成して管理します。

1.8.2. パス

1.8.2.1. アプリケーションの作成

POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.8.2.1.1. 説明

アプリケーションを作成します。

1.8.2.1.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string
Body	body 必須	作成するアプリケーションを記述するパラメーター	アプリケーション

1.8.2.1.3. 応答

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.8.2.1.4. 消費

application/yaml

1.8.2.1.5. タグ

applications.app.k8s.io

1.8.2.1.6. HTTP リクエストの例

1.8.2.1.6.1. 要求の body

{
  "apiVersion" : "app.k8s.io/v1beta1",
  "kind" : "Application",
  "metadata" : {
    "labels" : {
      "app" : "nginx-app-details"
    },
    "name" : "nginx-app-3",
    "namespace" : "ns-sub-1"
  },
  "spec" : {
    "componentKinds" : [ {
      "group" : "apps.open-cluster-management.io",
      "kind" : "Subscription"
    } ]
  },
  "selector" : {
    "matchLabels" : {
      "app" : "nginx-app-details"
    }
  },
  "status" : { }
}

1.8.2.2. 全アプリケーションのクエリー

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications

1.8.2.2.1. 説明

アプリケーションにクエリーを行い、詳細を確認します。

1.8.2.2.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	namespace 必須	使用する namespace (例: default)	string

1.8.2.2.3. レスポンス

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.8.2.2.4. 消費

application/yaml

1.8.2.2.5. タグ

applications.app.k8s.io

1.8.2.3. 単一アプリケーションのクエリー

GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.8.2.3.1. 説明

1 つのアプリケーションに対してクエリーを行い、詳細を確認します。

1.8.2.3.2. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	問い合わせるアプリケーションの名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.8.2.3.3. レスポンス

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.8.2.3.4. タグ

applications.app.k8s.io

1.8.2.4. アプリケーションの削除

DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}

1.8.2.4.1. パラメーター

型	名前	説明	スキーマ
Header	COOKIE 必須	Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。	string
パス	application_name 必須	削除するアプリケーションの名前	string
パス	namespace 必須	使用する namespace (例: default)	string

1.8.2.4.2. レスポンス

HTTP コード	説明	スキーマ
200	成功	コンテンツなし
403	アクセス禁止	コンテンツなし
404	リソースが見つからない	コンテンツなし
500	内部サービスエラー	コンテンツなし
503	サービスが利用できない	コンテンツなし

1.8.2.4.3. タグ

applications.app.k8s.io

1.8.3. 定義

1.8.3.1. アプリケーション

Name	スキーマ
apiVersion 必須	string
kind 必須	string
metadata 必須	object
spec 必須	spec

spec

名前	スキーマ
assemblyPhase 任意	string
componentKinds 任意	object array
descriptor 任意	記述子
info 任意	info array
selector 任意	object

記述子

Name	スキーマ
description 任意	string
icons 任意	icons array
keywords 任意	string array
links 任意	links array
maintainers 任意	maintainers array
notes 任意	string
owners 任意	owners array
type 任意	string
version 任意	string

icons

Name	スキーマ
size 任意	string
src 必須	string
type 任意	string

links

Name	スキーマ
description 任意	string
url 任意	string

maintainers

Name	スキーマ
email 任意	string
name 任意	string
url 任意	string

owners

Name	スキーマ
email 任意	string
name 任意	string
url 任意	string

info

Name	スキーマ
name 任意	string
type 任意	string
value 任意	string
valueFrom 任意	valueFrom

valueFrom

Name	スキーマ
configMapKeyRef 任意	configMapKeyRef
ingressRef 任意	ingressRef
secretKeyRef 任意	secretKeyRef
serviceRef 任意	serviceRef
type 任意	string

configMapKeyRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
key 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

ingressRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
host 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
path 任意	string
resourceVersion 任意	string
uid 任意	string

secretKeyRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
key 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
resourceVersion 任意	string
uid 任意	string

serviceRef

Name	スキーマ
apiVersion 任意	string
fieldPath 任意	string
kind 任意	string
name 任意	string
namespace 任意	string
path 任意	string
ポート任意	integer (int32)
resourceVersion 任意	string
uid 任意	string