Merge branch 'doc/lsx/endpoint' into 'master'

docs(readme): add endpoint

See merge request iaasng/volcengine-python-sdk!568

Author: volc-sdk-team

FAQ.md

@@ -1,6 +1,8 @@
 ### 1. 获取请求和响应类型
+
 在方法调用前，通过 param 和 return 获取请求和响应对应的结构体  
 以 ecs.run_instances 为例
+
 ```python
 def run_instances(self, body, **kwargs):  # noqa: E501
     """run_instances
@@ -9,10 +11,11 @@ def run_instances(self, body, **kwargs):  # noqa: E501
     """
 ```
 
-
 ### 2. 获取请求和响应的参数类型
+
 在 Request 或者 Response 请求体中，通过 swagger_types 查看具体的请求参数和类型  
 以 volcenginesdkecs.RunInstancesRequest 为例，其参数名称和定义如下所示
+
 ```python
 swagger_types = {
     'auto_renew': 'bool',
@@ -25,7 +28,9 @@ swagger_types = {
     ......
 }
 ```
+
 对应的请求体为
+
 ```python
 volcenginesdkecs.RunInstancesRequest(
     instance_name="insname",
@@ -42,10 +47,13 @@ volcenginesdkecs.RunInstancesRequest(
     instance_charge_type="PostPaid"
 )
 ```
+
 ### 3. 出现内存溢出
+
 检查 Configuration._default 是否被初始化  
 如果没有初始化，每一次创建 Configuration 的时候，会创建新的 logger handler 并加入到全局的 logger 中  
 建议通过 Configuration.set_default 方法对 Configuration 进行赋值
+
 ```python
 configuration = volcenginesdkcore.Configuration()
 configuration.client_side_validation = False
@@ -56,7 +64,34 @@ volcenginesdkcore.Configuration.set_default(configuration)
 ```
 
 ### 4. 对象转 Dict
+
 对于请求和响应的对象，可以通过 to_dict() 方法将其转换成 dict 类型
 
 ### 5. 查看使用示例
+
 [volcenginesdkexamples](https://github.com/volcengine/volcengine-python-sdk/tree/master/volcenginesdkexamples)
+
+### 6. 响应对象转驼峰风格 Dict
+
+在实际调用 API 后，所接收的响应对象参数通常采用首字母大写的驼峰命名法。而在使用 Python SDK 进行编码时，由于 Python
+的整体命名规范为下划线命名法，当使用响应参数并对照文档时，您可能想要在 Python SDK 所采用的下划线命名法与文档中的驼峰命名法之间进行转换。
+
+当然，可通过调用以下代码将响应对象转换为驼峰格式的字典，转换后字典中的字段名与文档中的字段名完全一致
+
+```python
+import json
+import pprint
+from volcenginesdkcore.model import canonical_str
+
+try:
+    resp = api_instance.list_users(req)
+    pprint(resp)  # 字段为下划线的响应对象
+    dict_resp = json.loads(json.dumps(canonical_str(resp)))
+    pprint(dict_resp)  # 字段为驼峰的响应字典
+
+except ApiException as e:
+    print("Exception when calling IAMApi->ListUsers: %s\n" % e)
+
+```
+
+不过，这种方法并非推荐的使用方式。建议直接使用响应对象中以下划线命名的参数，而非进行上述转换后使用。 

README.md

@@ -11,6 +11,7 @@
 
 * Python版本需要不低于2.7。
 * 由于 Windows 系统有最长路径限制，可能会导致安装失败，请按照以下方式设置：
+
 ```
 1. 按下 Win+R ，输入 regedit 打开注册表编辑器。
 2. 设置 \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem 路径下的变量 LongPathsEnabled 为 1 即可。
@@ -19,6 +20,7 @@
 ### Install ###
 
 Install via pip
+
 ```sh
 pip install volcengine-python-sdk
 ```
@@ -31,7 +33,54 @@ python setup.py install --user
 
 (or `sudo python setup.py install` to install the package for all users)
 
-### Basic Usage ###
+### Configuration Usage ###
+
+步骤一：启动时初始化，配置 Configuration 全局默认参数
+
+```python
+configuration = volcenginesdkcore.Configuration()
+configuration.client_side_validation = True  # 客户端是否进行参数校验
+configuration.schema = "http"  # https or http
+configuration.debug = False  # 是否开启调试
+configuration.logger_file = "sdk.log"
+
+volcenginesdkcore.Configuration.set_default(configuration)
+```
+
+步骤二：获取 Client
+
+```python
+def get_client(ak, sk, region):
+    # 包含默认属性
+    configuration = volcenginesdkcore.Configuration()
+    configuration.ak = ak
+    configuration.sk = sk
+    configuration.region = region
+    client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))
+    return client
+```
+
+### Endpoint 设置 ###
+
+如果您要自定义SDK的Endpoint，可以按照以下示例代码设置：
+
+```python
+configuration = volcenginesdkcore.Configuration()
+configuration.host = 'ecs.cn-beijing-autodriving.volcengineapi.com'
+```
+
+火山引擎标准的Endpoint规则说明：
+
+| Regional 服务                                                                                                                            | Global 服务                                                                          |
+|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
+| `{service}.{region}.volcengineapi.com` <br> 例如：云服务ecs在cn-beijing-autodriving Region域名为： `ecs.cn-beijing-autodriving.volcengineapi.com` | `{service}.volcengineapi.com` <br> 例如：访问控制iam为Global服务，域名为：`iam.volcengineapi.com` |
+
+注：
+
+- Service中存在_符号时，Endpoint时需转为-符号。存在大写字母时需转成小写。
+- 并非所有云产品和Region都支持标准域名，具体请前往您所使用的产品-API参考中查看。
+
+### SDK 示例 ###
 
 ```python
 from __future__ import print_function
@@ -77,27 +126,7 @@ if __name__ == '__main__':
         print("Exception when calling ECSApi->run_instances: %s\n" % e)
 
 ```
-### Configuration Usage ###
-步骤一：启动时初始化，配置 Configuration 全局默认参数
-```python
-configuration = volcenginesdkcore.Configuration()
-configuration.client_side_validation = True  # 客户端是否进行参数校验
-configuration.schema = "http"  # https or http
-configuration.debug = False  # 是否开启调试
-configuration.logger_file = "sdk.log"
 
-volcenginesdkcore.Configuration.set_default(configuration)
-```
-步骤二：获取 Client
-```python
-def get_client(ak, sk, region):
-    # 包含默认属性
-    configuration = volcenginesdkcore.Configuration()
-    configuration.ak = ak
-    configuration.sk = sk
-    configuration.region = region
-    client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))
-    return client
-```
 ### FAQ ###
+
 关于 SDK 使用时碰到的常见问题，请查看 [FAQ](FAQ.md)