// removed jquery ui css and js

View Policies

Details

API Details
Name

Get Policies

DescriptionGet a list of policies that belong to user. The Submit Job API uses this API to add policies at run time.
MethodGET
URI

/v1/policies

CloudCenter Release

CloudCenter 3.x and 4.x

NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: get.policies

Example

curl -k -X GET -H "Accept: application/json" -u admin_5:40E45DBE57E35ECB https://<HOST>:<PORT>/v1/policies 

Response

{
    "policies": [
        {
            "id": "1",
            "resource": null,
            "perms": [
                "execute",
                "write",
                "delete",
                "read",
                "administration"
            ],
            "policyName": "1 Hour Aging Policy - No Cleanup",
            "policyType": "AGING_POLICY",
            "description": "1 Hour Aging Policy - No Cleanup",
            "policySubType": null
        },
        {
            "id": "2",
            "resource": null,
            "perms": [
                "execute",
                "write",
                "delete",
                "read",
                "administration"
            ],
            "policyName": "1 Hour Aging Policy - Cleanup",
            "policyType": "AGING_POLICY",
            "description": "1 Hour Aging Policy - Cleanup",
            "policySubType": null
        },
        {
            "id": "3",
            "resource": null,
            "perms": [
                "execute",
                "write",
                "delete",
                "read",
                "administration"
            ],
            "policyName": "Testing",
            "policyType": "SCALING_POLICY",
            "description": "Testing",
            "policySubType": "Elastic_Policy"
        }
    ],
    "size": 3
} 

Request Attributes

None.

Response Attributes

policies
  • Description: Identifies information for each policy
  • Type: Array of policies

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)
    policyName
    • Description: Name of the policy
    • Type: String
    policyType
    • Description: Type of policy
    • Type: String
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    policySubType
    • Description: Policy sub-type
    • Type: String