Help Center/ Cloud Container Instance/ API Reference/ Kubernetes APIs/ API groups/ Querying All APIs of networking.cci.io/v1beta1
Updated on 2023-12-21 GMT+08:00

Querying All APIs of networking.cci.io/v1beta1

Function

get available resources

Calling Method

For details, see Calling APIs.

URI

GET /apis/networking.cci.io/v1beta1

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

groupVersion

String

groupVersion is the group and version this APIResourceList is for.

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

resources

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

resources contains the name of the resources and if they are namespaced.

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

Parameter

Type

Description

categories

Array of strings

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

group

String

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

kind

String

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

name

String

name is the plural name of the resource.

namespaced

Boolean

namespaced indicates if a resource is namespaced or not.

shortNames

Array of strings

shortNames is a list of suggested short names of the resource.

singularName

String

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

storageVersionHash

String

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

verbs

Array of strings

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

version

String

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

Example Requests

None

Example Responses

Status code: 200

OK

{
  "apiVersion" : "v1",
  "groupVersion" : "networking.cci.io/v1beta1",
  "kind" : "APIResourceList",
  "resources" : [ {
    "kind" : "Network",
    "name" : "networks",
    "namespaced" : true,
    "singularName" : "",
    "verbs" : [ "create", "delete", "deletecollection", "get", "list", "patch", "update", "watch" ]
  }, {
    "kind" : "Network",
    "name" : "networks/status",
    "namespaced" : true,
    "singularName" : "",
    "verbs" : [ "get", "patch", "update" ]
  } ]
}

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