release 3.0.5-beta source code for python

Author: Huaweicloud-SDK

CHANGELOG.md

@@ -1,3 +1,37 @@
+# __3.0.4-beta__ __2020-6-30__
+## __HuaweiCloud SDK Core__
+  - ### Features
+    - None
+  - ### Bug Fix
+    - None
+  - ### Change
+    - Use with_http_handler to replace with_enable_http_log to support users to customize the request log output in the troubleshooting scenario.
+
+## __HuaweiCloud SDK CTS__
+  - ### Features
+    - Support Cloud Trace Service.
+  - ### Bug Fix
+    - None
+  - ### Change
+    - None
+    
+## __HuaweiCloud SDK EVS__
+  - ### Features
+    - None
+  - ### Bug Fix
+    - None
+  - ### Change
+    - Support full service interface.
+
+## __HuaweiCloud SDK IoTDA__
+  - ### Features
+    - Support IoT Device Access Service.
+  - ### Bug Fix
+    - None
+  - ### Change
+    - None
+
+
 # __3.0.3-beta__ __2020-06-15__
 ## __HuaweiCloud SDK Core__
   - ### Features
@@ -9,7 +43,6 @@
   - ### Change
     - None
 
-# __3.0.3-beta__ __2020-06-15__
 ## __HuaweiCloud SDK DevStar__
   - ### Features
     - Support query template list.

CHANGELOG_CN.md

@@ -1,3 +1,37 @@
+# __3.0.4-beta__ __2020-06-30__
+## __HuaweiCloud SDK Core__
+  - ### 新增特性
+    - 无
+  - ### 解决问题
+    - 无
+  - ### 特性变更
+    - 使用with_http_handler替代原有的with_enable_http_log开关，支持用户在问题定位场景自定义请求日志输出。
+    
+## __HuaweiCloud SDK CTS__
+ - ### 新增特性
+    - 支持云审计服务。
+ - ### 解决问题
+    - 无
+ - ### 特性变更
+    - 无
+     
+## __HuaweiCloud SDK EVS__
+ - ### 新增特性
+    - 无
+ - ### 解决问题
+    - 无
+ - ### 特性变更
+    - 支持全量服务接口。
+            
+## __HuaweiCloud SDK IoTDA__
+ - ### 新增特性
+    - 支持设备接入服务。
+ - ### 解决问题
+    - 无
+ - ### 特性变更
+    - 无
+    
+
 # __3.0.3-beta__ __2020-06-15__
 ## __HuaweiCloud SDK Core__
   - ### 新增特性
@@ -9,7 +43,6 @@
   - ### 特性变更
     - 无
 
-# __3.0.3-beta__ __2020-06-15__
 ## __HuaweiCloud SDK DevStar__
   - ### 新增特性
     - 支持查询模板列表。

README.md

@@ -118,7 +118,6 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
         .with_endpoint(endpoint) \
         .with_file_log(path="test.log", log_level=logging.INFO) \  # Write log files
         .with_stream_log(log_level=logging.INFO) \                 # Write log to console
-        .with_enable_http_log(True) \                              # log whole http request and response
         .build()
     ```
 
@@ -134,8 +133,11 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
         - `stream`: stream object, default is sys.stdout.
         - `log_level`: log level, default is INFO.
 
-    **Warning**
-    - `with_enable_http_log`: We recommend you only use this for debugging purposes. Disable it in your production environments, as it records the whole request and response data, which may contains sensitive data, and it could be very large.
+    After enabled log, the SDK will print the access log by default, every request will be recorded in console like: '%(asctime)s %(thread)d %(name)s %(filename)s %(lineno)d %(levelname)s %(message)s'
+
+    ```shell script
+    2020-06-16 10:44:02,019 4568 HuaweiCloud-SDK http_handler.py 28 INFO "GET https://vpc.cn-north-1.myhuaweicloud.com/v1/0904f9e1f100d2932f94c01f9aa1cfd7/vpcs" 200 11 0:00:00.543430 b5c927ffdab8401e772e70aa49972037
+    ```
 
 5. Send a request and print response.
 
@@ -185,6 +187,47 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
     print(response.result())
     ```
 
