REST Resources

/api/space/fabric-management/hprof-files

The following operations are supported on this resource:

  • GET - Get all HPROF file for Fabric Nodes
  • POST - to delete given Hprof Files
GET /hprof-files Version 3

Get all HPROF file for Fabric Nodes.

Sample Usage

GET /hprof-files


  • Sample Output XML:
    <fabric-hprof-files total="Integer" uri="/api/space/fabric-management/hprof-files">
         <fabric-hprof-file
               href="/api/space/fabric-management/hprof-files/{id}" uri="/api/space/fabric-management/hprof-files/{id}">
               <id>Integer</id>
               <file-path>String</file-path>
               <node-host-name>String</node-host-name>
               <node-name>String</node-name>
               <created-time>String</created-time>
               <management-ip>String</management-ip>
               <management-ipv6>String</management-ipv6>
         </fabric-hprof-file>
    </fabric-hprof-files>

  • Sample Output JSON:
    {
       "fabric-hprof-files" : {
         "@total" : "Integer" ,
         "@uri" : "/api/space/fabric-management/hprof-files" ,
         "fabric-hprof-file" : {
           "@href" : "/api/space/fabric-management/hprof-files/{id}" ,
           "@uri" : "/api/space/fabric-management/hprof-files/{id}" ,
           "id" : "Integer" ,
           "file-path" : "String" ,
           "node-host-name" : "String" ,
           "node-name" : "String" ,
           "created-time" : "String" ,
           "management-ip" : "String" ,
           "management-ipv6" : "String"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ViewHprofFiles

    POST /hprof-files Version 3

    to delete given Hprof Files.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /hprof-files?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <delete-hprof-files-request>
         <fabric-hprof-files>
               <fabric-hprof-file href="/api/space/fabric-management/hprof-files/{id}"/>
         </fabric-hprof-files>
    </delete-hprof-files-request>

  • Sample Input JSON:
    {
       "delete-hprof-files-request" : {
         "fabric-hprof-files" : {
           "fabric-hprof-file" : {
             "@href" : "/api/space/fabric-management/hprof-files/{id}"
           }
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: DeleteHprofFile