Help Center> Cloud Container Instance (CCI)> API Reference> Kubernetes-native APIs> API Groups> Listing APIResources of GroupVersion v1
View PDF

Listing APIResources of GroupVersion v1

Function

This API is used to list APIResources of GroupVersion "v1".

URI

GET /api/v1

Request

N/A

Response

Response parameters

Table 1 Parameter description

Parameter

Type

Description

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.

groupVersion

String

GroupVersion specifies the API group and version in the form "group/version".

resources

Table 2

Standard list resource.
Table 2 Data structure of the resources field

Parameter

Type

Description

categories

String array

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

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

String array

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.

verbs

String array

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

Example response

{
    "kind": "APIResourceList",
    "groupVersion": "v1",
    "resources": [
        {
            "name": "configmaps",
            "singularName": "",
            "namespaced": true,
            "kind": "ConfigMap",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update"
            ],
            "shortNames": [
                "cm"
            ]
        },
        {
            "name": "events",
            "singularName": "",
            "namespaced": true,
            "kind": "Event",
            "verbs": [
                "delete",
                "get",
                "list"
            ],
            "shortNames": [
                "ev"
            ]
        },
        {
            "name": "namespaces",
            "singularName": "",
            "namespaced": false,
            "kind": "Namespace",
            "verbs": [
                "create",
                "delete",
                "get",
                "patch",
                "update"
            ],
            "shortNames": [
                "ns"
            ]
        },
        {
            "name": "persistentvolumeclaims",
            "singularName": "",
            "namespaced": true,
            "kind": "PersistentVolumeClaim",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update"
            ],
            "shortNames": [
                "pvc"
            ]
        },
        {
            "name": "pods",
            "singularName": "",
            "namespaced": true,
            "kind": "Pod",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update"
            ],
            "shortNames": [
                "po"
            ],
            "categories": [
                "all"
            ]
        },
        {
            "name": "secrets",
            "singularName": "",
            "namespaced": true,
            "kind": "Secret",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update"
            ]
        },
        {
            "name": "services",
            "singularName": "",
            "namespaced": true,
            "kind": "Service",
            "verbs": [
                "create",
                "delete",
                "get",
                "list",
                "patch",
                "proxy",
                "update",
                "watch"
            ]
        }
    ]
}

Status Code

Table 3 Status code

Status Code

Description

200

This operation succeeds, and a list of APIResources is returned.

For more status codes, see Status Codes.

Parent topic: API Groups