主页
产品
Red Hat Advanced Cluster Management for Kubernetes
2.0
APIs
1.3. Subscriptions API

1.3. Subscriptions API

1.3.1. Overview
复制链接

This documentation is for the Subscription resource for Red Hat Advanced Cluster Management for Kubernetes. The Subscription resource has four possible requests: create, query, delete and update.

1.3.1.1. Version information
复制链接

Version : 2.0.0

1.3.1.2. Contact information
复制链接

Contact Email : apiteam@swagger.io

1.3.1.3. License information
复制链接

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/

1.3.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.3.1.5. Tags
复制链接

subscriptions.apps.open-cluster-management.io : Create and manage subscriptions

1.3.1.6. External Docs
复制链接

Description : Find out more about Swagger.
URL : http://swagger.io

1.3.2. Paths
复制链接

1.3.2.1. Create a subscription
复制链接

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

Copy to Clipboard

Toggle word wrap

1.3.2.1.1. Description
复制链接

Create a subscription.

1.3.2.1.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the subscription to be created.	Subscription

1.3.2.1.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.3.2.1.4. Consumes
复制链接

subscription/yaml

1.3.2.1.5. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.3.2.1.6. Example HTTP request
复制链接

1.3.2.1.6.1. Request body
复制链接

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "Subscription",
  "metadata" : {
    "name" : "sample_subscription",
    "namespace" : "default",
    "labels" : {
      "app" : "sample_subscription-app"
    },
    "annotations" : {
      "apps.open-cluster-management.io/git-path" : "apps/sample/",
      "apps.open-cluster-management.io/git-branch" : "sample_branch"
    }
  },
  "spec" : {
    "channel" : "channel_namespace/sample_channel",
    "packageOverrides" : [ {
      "packageName" : "my-sample-application",
      "packageAlias" : "the-sample-app",
      "packageOverrides" : [ {
        "path" : "spec",
        "value" : {
          "persistence" : {
            "enabled" : false,
            "useDynamicProvisioning" : false
          },
          "license" : "accept",
          "tls" : {
            "hostname" : "my-mcm-cluster.icp"
          },
          "sso" : {
            "registrationImage" : {
              "pullSecret" : "hub-repo-docker-secret"
            }
          }
        }
      } ]
    } ],
    "placement" : {
      "placementRef" : {
        "kind" : "PlacementRule",
        "name" : "demo-clusters"
      }
    }
  }
}

Copy to Clipboard

Toggle word wrap

1.3.2.2. Query all subscriptions
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions

Copy to Clipboard

Toggle word wrap

1.3.2.2.1. Description
复制链接

Query your subscriptions for more details.

1.3.2.2.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.3.2.2.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.3.2.2.4. Consumes
复制链接

subscription/yaml

1.3.2.2.5. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.3.2.3. Query a single subscription
复制链接

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

Copy to Clipboard

Toggle word wrap

1.3.2.3.1. Description
复制链接

Query a single subscription for more details.

1.3.2.3.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	subscription_name required	Name of the subscription that you wan to query.	string

1.3.2.3.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.3.2.3.4. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.3.2.4. Delete a subscription
复制链接

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}

Copy to Clipboard

Toggle word wrap

1.3.2.4.1. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Path	subscription_name required	Name of the subscription that you want to delete.	string

1.3.2.4.2. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.3.2.4.3. Tags
复制链接

subscriptions.apps.open-cluster-management.io

1.3.3. Definitions
复制链接

1.3.3.1. Subscription
复制链接

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	metadata
spec required	spec
status optional	status

metadata

Expand

Name	Schema
annotations optional	object
labels optional	object
name optional	string
namespace optional	string

spec

Expand

Name	Schema
channel required	string
name optional	string
overrides optional	< overrides > array
packageFilter optional	packageFilter
packageOverrides optional	< packageOverrides > array
placement optional	placement
timewindow optional	timewindow

overrides

Expand

Name	Schema
clusterName required	string
clusterOverrides required	< object > array

packageFilter

Expand

Name	Description	Schema
annotations optional		< string, string > map
filterRef optional		filterRef
labelSelector optional		labelSelector
version optional	Pattern : `"()((\\.[0-9])(\\.)\|(\\.[0-9])?(\\.[xX]))$"`	string

filterRef

Expand

Name	Schema
name optional	string

labelSelector

Expand

Name	Schema
matchExpressions optional	< matchExpressions > array
matchLabels optional	< string, string > map

matchExpressions

Expand

Name	Schema
key required	string
operator required	string
values optional	< string > array

packageOverrides

Expand

Name	Schema
packageAlias optional	string
packageName required	string
packageOverrides optional	< object > array

placement

Expand

Name	Schema
clusterSelector optional	clusterSelector
clusters optional	< clusters > array
local optional	boolean
placementRef optional	placementRef