+8. Troubleshooting
+
+    In some situation, you may need to debug your http requests, original http request and response information will be needed. The SDK provides a listener function to obtain the original encrypted http request and response information.
+
+    **Warning:** The original http log can only be used in troubleshooting scenarios, please do not print the original http header or body in the production environment. The log content is not encrypted and may contain sensitive information such as the password of your ECS or the password of your IAM user account, etc. When the response body is binary content, the body will be printed as "***" without detailed information.
+
+    ```python
+    def response_handler(**kwargs):
+        logger = kwargs.get("logger")
+        response = kwargs.get("response")
+        request = response.request
+
+        base = "> Request %s %s HTTP/1.1" % (request.method, request.path_url) + "\n"
+        if len(request.headers) != 0:
+            base = base + "> Headers:" + "\n"
+            for each in request.headers:
+                base = base + "    %s : %s" % (each, request.headers[each]) + "\n"
+        base = base + "> Body: %s" % request.body + "\n\n"
+
+        base = base + "< Response HTTP/1.1 %s " % response.status_code + "\n"
+        if len(response.headers) != 0:
+            base = base + "< Headers:" + "\n"
+            for each in response.headers:
+                base = base + "    %s : %s" % (each, response.headers[each],) + "\n"
+        base = base + "< Body: %s" % response.content
+        logger.debug(base)
+    
+    client = VpcClient.new_builder(VpcClient) \
+        .with_http_config(config) \
+        .with_credentials(credentials) \
+        .with_endpoint(endpoint) \
+        .with_file_log(path="test.log", log_level=logging.INFO) \
+        .with_stream_log(log_level=logging.INFO) \
+        .with_http_handler(HttpHandler().add_response_handler(response_handler)) \
+        .build()
+    ```
+
+	**where:**
+
+    HttpHandler supports add_request_handler and add_response_handler.
+
 ## Code example
 
 The following example shows how to query a list of VPC in a specific region. Substitute the values for `{your ak string}`, `{your sk string}`, `{your endpoint}` and `{your project id}`.

README_CN.md

@@ -121,7 +121,6 @@
         .with_endpoint(endpoint) \
         .with_file_log(path="test.log", log_level=logging.INFO) \  # 日志打印至文件
         .with_stream_log(log_level=logging.INFO) \                 # 日志打印至控制台
-        .with_enable_http_log(True) \                              # 打开HTTP请求日志
         .build()
     ```
 
@@ -136,9 +135,12 @@
     - `with_stream_log` 支持如下配置：
         - `stream`: 流对象，默认sys.stdout。
         - `log_level`: 日志级别，默认INFO。
-    
-    **注意：**
-    - `with_enable_http_log`: http日志仅用于开发场景下的问题定位，生产环境不推荐打开此功能。由于此功能会打印详细的请求以及相应信息，可能包含敏感信息，同时可能导致日志文件过大。
+
+    打开日志开关后，每次请求将打印访问日志，格式如下：'%(asctime)s %(thread)d %(name)s %(filename)s %(lineno)d %(levelname)s %(message)s'
+
+    ```shell script
+    2020-06-16 10:44:02,019 4568 HuaweiCloud-SDK http_handler.py 28 INFO "GET https://vpc.cn-north-1.myhuaweicloud.com/v1/0904f9e1f100d2932f94c01f9aa1cfd7/vpcs" 200 11 0:00:00.543430 b5c927ffdab8401e772e70aa49972037
+    ```
 
 5. 发送请求并查看响应.
 
@@ -158,7 +160,7 @@
     | | | RetryOutageException | 在重试策略消耗完成已后，仍无有效的响应 |
     | ServiceResponseException | 服务器响应异常 | ServerResponseException | 服务端内部错误，Http响应码：[500,] |
     | | | ClientRequestException | 请求参数不合法，Http响应码：[400， 500) |
-    
+
     ```python
     # 异常处理
     try:
