From 0e36e935d909862401890d0a5410204504f48b31 Mon Sep 17 00:00:00 2001 From: Yiqun Lin Date: Fri, 30 Nov 2018 11:31:34 +0800 Subject: [PATCH] HDFS-13870. WebHDFS: Document ALLOWSNAPSHOT and DISALLOWSNAPSHOT API doc. Contributed by Siyao Meng. --- .../hadoop-hdfs/src/site/markdown/WebHDFS.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/WebHDFS.md b/hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/WebHDFS.md index 383eda09b1..8661659ea4 100644 --- a/hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/WebHDFS.md +++ b/hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/WebHDFS.md @@ -64,6 +64,8 @@ The HTTP REST API supports the complete [FileSystem](../../api/org/apache/hadoop * [`SETTIMES`](#Set_Access_or_Modification_Time) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).setTimes) * [`RENEWDELEGATIONTOKEN`](#Renew_Delegation_Token) (see [DelegationTokenAuthenticator](../../api/org/apache/hadoop/security/token/delegation/web/DelegationTokenAuthenticator.html).renewDelegationToken) * [`CANCELDELEGATIONTOKEN`](#Cancel_Delegation_Token) (see [DelegationTokenAuthenticator](../../api/org/apache/hadoop/security/token/delegation/web/DelegationTokenAuthenticator.html).cancelDelegationToken) + * [`ALLOWSNAPSHOT`](#Allow_Snapshot) + * [`DISALLOWSNAPSHOT`](#Disallow_Snapshot) * [`CREATESNAPSHOT`](#Create_Snapshot) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).createSnapshot) * [`RENAMESNAPSHOT`](#Rename_Snapshot) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).renameSnapshot) * [`SETXATTR`](#Set_XAttr) (see [FileSystem](../../api/org/apache/hadoop/fs/FileSystem.html).setXAttr) @@ -1302,6 +1304,28 @@ See also: [HDFSErasureCoding](./HDFSErasureCoding.html#Administrative_commands). Snapshot Operations ------------------- +### Allow Snapshot + +* Submit a HTTP PUT request. + + curl -i -X PUT "http://:/webhdfs/v1/?op=ALLOWSNAPSHOT" + + The client receives a response with zero content length on success: + + HTTP/1.1 200 OK + Content-Length: 0 + +### Disallow Snapshot + +* Submit a HTTP PUT request. + + curl -i -X PUT "http://:/webhdfs/v1/?op=DISALLOWSNAPSHOT" + + The client receives a response with zero content length on success: + + HTTP/1.1 200 OK + Content-Length: 0 + ### Create Snapshot * Submit a HTTP PUT request.