clusterSelector

Expand

Name	Schema
matchExpressions optional	< matchExpressions > array
matchLabels optional	< string, string > map

matchExpressions

Expand

Name	Schema
key required	string
operator required	string
values optional	< string > array

clusters

Expand

Name	Schema
name required	string

placementRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

timewindow

Expand

Name	Schema
daysofweek optional	< string > array
hours optional	< hours > array
location optional	string
windowtype optional	enum (active, blocked, Active, Blocked)

hours

Expand

Name	Schema
end optional	string
start optional	string

status

Expand

Name	Schema
lastUpdateTime optional	string (date-time)
message optional	string
phase optional	string
reason optional	string
statuses optional	object

返回顶部

1.3. Subscriptions API

1.3.1. Overview复制链接链接已复制到粘贴板!

1.3.1.1. Version information复制链接链接已复制到粘贴板!

1.3.1.2. Contact information复制链接链接已复制到粘贴板!

1.3.1.3. License information复制链接链接已复制到粘贴板!

1.3.1.4. URI scheme复制链接链接已复制到粘贴板!

1.3.1.5. Tags复制链接链接已复制到粘贴板!

1.3.1.6. External Docs复制链接链接已复制到粘贴板!

1.3.2. Paths复制链接链接已复制到粘贴板!

1.3.2.1. Create a subscription复制链接链接已复制到粘贴板!

1.3.2.1.1. Description复制链接链接已复制到粘贴板!

1.3.2.1.2. Parameters复制链接链接已复制到粘贴板!

1.3.2.1.3. Responses复制链接链接已复制到粘贴板!

1.3.2.1.4. Consumes复制链接链接已复制到粘贴板!

1.3.2.1.5. Tags复制链接链接已复制到粘贴板!

1.3.2.1.6. Example HTTP request复制链接链接已复制到粘贴板!

1.3.2.1.6.1. Request body复制链接链接已复制到粘贴板!

1.3.2.2. Query all subscriptions复制链接链接已复制到粘贴板!

1.3.2.2.1. Description复制链接链接已复制到粘贴板!

1.3.2.2.2. Parameters复制链接链接已复制到粘贴板!

1.3.2.2.3. Responses复制链接链接已复制到粘贴板!

1.3.2.2.4. Consumes复制链接链接已复制到粘贴板!

1.3.2.2.5. Tags复制链接链接已复制到粘贴板!

1.3.2.3. Query a single subscription复制链接链接已复制到粘贴板!

1.3.2.3.1. Description复制链接链接已复制到粘贴板!

1.3.2.3.2. Parameters复制链接链接已复制到粘贴板!

1.3.2.3.3. Responses复制链接链接已复制到粘贴板!

1.3.2.3.4. Tags复制链接链接已复制到粘贴板!

1.3.2.4. Delete a subscription复制链接链接已复制到粘贴板!

1.3.2.4.1. Parameters复制链接链接已复制到粘贴板!

1.3.2.4.2. Responses复制链接链接已复制到粘贴板!

1.3.2.4.3. Tags复制链接链接已复制到粘贴板!

1.3.3. Definitions复制链接链接已复制到粘贴板!

1.3.3.1. Subscription复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.3.1. Overview
复制链接

1.3.1.1. Version information
复制链接

1.3.1.2. Contact information
复制链接

1.3.1.3. License information
复制链接

1.3.1.4. URI scheme
复制链接

1.3.1.5. Tags
复制链接

1.3.1.6. External Docs
复制链接

1.3.2. Paths
复制链接

1.3.2.1. Create a subscription
复制链接

1.3.2.1.1. Description
复制链接

1.3.2.1.2. Parameters
复制链接

1.3.2.1.3. Responses
复制链接

1.3.2.1.4. Consumes
复制链接

1.3.2.1.5. Tags
复制链接

1.3.2.1.6. Example HTTP request
复制链接

1.3.2.1.6.1. Request body
复制链接

1.3.2.2. Query all subscriptions
复制链接

1.3.2.2.1. Description
复制链接

1.3.2.2.2. Parameters
复制链接

1.3.2.2.3. Responses
复制链接

1.3.2.2.4. Consumes
复制链接

1.3.2.2.5. Tags
复制链接

1.3.2.3. Query a single subscription
复制链接

1.3.2.3.1. Description
复制链接

1.3.2.3.2. Parameters
复制链接

1.3.2.3.3. Responses
复制链接

1.3.2.3.4. Tags
复制链接

1.3.2.4. Delete a subscription
复制链接

1.3.2.4.1. Parameters
复制链接

1.3.2.4.2. Responses
复制链接

1.3.2.4.3. Tags
复制链接

1.3.3. Definitions
复制链接

1.3.3.1. Subscription
复制链接