Skip to content

HDFS-16951. Add description of GETSERVERDEFAULTS to WebHDFS doc #5491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 1, 2023
Merged

HDFS-16951. Add description of GETSERVERDEFAULTS to WebHDFS doc #5491

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0ff57e
HDFS-16951. Add description of GETSERVERDEFAULTS to WebHDFS doc
zhtttylz Mar 16, 2023
24ffeaf
Fix CheckStyle.
zhtttylz Mar 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/WebHDFS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ The HTTP REST API supports the complete [FileSystem](../../api/org/apache/hadoop
* [`GETSNAPSHOTLIST`](#Get_Snapshot_List)
* [`GETFILEBLOCKLOCATIONS`](#Get_File_Block_Locations) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).getFileBlockLocations)
* [`GETECPOLICY`](#Get_EC_Policy) (see [HDFSErasureCoding](./HDFSErasureCoding.html#Administrative_commands).getErasureCodingPolicy)
* [`GETSERVERDEFAULTS`](#Get_Server_Defaults) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).getServerDefaults)
* HTTP PUT
* [`CREATE`](#Create_and_Write_to_a_File) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).create)
* [`MKDIRS`](#Make_a_Directory) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).mkdirs)
Expand Down Expand Up @@ -1109,6 +1110,35 @@ See also: [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).getAclSta

See also: [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).access

### Get Server Defaults

* Submit a HTTP GET request.

curl -i "http://<HOST>:<PORT>/webhdfs/v1/<PATH>?op=GETSERVERDEFAULTS"

The client receives a response with a [`ServerDefaults` JSON object](Server_Defaults_JSON_Schema):

HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked

{
"FsServerDefaults": {
"replication": 3,
"encryptDataTransfer": "false",
"defaultStoragePolicyId":7,
"writePacketSize": 65536,
"fileBufferSize": 4096,
"checksumType": 2,
"trashInterval": 10080,
"keyProviderUri": "",
"blockSize": 134217728,
"bytesPerChecksum": 512
}
}

See also: [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).getServerDefaults

Storage Policy Operations
-------------------------

Expand Down Expand Up @@ -3042,6 +3072,24 @@ var blockLocationProperties =
}
};
```
### Server Defaults JSON Schema

```json
{
"FsServerDefaults": {
"replication": 3,
"encryptDataTransfer": false,
"defaultStoragePolicyId": 7,
"writePacketSize": 65536,
"fileBufferSize": 4096,
"checksumType": 2,
"trashInterval": 10080,
"keyProviderUri": "",
"blockSize": 134217728,
"bytesPerChecksum": 512
}
}
```

HTTP Query Parameter Dictionary
-------------------------------
Expand Down