add more doc info for file based input

aliyun · Dec 18, 2017 · 5661e7e · 5661e7e
1 parent 6872d38
commit 5661e7e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -136,6 +136,22 @@ You could store the content of one parameter into a file and pass it via the com
 > aliyun log get_logs --request="file://./get_logs.json"
 ```
 
+
+the content in file `get_logs.json` as below. Note: the `\` is unnecessary to escape the ".
+```json
+{
+  "topic": "",
+  "logstore": "logstore1",
+  "project": "project1",
+  "toTime": "12345679",
+  "offset": "0",
+  "query": "*",
+  "line": "10",
+  "fromTime": "1234567",
+  "reverse": "true"
+}
+```
+
 **Parameter Validation**
 
 - Mandatory check: if one mandatory parameter is missed, it will report error with usage info.

diff --git a/README_CN.md b/README_CN.md
@@ -143,6 +143,23 @@ endpoint=cn-hangzhou.log.aliyun.com
 > aliyun log get_logs --request="file://./get_logs.json"
 ```
 
+
+文件`get_logs.json`内容如下, 注意: 文件中不需要反斜杠`\`来转义.
+
+```json
+{
+  "topic": "",
+  "logstore": "logstore1",
+  "project": "project1",
+  "toTime": "12345679",
+  "offset": "0",
+  "query": "*",
+  "line": "10",
+  "fromTime": "1234567",
+  "reverse": "true"
+}
+```
+
 **参数校验**
 
 - 必填的参数没有填写时会报错, 输出参数列表