Apache Ranger Public REST APIs
Also available as:
PDF

Get Service Definition by ID

Reference information for the Ranger REST API service/public/v2/api/servicedef/{id}.

API Name Get Service Definition
Request Type GET
Request URL service/public/v2/api/servicedef/{id}
Request Params
Response
{
    "accessTypes": [
        {
            "impliedGrants": [],
            "itemId": 1,
            "label": "Read",
            "name": "read"
        },
        {
            "impliedGrants": [],
            "itemId": 2,
            "label": "Write",
            "name": "write"
        },
        {
            "impliedGrants": [],
            "itemId": 3,
            "label": "Execute",
            "name": "execute"
        }
    ],
    "configs": [
        {
            "itemId": 1,
            "label": "Username",
            "mandatory": true,
            "name": "username",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 2,
            "label": "Password",
            "mandatory": true,
            "name": "password",
            "subType": "",
            "type": "password",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 3,
            "label": "Namenode URL",
            "mandatory": true,
            "name": "fs.default.name",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "defaultValue": "false",
            "itemId": 4,
            "label": "Authorization Enabled",
            "mandatory": true,
            "name": "hadoop.security.authorization",
            "subType": "YesTrue:NoFalse",
            "type": "bool",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "defaultValue": "simple",
            "itemId": 5,
            "label": "Authentication Type",
            "mandatory": true,
            "name": "hadoop.security.authentication",
            "subType": "authnType",
            "type": "enum",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 6,
            "mandatory": false,
            "name": "hadoop.security.auth_to_local",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 7,
            "mandatory": false,
            "name": "dfs.datanode.kerberos.principal",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 8,
            "mandatory": false,
            "name": "dfs.namenode.kerberos.principal",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 9,
            "mandatory": false,
            "name": "dfs.secondary.namenode.kerberos.principal",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "defaultValue": "authentication",
            "itemId": 10,
            "label": "RPC Protection Type",
            "mandatory": false,
            "name": "hadoop.rpc.protection",
            "subType": "rpcProtection",
            "type": "enum",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 11,
            "label": "Common Name for Certificate",
            "mandatory": false,
            "name": "commonNameForCertificate",
            "subType": "",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        }
    ],
    "contextEnrichers": [],
    "createTime": 1450756476000,
    "description": "HDFS Repository",
    "enums": [
        {
            "defaultIndex": 0,
            "elements": [
                {
                    "itemId": 1,
                    "label": "Simple",
                    "name": "simple"
                },
                {
                    "itemId": 2,
                    "label": "Kerberos",
                    "name": "kerberos"
                }
            ],
            "itemId": 1,
            "name": "authnType"
        },
        {
            "defaultIndex": 0,
            "elements": [
                {
                    "itemId": 1,
                    "label": "Authentication",
                    "name": "authentication"
                },
                {
                    "itemId": 2,
                    "label": "Integrity",
                    "name": "integrity"
                },
                {
                    "itemId": 3,
                    "label": "Privacy",
                    "name": "privacy"
                }
            ],
            "itemId": 2,
            "name": "rpcProtection"
        }
    ],
    "guid": "0d047247-bafe-4cf8-8e9b-d5d377284b2d",
    "id": 1,
    "implClass": "org.apache.ranger.services.hdfs.RangerServiceHdfs",
    "isEnabled": true,
    "label": "HDFS Repository",
    "name": "hdfs",
    "options": {},
    "policyConditions": [],
    "resources": [
        {
            "description": "HDFS file or directory path",
            "excludesSupported": false,
            "itemId": 1,
            "label": "Resource Path",
            "level": 10,
            "lookupSupported": true,
            "mandatory": true,
            "matcher": "org.apache.ranger.plugin.resourcematcher.RangerPathResourceMatcher",
            "matcherOptions": {
                "ignoreCase": "false",
                "wildCard": "true"
            },
            "name": "path",
            "recursiveSupported": true,
            "type": "path",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        }
    ],
    "updateTime": 1450756477000,
    "version": 1
}