Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> API Groups> listing APIResources of GroupVersion apps/v1&apps/v1beta1
View PDF

listing APIResources of GroupVersion apps/v1&apps/v1beta1

Function

This API is used to list APIResources of Group Version "apps/v1" and "apps/v1beta1".

URI

GET /apis/apps/v1 (for clusters later than v1.15)

GET /apis/apps/v1beta1 (for clusters of v1.15 and earlier)

Request

N/A.

Response

Response parameters:

Table 1 describes the 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

resources object

Standard list resource
Table 2 Data structure of the resources field

Parameter

Type

Description

categories

Array of strings

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

Arrayofstrings

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

Arrayofstrings

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

Example response:

{
    "kind": "APIResourceList",
    "apiVersion": "v1",
    "groupVersion": "apps/v1beta1",
    "resources": [
        {
            "name": "controllerrevisions",
            "singularName": "",
            "namespaced": true,
            "kind": "ControllerRevision",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update",
                "watch"
            ]
        },
        {
            "name": "deployments",
            "singularName": "",
            "namespaced": true,
            "kind": "Deployment",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update",
                "watch"
            ],
            "shortNames": [
                "deploy"
            ],
            "categories": [
                "all"
            ]
        },
        {
            "name": "deployments/rollback",
            "singularName": "",
            "namespaced": true,
            "kind": "DeploymentRollback",
            "verbs": [
                "create"
            ]
        },
        {
            "name": "deployments/scale",
            "singularName": "",
            "namespaced": true,
            "kind": "Scale",
            "verbs": [
                "get",
                "patch",
                "update"
            ]
        },
        {
            "name": "deployments/status",
            "singularName": "",
            "namespaced": true,
            "kind": "Deployment",
            "verbs": [
                "get",
                "patch",
                "update"
            ]
        },
        {
            "name": "statefulsets",
            "singularName": "",
            "namespaced": true,
            "kind": "StatefulSet",
            "verbs": [
                "create",
                "delete",
                "deletecollection",
                "get",
                "list",
                "patch",
                "update",
                "watch"
            ],
            "shortNames": [
                "sts"
            ],
            "categories": [
                "all"
            ]
        },
        {
            "name": "statefulsets/status",
            "singularName": "",
            "namespaced": true,
            "kind": "StatefulSet",
            "verbs": [
                "get",
                "patch",
                "update"
            ]
        }
    ]
}

Status Code

Table 3 describes the status code of this API.

Table 3 Status code

Status Code

Description

200

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

For the description about status codes, see Status Code.

Parent topic: API Groups