Jump to

• Request
• Response
• Examples

Policy Cache Diagnostics Information

get

/iam/access/diag/api/v1/policycache/status

Get information related to server policy cache diagnostics.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• verbose(optional): string
  Flag for returning detailed output

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body ()

Root Schema : PolicyDiagnosticsData

Type: object

Show Source

• clusterName(optional): string
  Name of cluster
• createTime(optional): string
  Create time
• isMaster: string
  Is Master
• isMDCEnabled: string
  Is MDC enabled
• lastPolicyUptakeTimeMillis: string
  Last policy cache uptake in milliseconds
• policyCacheCheckSum(optional): string
  Checksum of policy cache
• policyCacheUpdateStatus(optional): string
  Update status of policy cache
• policyCacheUpdateTime: string
  Update time of policy cache
• policyCacheVersion: string
  Version of policy cache
• serverIp: string
  IP Address of server
• serverName: string
  Name of server
• serverPort: string
  Port of server
• totalAppDomains: string
  Number of app domains
• totalAuthNPolicies: string
  Number of AuthN policies
• totalAuthZPolicies: string
  Number of AuthZ policies
• totalHostIds: string
  Number of Host IDs
• totalResources: string
  Number of resources
• totalTokenPolicies: string
  Number of token policies

{
    "type":"object",
    "properties":{
        "clusterName":{
            "type":"string",
            "description":"Name of cluster"
        },
        "serverName":{
            "type":"string",
            "description":"Name of server"
        },
        "serverIp":{
            "type":"string",
            "description":"IP Address of server"
        },
        "serverPort":{
            "type":"string",
            "description":"Port of server"
        },
        "isMDCEnabled":{
            "type":"string",
            "description":"Is MDC enabled"
        },
        "isMaster":{
            "type":"string",
            "description":"Is Master"
        },
        "createTime":{
            "type":"string",
            "description":"Create time"
        },
        "policyCacheUpdateTime":{
            "type":"string",
            "description":"Update time of policy cache"
        },
        "policyCacheUpdateStatus":{
            "type":"string",
            "description":"Update status of policy cache"
        },
        "policyCacheCheckSum":{
            "type":"string",
            "description":"Checksum of policy cache"
        },
        "policyCacheVersion":{
            "type":"string",
            "description":"Version of policy cache"
        },
        "totalAppDomains":{
            "type":"string",
            "description":"Number of app domains"
        },
        "totalAuthNPolicies":{
            "type":"string",
            "description":"Number of AuthN policies"
        },
        "totalAuthZPolicies":{
            "type":"string",
            "description":"Number of AuthZ policies"
        },
        "totalResources":{
            "type":"string",
            "description":"Number of resources"
        },
        "totalHostIds":{
            "type":"string",
            "description":"Number of Host IDs"
        },
        "totalTokenPolicies":{
            "type":"string",
            "description":"Number of token policies"
        },
        "lastPolicyUptakeTimeMillis":{
            "type":"string",
            "description":"Last policy cache uptake in milliseconds"
        }
    },
    "required":[
        "serverName",
        "serverIp",
        "serverPort",
        "isMDCEnabled",
        "isMaster",
        "policyCacheUpdateTime",
        "policyCacheVersion",
        "totalAppDomains",
        "totalAuthNPolicies",
        "totalAuthZPolicies",
        "totalResources",
        "totalHostIds",
        "totalTokenPolicies",
        "lastPolicyUptakeTimeMillis"
    ]
}

401 Response

Not authorized.

424 Response

Failed Dependency

Default Response

Unexpected error

Back to Top

Examples

cURL Example

This example demonstrates the ability to get information related to server policy cache diagnostics.

curl -X GET 'http://<host>:<port>/iam/access/diag/api/v1/policycache/status?verbose=true' -H 'authorization: Basic d2VibG9naWM6d2VibG9naWMx'

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"serverName": "oam_server1",
"serverIp": "*.*..**",
"serverPort": "14100",
"isMDCEnabled": false,
"isMaster": "false",
"policyCacheUpdateTime": "2018-05-03T21:25:29.137-07:00",
"policyCacheVersion": "2239",
"totalAppDomains": "2",
"totalAuthNPolicies": "18",
"totalAuthZPolicies": "5",
"totalResources": "93",
"totalHostIds": "1",
"totalTokenPolicies": "0",
"lastPolicyUptakeTimeMillis": "2996",
"applicationDomains": [
{ "domainName": "Fusion Apps Integration", "domainId": "f04c50a4-b985-49b0-b0ec-07b4bf183340" } 
,
{ "domainName": "IAM Suite", "domainId": "71554a18-ce54-4698-bc1d-18761a3afbf3" } 
]
}

Back to Top