Updated on 2023-12-21 GMT+08:00

Querying APIGroup (/apis/apps)

Function

This API is used to query an APIGroup (/apis/apps).

Calling Method

For details, see Calling APIs.

URI

GET /apis/apps

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

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.

Table 3 io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery

Parameter

Type

Description

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.

Table 4 io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR

Parameter

Type

Description

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.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "apiVersion" : "v1",
  "kind" : "APIGroup",
  "name" : "apps",
  "preferredVersion" : {
    "groupVersion" : "apps/v1",
    "version" : "v1"
  },
  "versions" : [ {
    "groupVersion" : "apps/v1",
    "version" : "v1"
  } ]
}

Status Codes

Status Code

Description

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