Apache Ranger Public REST APIs
Also available as:
PDF

Get Service Definition by Name

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

API Name Get Service Definition
Request Type GET
Request URL service/public/v2/api/servicedef/name/{name}
Request Params
Response
{
    "accessTypes": [
        {
            "impliedGrants": [],
            "itemId": 1,
            "label": "select",
            "name": "select"
        },
        {
            "impliedGrants": [],
            "itemId": 2,
            "label": "update",
            "name": "update"
        },
        {
            "impliedGrants": [],
            "itemId": 3,
            "label": "Create",
            "name": "create"
        },
        {
            "impliedGrants": [],
            "itemId": 4,
            "label": "Drop",
            "name": "drop"
        },
        {
            "impliedGrants": [],
            "itemId": 5,
            "label": "Alter",
            "name": "alter"
        },
        {
            "impliedGrants": [],
            "itemId": 6,
            "label": "Index",
            "name": "index"
        },
        {
            "impliedGrants": [],
            "itemId": 7,
            "label": "Lock",
            "name": "lock"
        },
        {
            "impliedGrants": [
                "select",
                "update",
                "create",
                "drop",
                "alter",
                "index",
                "lock"
            ],
            "itemId": 8,
            "label": "All",
            "name": "all"
        }
    ],
    "configs": [
        {
            "itemId": 1,
            "label": "Username",
            "mandatory": true,
            "name": "username",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 2,
            "label": "Password",
            "mandatory": true,
            "name": "password",
            "type": "password",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "defaultValue": "org.apache.hive.jdbc.HiveDriver",
            "itemId": 3,
            "mandatory": true,
            "name": "jdbc.driverClassName",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "defaultValue": "",
            "itemId": 4,
            "mandatory": true,
            "name": "jdbc.url",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "itemId": 5,
            "label": "Common Name for Certificate",
            "mandatory": false,
            "name": "commonNameForCertificate",
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        }
    ],
    "contextEnrichers": [],
    "createTime": 1450756479000,
    "description": "Hive Server2",
    "enums": [],
    "guid": "3e1afb5a-184a-4e82-9d9c-87a5cacc243c",
    "id": 3,
    "implClass": "org.apache.ranger.services.hive.RangerServiceHive",
    "isEnabled": true,
    "label": "Hive Server2",
    "name": "hive",
    "options": {},
    "policyConditions": [
        {
            "description": "List of Hive resources",
            "evaluator": "org.apache.ranger.plugin.conditionevaluator.RangerHiveResourcesAccessedTogetherCondition",
            "evaluatorOptions": {},
            "itemId": 1,
            "label": "Hive Resources Accessed Together?",
            "name": "resources-accessed-together"
        }
    ],
    "resources": [
        {
            "description": "Hive Database",
            "excludesSupported": true,
            "itemId": 1,
            "label": "Hive Database",
            "level": 10,
            "lookupSupported": true,
            "mandatory": true,
            "matcher": "org.apache.ranger.plugin.resourcematcher.RangerDefaultResourceMatcher",
            "matcherOptions": {
                "ignoreCase": "true",
                "wildCard": "true"
            },
            "name": "database",
            "recursiveSupported": false,
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "description": "Hive Table",
            "excludesSupported": true,
            "itemId": 2,
            "label": "Hive Table",
            "level": 20,
            "lookupSupported": true,
            "mandatory": true,
            "matcher": "org.apache.ranger.plugin.resourcematcher.RangerDefaultResourceMatcher",
            "matcherOptions": {
                "ignoreCase": "true",
                "wildCard": "true"
            },
            "name": "table",
            "parent": "database",
            "recursiveSupported": false,
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "description": "Hive UDF",
            "excludesSupported": true,
            "itemId": 3,
            "label": "Hive UDF",
            "level": 20,
            "lookupSupported": true,
            "mandatory": true,
            "matcher": "org.apache.ranger.plugin.resourcematcher.RangerDefaultResourceMatcher",
            "matcherOptions": {
                "ignoreCase": "true",
                "wildCard": "true"
            },
            "name": "udf",
            "parent": "database",
            "recursiveSupported": false,
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        },
        {
            "description": "Hive Column",
            "excludesSupported": true,
            "itemId": 4,
            "label": "Hive Column",
            "level": 30,
            "lookupSupported": true,
            "mandatory": true,
            "matcher": "org.apache.ranger.plugin.resourcematcher.RangerDefaultResourceMatcher",
            "matcherOptions": {
                "ignoreCase": "true",
                "wildCard": "true"
            },
            "name": "column",
            "parent": "table",
            "recursiveSupported": false,
            "type": "string",
            "uiHint": "",
            "validationMessage": "",
            "validationRegEx": ""
        }
    ],
    "updateTime": 1450756479000,
    "version": 1
}