更新时间:2023-12-01 GMT+08:00
分享

查询APIGroupList

功能介绍

get available API versions

调用方法

请参见如何调用API

URI

GET /apis

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

groups

Array of io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup objects

groups is a list of APIGroup.

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

表3 io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup

参数

参数类型

描述

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

String

name is the name of the group.

preferredVersion

io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery object

preferredVersion is the version preferred by the API server, which probably is the storage version.

serverAddressByClientCIDRs

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR objects

a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

versions

Array of io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery objects

versions are the versions supported in this group.

表4 io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery

参数

参数类型

描述

groupVersion

String

groupVersion specifies the API group and version in the form "group/version"

version

String

version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.

表5 io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR

参数

参数类型

描述

clientCIDR

String

The CIDR with which clients can match their IP to figure out the server address that they should use.

serverAddress

String

Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

请求示例

响应示例

状态码: 200

OK

{
  "apiVersion" : "v1",
  "groups" : [ {
    "name" : "extensions",
    "preferredVersion" : {
      "groupVersion" : "extensions/v1beta1",
      "version" : "v1beta1"
    },
    "versions" : [ {
      "groupVersion" : "extensions/v1beta1",
      "version" : "v1beta1"
    } ]
  }, {
    "name" : "apps",
    "preferredVersion" : {
      "groupVersion" : "apps/v1",
      "version" : "v1"
    },
    "versions" : [ {
      "groupVersion" : "apps/v1",
      "version" : "v1"
    }, {
      "groupVersion" : "apps/v1beta1",
      "version" : "v1beta1"
    } ]
  }, {
    "name" : "batch",
    "preferredVersion" : {
      "groupVersion" : "batch/v1",
      "version" : "v1"
    },
    "versions" : [ {
      "groupVersion" : "batch/v1",
      "version" : "v1"
    }, {
      "groupVersion" : "batch/v1beta1",
      "version" : "v1beta1"
    } ]
  }, {
    "name" : "rbac.authorization.k8s.io",
    "preferredVersion" : {
      "groupVersion" : "rbac.authorization.k8s.io/v1",
      "version" : "v1"
    },
    "versions" : [ {
      "groupVersion" : "rbac.authorization.k8s.io/v1",
      "version" : "v1"
    } ]
  }, {
    "name" : "networking.cci.io",
    "preferredVersion" : {
      "groupVersion" : "networking.cci.io/v1beta1",
      "version" : "v1beta1"
    },
    "versions" : [ {
      "groupVersion" : "networking.cci.io/v1beta1",
      "version" : "v1beta1"
    } ]
  }, {
    "name" : "image.cci.io",
    "preferredVersion" : {
      "groupVersion" : "image.cci.io/v1alpha1",
      "version" : "v1alpha1"
    },
    "versions" : [ {
      "groupVersion" : "image.cci.io/v1alpha1",
      "version" : "v1alpha1"
    } ]
  }, {
    "name" : "kubeflow.org",
    "preferredVersion" : {
      "groupVersion" : "kubeflow.org/v1",
      "version" : "v1"
    },
    "versions" : [ {
      "groupVersion" : "kubeflow.org/v1",
      "version" : "v1"
    } ]
  }, {
    "name" : "batch.volcano.sh",
    "preferredVersion" : {
      "groupVersion" : "batch.volcano.sh/v1alpha1",
      "version" : "v1alpha1"
    },
    "versions" : [ {
      "groupVersion" : "batch.volcano.sh/v1alpha1",
      "version" : "v1alpha1"
    } ]
  }, {
    "name" : "metrics.k8s.io",
    "preferredVersion" : {
      "groupVersion" : "metrics.k8s.io/v1beta1",
      "version" : "v1beta1"
    },
    "versions" : [ {
      "groupVersion" : "metrics.k8s.io/v1beta1",
      "version" : "v1beta1"
    } ]
  } ],
  "kind" : "APIGroupList"
}

状态码

状态码

描述

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

405

MethodNotAllowed

406

NotAcceptable

409

Conflict

415

UnsupportedMediaType

422

Invalid

429

TooManyRequests

500

InternalError

503

ServiceUnavailable

504

ServerTimeout

相关文档