@@ -188,6 +190,48 @@
     print(response.result())
     ```
 
+8. 问题定位
+
+    在某些场景下可能对业务发出的Http请求进行Debug，需要看到原始的Http请求和返回信息，SDK提供侦听器功能来获取原始的为加密的Http请求和返回信息。
+
+    **注意：** 原始信息打印仅在debug阶段使用，请不要在生产系统中将原始的Http头和Body信息打印到日志，这些信息并未加密且其中包含敏感数据，例如所创建虚拟机的密码，IAM用户的密码等;
+    当Body体为二进制内容,即Content-Type标识为二进制时 body为"***",详细内容不输出。
+
+    ```python
+    def response_handler(**kwargs):
+        logger = kwargs.get("logger")
+        response = kwargs.get("response")
+        request = response.request
+
+        base = "> Request %s %s HTTP/1.1" % (request.method, request.path_url) + "\n"
+        if len(request.headers) != 0:
+            base = base + "> Headers:" + "\n"
+            for each in request.headers:
+                base = base + "    %s : %s" % (each, request.headers[each]) + "\n"
+        base = base + "> Body: %s" % request.body + "\n\n"
+
+        base = base + "< Response HTTP/1.1 %s " % response.status_code + "\n"
+        if len(response.headers) != 0:
+            base = base + "< Headers:" + "\n"
+            for each in response.headers:
+                base = base + "    %s : %s" % (each, response.headers[each],) + "\n"
+        base = base + "< Body: %s" % response.content
+        logger.debug(base)
+    
+    client = VpcClient.new_builder(VpcClient) \
+        .with_http_config(config) \
+        .with_credentials(credentials) \
+        .with_endpoint(endpoint) \
+        .with_file_log(path="test.log", log_level=logging.INFO) \
+        .with_stream_log(log_level=logging.INFO) \
+        .with_http_handler(HttpHandler().add_response_handler(response_handler)) \
+        .build()
+    ```
+
+   	**说明:**
+
+    HttpHandler支持如下方法add_request_handler、add_response_handler。
+
 ## 代码实例
 
 使用如下代码同步查询特定Region下的VPC清单，调用前请根据实际情况替换如下变量：`{your ak string}`、 `{your sk string}`、 `{your endpoint}` 以及 `{your project id}`。

README_PYPI.md

@@ -116,7 +116,6 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
         .with_endpoint(endpoint) \
         .with_file_log(path="test.log", log_level=logging.INFO) \  # Write log files
         .with_stream_log(log_level=logging.INFO) \                 # Write log to console
-        .with_enable_http_log(True) \                              # log whole http request and response
         .build()
     ```
 
@@ -131,9 +130,12 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
     - `with_stream_log`:
         - `stream`: stream object, default is sys.stdout.
         - `log_level`: log level, default is INFO.
-    
-    **Warning**
-    - `with_enable_http_log`: We recommend you only use this for debugging purposes. Disable it in your production environments, as it records the whole request and response data, which may contains sensitive data, and it could be very large.
+
+    After enabled log, the SDK will print the access log by default, every request will be recorded in console like: '%(asctime)s %(thread)d %(name)s %(filename)s %(lineno)d %(levelname)s %(message)s'
+
+    ```shell script
+    2020-06-16 10:44:02,019 4568 HuaweiCloud-SDK http_handler.py 28 INFO "GET https://vpc.cn-north-1.myhuaweicloud.com/v1/0904f9e1f100d2932f94c01f9aa1cfd7/vpcs" 200 11 0:00:00.543430 b5c927ffdab8401e772e70aa49972037
+    ```
 
 5. Send a request and print response.
 
