Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> RBAC> Role> Reading a Specified Role
View PDF

Reading a Specified Role

Function

This API is used to read a specified Role.

URL

GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

name

Yes

Name of the Role.

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

If 'true', then the output is pretty printed.

Request

N/A

Response

Response parameters:

For the description about response parameters, see Table 2.

Example response:

{
    "kind" : "Role",
    "apiVersion" : "rbac.authorization.k8s.io/v1",
    "metadata" : {
        "name" : "pod-reader",
        "namespace" : "default",
        "selfLink" : "/apis/rbac.authorization.k8s.io/v1/namespaces/default/roles/secret-reader",
        "uid" : "f379007e-f1f0-11e8-b449-fa163ec24e06",
        "resourceVersion" : "13218",
        "creationTimestamp" : "2018-11-27T03:03:01Z"
    },
    "rules" : [ {
        "verbs" : [ "get", "watch", "list" ],
        "apiGroups" : [ "" ],
        "resources" : [ "pods" ]
    } ]
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

OK

For the description about error status codes, see Status Code.

Parent topic: Role