Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
path | STRING | true | true | The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path. If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows: If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory. | |
relative-to | STRING | false | false | The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
unit | STRING | false | false | BYTES | Disk space unit to display disk usage. |
{
"used-space" => {
"type" => DOUBLE,
"description" => "The total size of the contents of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"unit" => "BYTES"
},
"creation-time" => {
"type" => STRING,
"description" => "The creation time of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"last-modified" => {
"type" => STRING,
"description" => "The last modified time of a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"resolved-path" => {
"type" => STRING,
"description" => "The resolved filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"available-space" => {
"type" => DOUBLE,
"description" => "The total size of available space for the partition containing a filesystem path.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"unit" => "BYTES"
}
}