@@ -181,3 +183,44 @@ HuaweiCloud Python SDK supports Python 3 or later. Run ``python --version`` to c
     # get asynchronous response
     print(response.result())
     ```
+
+8. Troubleshooting
+
+    In some situation, you may need to debug your http requests, original http request and response information will be needed. The SDK provides a listener function to obtain the original encrypted http request and response information.
+
+    **Warning:** The original http log can only be used in troubleshooting scenarios, please do not print the original http header or body in the production environment. The log content is not encrypted and may contain sensitive information such as the password of your ECS or the password of your IAM user account, etc. When the response body is binary content, the body will be printed as "***" without detailed information.
+
+    ```python
+    def response_handler(**kwargs):
+        logger = kwargs.get("logger")
+        response = kwargs.get("response")
+        request = response.request
+
+        base = "> Request %s %s HTTP/1.1" % (request.method, request.path_url) + "\n"
+        if len(request.headers) != 0:
+            base = base + "> Headers:" + "\n"
+            for each in request.headers:
+                base = base + "    %s : %s" % (each, request.headers[each]) + "\n"
+        base = base + "> Body: %s" % request.body + "\n\n"
+
+        base = base + "< Response HTTP/1.1 %s " % response.status_code + "\n"
+        if len(response.headers) != 0:
+            base = base + "< Headers:" + "\n"
+            for each in response.headers:
+                base = base + "    %s : %s" % (each, response.headers[each],) + "\n"
+        base = base + "< Body: %s" % response.content
+        logger.debug(base)
+    
+    client = {Service}Client.new_builder({Service}Client) \
+        .with_http_config(config) \
+        .with_credentials(credentials) \
+        .with_endpoint(endpoint) \
+        .with_file_log(path="test.log", log_level=logging.INFO) \
+        .with_stream_log(log_level=logging.INFO) \
+        .with_http_handler(HttpHandler().add_response_handler(response_handler)) \
+        .build()
+    ```
+
+	**where:**
+
+    HttpHandler supports add_request_handler and add_response_handler.

examples/IoTDA/V5/BatchTask.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+from huaweicloudsdkcore.http.http_config import HttpConfig
+from huaweicloudsdkcore.auth.credentials import BasicCredentials
+from huaweicloudsdkcore.exceptions import exceptions
+from huaweicloudsdkiotda.v5 import *
+
+
+def createBatchTask(client):
+    try:
+        app_id = "vWT2abBX135ioL_D028b7NRYJfYa"
+        document = {
+            "package_id": "24381244be486f8b3a89ad07"
+        }
+        targets = [
+            "5e19ca2b16b09003ca4dbd98_test003"
+        ]
+        task_name = "BatchCommandTask"
+        task_type = "softwareUpgrade"
+        body = CreateBatchTask(app_id=app_id, document=document, targets=targets, task_name=task_name,
+                               task_type=task_type)
+        request = CreateBatchTaskRequest(body=body)
+        response = client.create_batch_task(request)
+        print(response)
+    except exceptions.ClientRequestException as e:
+        print(e.status_code)
+        print(e.request_id)
+        print(e.error_code)
+        print(e.error_msg)
+
+
+def queryBatchTask(client):
+    try:
+        request = ShowBatchTaskRequest(taskId="5ea53331251c3e02075b1499")
+        response = client.show_batch_task(request)
+        print(response)
+    except exceptions.ClientRequestException as e:
+        print(e.status_code)
+        print(e.request_id)
+        print(e.error_code)
+        print(e.error_msg)
+
+
+def queryBatchTasks(client):
+    try:
+        request = ListBatchTasksRequest(task_type="softwareUpgrade", marker="ffffffffffffffffffffffff")
+        response = client.list_batch_tasks(request)
+        print(response)
+    except exceptions.ClientRequestException as e:
+        print(e.status_code)
+        print(e.request_id)
+        print(e.error_code)
+        print(e.error_msg)
+
+
+if __name__ == '__main__':
+    ak = "{your ak string}"
+    sk = "{your sk string}"
+    endpoint = "{your endpoint}"
+    project_id = "{your project id}"
+
+    config = HttpConfig.get_default_config()
+    config.ignore_ssl_verification = True
+    credentials = BasicCredentials(ak, sk, project_id)
+
+    iotda_client = IoTDAClient().new_builder(IoTDAClient) \
+        .with_http_config(config) \
+        .with_credentials(credentials) \
+        .with_endpoint(endpoint) \
+        .build()
+
+    createBatchTask(iotda_client)
+    queryBatchTask(iotda_client)
+    queryBatchTasks(iotda_client)