Skip to content

Commit c525700

Browse files
committed
Merge "integration_2025-04-28_881197335810" into "vod-Python-2025-01-01-online-1109-2025_04_15_14_41_25"
Conflicts: meta.json setup.py volcenginesdkcore/api_client.py volcenginesdkcore/configuration.py
2 parents 101eb26 + d2eadb7 commit c525700

File tree

790 files changed

+144724
-1684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

790 files changed

+144724
-1684
lines changed

FAQ.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
### 1. 获取请求和响应类型
2+
23
在方法调用前,通过 param 和 return 获取请求和响应对应的结构体
34
以 ecs.run_instances 为例
5+
46
```python
57
def run_instances(self, body, **kwargs): # noqa: E501
68
"""run_instances
@@ -9,10 +11,11 @@ def run_instances(self, body, **kwargs): # noqa: E501
911
"""
1012
```
1113

12-
1314
### 2. 获取请求和响应的参数类型
15+
1416
在 Request 或者 Response 请求体中,通过 swagger_types 查看具体的请求参数和类型
1517
以 volcenginesdkecs.RunInstancesRequest 为例,其参数名称和定义如下所示
18+
1619
```python
1720
swagger_types = {
1821
'auto_renew': 'bool',
@@ -25,7 +28,9 @@ swagger_types = {
2528
......
2629
}
2730
```
31+
2832
对应的请求体为
33+
2934
```python
3035
volcenginesdkecs.RunInstancesRequest(
3136
instance_name="insname",
@@ -42,10 +47,13 @@ volcenginesdkecs.RunInstancesRequest(
4247
instance_charge_type="PostPaid"
4348
)
4449
```
50+
4551
### 3. 出现内存溢出
52+
4653
检查 Configuration._default 是否被初始化
4754
如果没有初始化,每一次创建 Configuration 的时候,会创建新的 logger handler 并加入到全局的 logger 中
4855
建议通过 Configuration.set_default 方法对 Configuration 进行赋值
56+
4957
```python
5058
configuration = volcenginesdkcore.Configuration()
5159
configuration.client_side_validation = False
@@ -56,7 +64,34 @@ volcenginesdkcore.Configuration.set_default(configuration)
5664
```
5765

5866
### 4. 对象转 Dict
67+
5968
对于请求和响应的对象,可以通过 to_dict() 方法将其转换成 dict 类型
6069

6170
### 5. 查看使用示例
71+
6272
[volcenginesdkexamples](https://github.com/volcengine/volcengine-python-sdk/tree/master/volcenginesdkexamples)
73+
74+
### 6. 响应对象转驼峰风格 Dict
75+
76+
在实际调用 API 后,所接收的响应对象参数通常采用首字母大写的驼峰命名法。而在使用 Python SDK 进行编码时,由于 Python
77+
的整体命名规范为下划线命名法,当使用响应参数并对照文档时,您可能想要在 Python SDK 所采用的下划线命名法与文档中的驼峰命名法之间进行转换。
78+
79+
当然,可通过调用以下代码将响应对象转换为驼峰格式的字典,转换后字典中的字段名与文档中的字段名完全一致
80+
81+
```python
82+
import json
83+
import pprint
84+
from volcenginesdkcore.model import canonical_str
85+
86+
try:
87+
resp = api_instance.list_users(req)
88+
pprint(resp) # 字段为下划线的响应对象
89+
dict_resp = json.loads(json.dumps(canonical_str(resp)))
90+
pprint(dict_resp) # 字段为驼峰的响应字典
91+
92+
except ApiException as e:
93+
print("Exception when calling IAMApi->ListUsers: %s\n" % e)
94+
95+
```
96+
97+
不过,这种方法并非推荐的使用方式。建议直接使用响应对象中以下划线命名的参数,而非进行上述转换后使用。

README.md

Lines changed: 51 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
* Python版本需要不低于2.7。
1313
* 由于 Windows 系统有最长路径限制,可能会导致安装失败,请按照以下方式设置:
14+
1415
```
1516
1. 按下 Win+R ,输入 regedit 打开注册表编辑器。
1617
2. 设置 \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem 路径下的变量 LongPathsEnabled 为 1 即可。
@@ -19,6 +20,7 @@
1920
### Install ###
2021

2122
Install via pip
23+
2224
```sh
2325
pip install volcengine-python-sdk
2426
```
@@ -31,7 +33,54 @@ python setup.py install --user
3133

3234
(or `sudo python setup.py install` to install the package for all users)
3335

34-
### Basic Usage ###
36+
### Configuration Usage ###
37+
38+
步骤一:启动时初始化,配置 Configuration 全局默认参数
39+
40+
```python
41+
configuration = volcenginesdkcore.Configuration()
42+
configuration.client_side_validation = True # 客户端是否进行参数校验
43+
configuration.schema = "http" # https or http
44+
configuration.debug = False # 是否开启调试
45+
configuration.logger_file = "sdk.log"
46+
47+
volcenginesdkcore.Configuration.set_default(configuration)
48+
```
49+
50+
步骤二:获取 Client
51+
52+
```python
53+
def get_client(ak, sk, region):
54+
# 包含默认属性
55+
configuration = volcenginesdkcore.Configuration()
56+
configuration.ak = ak
57+
configuration.sk = sk
58+
configuration.region = region
59+
client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))
60+
return client
61+
```
62+
63+
### Endpoint 设置 ###
64+
65+
如果您要自定义SDK的Endpoint,可以按照以下示例代码设置:
66+
67+
```python
68+
configuration = volcenginesdkcore.Configuration()
69+
configuration.host = 'ecs.cn-beijing-autodriving.volcengineapi.com'
70+
```
71+
72+
火山引擎标准的Endpoint规则说明:
73+
74+
| Regional 服务 | Global 服务 |
75+
|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
76+
| `{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` |
77+
78+
注:
79+
80+
- Service中存在_符号时,Endpoint时需转为-符号。存在大写字母时需转成小写。
81+
- 并非所有云产品和Region都支持标准域名,具体请前往您所使用的产品-API参考中查看。
82+
83+
### SDK 示例 ###
3584

3685
```python
3786
from __future__ import print_function
@@ -77,27 +126,7 @@ if __name__ == '__main__':
77126
print("Exception when calling ECSApi->run_instances: %s\n" % e)
78127

79128
```
80-
### Configuration Usage ###
81-
步骤一:启动时初始化,配置 Configuration 全局默认参数
82-
```python
83-
configuration = volcenginesdkcore.Configuration()
84-
configuration.client_side_validation = True # 客户端是否进行参数校验
85-
configuration.schema = "http" # https or http
86-
configuration.debug = False # 是否开启调试
87-
configuration.logger_file = "sdk.log"
88129

89-
volcenginesdkcore.Configuration.set_default(configuration)
90-
```
91-
步骤二:获取 Client
92-
```python
93-
def get_client(ak, sk, region):
94-
# 包含默认属性
95-
configuration = volcenginesdkcore.Configuration()
96-
configuration.ak = ak
97-
configuration.sk = sk
98-
configuration.region = region
99-
client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))
100-
return client
101-
```
102130
### FAQ ###
131+
103132
关于 SDK 使用时碰到的常见问题,请查看 [FAQ](FAQ.md)

volcenginesdkalb/__init__.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@
9595
from volcenginesdkalb.models.describe_rules_response import DescribeRulesResponse
9696
from volcenginesdkalb.models.describe_server_group_attributes_request import DescribeServerGroupAttributesRequest
9797
from volcenginesdkalb.models.describe_server_group_attributes_response import DescribeServerGroupAttributesResponse
98+
from volcenginesdkalb.models.describe_server_group_backend_servers_request import DescribeServerGroupBackendServersRequest
99+
from volcenginesdkalb.models.describe_server_group_backend_servers_response import DescribeServerGroupBackendServersResponse
98100
from volcenginesdkalb.models.describe_server_groups_request import DescribeServerGroupsRequest
99101
from volcenginesdkalb.models.describe_server_groups_response import DescribeServerGroupsResponse
100102
from volcenginesdkalb.models.describe_zones_request import DescribeZonesRequest
@@ -133,6 +135,7 @@
133135
from volcenginesdkalb.models.health_check_template_for_create_health_check_templates_input import HealthCheckTemplateForCreateHealthCheckTemplatesInput
134136
from volcenginesdkalb.models.health_check_template_for_describe_health_check_templates_output import HealthCheckTemplateForDescribeHealthCheckTemplatesOutput
135137
from volcenginesdkalb.models.health_check_template_for_modify_health_check_templates_attributes_input import HealthCheckTemplateForModifyHealthCheckTemplatesAttributesInput
138+
from volcenginesdkalb.models.health_check_templates_tag_for_create_health_check_templates_input import HealthCheckTemplatesTagForCreateHealthCheckTemplatesInput
136139
from volcenginesdkalb.models.health_log_for_describe_load_balancer_attributes_output import HealthLogForDescribeLoadBalancerAttributesOutput
137140
from volcenginesdkalb.models.ipv6_eip_billing_config_for_clone_load_balancer_input import Ipv6EipBillingConfigForCloneLoadBalancerInput
138141
from volcenginesdkalb.models.ipv6_eip_billing_config_for_create_load_balancer_input import Ipv6EipBillingConfigForCreateLoadBalancerInput
@@ -195,6 +198,7 @@
195198
from volcenginesdkalb.models.rule_for_modify_rules_input import RuleForModifyRulesInput
196199
from volcenginesdkalb.models.server_for_add_server_group_backend_servers_input import ServerForAddServerGroupBackendServersInput
197200
from volcenginesdkalb.models.server_for_describe_server_group_attributes_output import ServerForDescribeServerGroupAttributesOutput
201+
from volcenginesdkalb.models.server_for_describe_server_group_backend_servers_output import ServerForDescribeServerGroupBackendServersOutput
198202
from volcenginesdkalb.models.server_for_modify_server_group_backend_servers_input import ServerForModifyServerGroupBackendServersInput
199203
from volcenginesdkalb.models.server_group_for_describe_listener_attributes_output import ServerGroupForDescribeListenerAttributesOutput
200204
from volcenginesdkalb.models.server_group_for_describe_listeners_output import ServerGroupForDescribeListenersOutput
@@ -205,20 +209,40 @@
205209
from volcenginesdkalb.models.sticky_session_config_for_describe_server_groups_output import StickySessionConfigForDescribeServerGroupsOutput
206210
from volcenginesdkalb.models.sticky_session_config_for_modify_server_group_attributes_input import StickySessionConfigForModifyServerGroupAttributesInput
207211
from volcenginesdkalb.models.tls_access_log_for_describe_load_balancer_attributes_output import TLSAccessLogForDescribeLoadBalancerAttributesOutput
212+
from volcenginesdkalb.models.tag_filter_for_describe_acls_input import TagFilterForDescribeAclsInput
213+
from volcenginesdkalb.models.tag_filter_for_describe_all_certificates_input import TagFilterForDescribeAllCertificatesInput
214+
from volcenginesdkalb.models.tag_filter_for_describe_ca_certificates_input import TagFilterForDescribeCACertificatesInput
215+
from volcenginesdkalb.models.tag_filter_for_describe_certificates_input import TagFilterForDescribeCertificatesInput
216+
from volcenginesdkalb.models.tag_filter_for_describe_customized_cfgs_input import TagFilterForDescribeCustomizedCfgsInput
217+
from volcenginesdkalb.models.tag_filter_for_describe_health_check_templates_input import TagFilterForDescribeHealthCheckTemplatesInput
208218
from volcenginesdkalb.models.tag_filter_for_describe_listeners_input import TagFilterForDescribeListenersInput
209219
from volcenginesdkalb.models.tag_filter_for_describe_load_balancers_input import TagFilterForDescribeLoadBalancersInput
210220
from volcenginesdkalb.models.tag_filter_for_describe_server_groups_input import TagFilterForDescribeServerGroupsInput
211221
from volcenginesdkalb.models.tag_filter_for_list_tags_for_resources_input import TagFilterForListTagsForResourcesInput
222+
from volcenginesdkalb.models.tag_for_create_acl_input import TagForCreateAclInput
223+
from volcenginesdkalb.models.tag_for_create_customized_cfg_input import TagForCreateCustomizedCfgInput
212224
from volcenginesdkalb.models.tag_for_create_listener_input import TagForCreateListenerInput
213225
from volcenginesdkalb.models.tag_for_create_load_balancer_input import TagForCreateLoadBalancerInput
214226
from volcenginesdkalb.models.tag_for_create_server_group_input import TagForCreateServerGroupInput
227+
from volcenginesdkalb.models.tag_for_describe_acl_attributes_output import TagForDescribeAclAttributesOutput
228+
from volcenginesdkalb.models.tag_for_describe_acls_output import TagForDescribeAclsOutput
229+
from volcenginesdkalb.models.tag_for_describe_all_certificates_output import TagForDescribeAllCertificatesOutput
230+
from volcenginesdkalb.models.tag_for_describe_ca_certificates_output import TagForDescribeCACertificatesOutput
231+
from volcenginesdkalb.models.tag_for_describe_certificates_output import TagForDescribeCertificatesOutput
232+
from volcenginesdkalb.models.tag_for_describe_customized_cfg_attributes_output import TagForDescribeCustomizedCfgAttributesOutput
233+
from volcenginesdkalb.models.tag_for_describe_customized_cfgs_output import TagForDescribeCustomizedCfgsOutput
234+
from volcenginesdkalb.models.tag_for_describe_health_check_templates_output import TagForDescribeHealthCheckTemplatesOutput
215235
from volcenginesdkalb.models.tag_for_describe_listener_attributes_output import TagForDescribeListenerAttributesOutput
216236
from volcenginesdkalb.models.tag_for_describe_listeners_output import TagForDescribeListenersOutput
217237
from volcenginesdkalb.models.tag_for_describe_load_balancer_attributes_output import TagForDescribeLoadBalancerAttributesOutput
218238
from volcenginesdkalb.models.tag_for_describe_load_balancers_output import TagForDescribeLoadBalancersOutput
219239
from volcenginesdkalb.models.tag_for_describe_server_group_attributes_output import TagForDescribeServerGroupAttributesOutput
220240
from volcenginesdkalb.models.tag_for_describe_server_groups_output import TagForDescribeServerGroupsOutput
241+
from volcenginesdkalb.models.tag_for_replace_ca_certificate_input import TagForReplaceCACertificateInput
242+
from volcenginesdkalb.models.tag_for_replace_certificate_input import TagForReplaceCertificateInput
221243
from volcenginesdkalb.models.tag_for_tag_resources_input import TagForTagResourcesInput
244+
from volcenginesdkalb.models.tag_for_upload_ca_certificate_input import TagForUploadCACertificateInput
245+
from volcenginesdkalb.models.tag_for_upload_certificate_input import TagForUploadCertificateInput
222246
from volcenginesdkalb.models.tag_resources_request import TagResourcesRequest
223247
from volcenginesdkalb.models.tag_resources_response import TagResourcesResponse
224248
from volcenginesdkalb.models.untag_resources_request import UntagResourcesRequest

volcenginesdkalb/api/alb_api.py

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3331,6 +3331,103 @@ def describe_server_group_attributes_with_http_info(self, body, **kwargs): # no
33313331
_request_timeout=params.get('_request_timeout'),
33323332
collection_formats=collection_formats)
33333333

3334+
def describe_server_group_backend_servers(self, body, **kwargs): # noqa: E501
3335+
"""describe_server_group_backend_servers # noqa: E501
3336+
3337+
This method makes a synchronous HTTP request by default. To make an
3338+
asynchronous HTTP request, please pass async_req=True
3339+
>>> thread = api.describe_server_group_backend_servers(body, async_req=True)
3340+
>>> result = thread.get()
3341+
3342+
:param async_req bool
3343+
:param DescribeServerGroupBackendServersRequest body: (required)
3344+
:return: DescribeServerGroupBackendServersResponse
3345+
If the method is called asynchronously,
3346+
returns the request thread.
3347+
"""
3348+
kwargs['_return_http_data_only'] = True
3349+
if kwargs.get('async_req'):
3350+
return self.describe_server_group_backend_servers_with_http_info(body, **kwargs) # noqa: E501
3351+
else:
3352+
(data) = self.describe_server_group_backend_servers_with_http_info(body, **kwargs) # noqa: E501
3353+
return data
3354+
3355+
def describe_server_group_backend_servers_with_http_info(self, body, **kwargs): # noqa: E501
3356+
"""describe_server_group_backend_servers # noqa: E501
3357+
3358+
This method makes a synchronous HTTP request by default. To make an
3359+
asynchronous HTTP request, please pass async_req=True
3360+
>>> thread = api.describe_server_group_backend_servers_with_http_info(body, async_req=True)
3361+
>>> result = thread.get()
3362+
3363+
:param async_req bool
3364+
:param DescribeServerGroupBackendServersRequest body: (required)
3365+
:return: DescribeServerGroupBackendServersResponse
3366+
If the method is called asynchronously,
3367+
returns the request thread.
3368+
"""
3369+
3370+
all_params = ['body'] # noqa: E501
3371+
all_params.append('async_req')
3372+
all_params.append('_return_http_data_only')
3373+
all_params.append('_preload_content')
3374+
all_params.append('_request_timeout')
3375+
3376+
params = locals()
3377+
for key, val in six.iteritems(params['kwargs']):
3378+
if key not in all_params:
3379+
raise TypeError(
3380+
"Got an unexpected keyword argument '%s'"
3381+
" to method describe_server_group_backend_servers" % key
3382+
)
3383+
params[key] = val
3384+
del params['kwargs']
3385+
# verify the required parameter 'body' is set
3386+
if self.api_client.client_side_validation and ('body' not in params or
3387+
params['body'] is None): # noqa: E501
3388+
raise ValueError("Missing the required parameter `body` when calling `describe_server_group_backend_servers`") # noqa: E501
3389+
3390+
collection_formats = {}
3391+
3392+
path_params = {}
3393+
3394+
query_params = []
3395+
3396+
header_params = {}
3397+
3398+
form_params = []
3399+
local_var_files = {}
3400+
3401+
body_params = None
3402+
if 'body' in params:
3403+
body_params = params['body']
3404+
# HTTP header `Accept`
3405+
header_params['Accept'] = self.api_client.select_header_accept(
3406+
['application/json']) # noqa: E501
3407+
3408+
# HTTP header `Content-Type`
3409+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
3410+
['text/plain']) # noqa: E501
3411+
3412+
# Authentication setting
3413+
auth_settings = ['volcengineSign'] # noqa: E501
3414+
3415+
return self.api_client.call_api(
3416+
'/DescribeServerGroupBackendServers/2020-04-01/alb/get/text_plain/', 'GET',
3417+
path_params,
3418+
query_params,
3419+
header_params,
3420+
body=body_params,
3421+
post_params=form_params,
3422+
files=local_var_files,
3423+
response_type='DescribeServerGroupBackendServersResponse', # noqa: E501
3424+
auth_settings=auth_settings,
3425+
async_req=params.get('async_req'),
3426+
_return_http_data_only=params.get('_return_http_data_only'),
3427+
_preload_content=params.get('_preload_content', True),
3428+
_request_timeout=params.get('_request_timeout'),
3429+
collection_formats=collection_formats)
3430+
33343431
def describe_server_groups(self, body, **kwargs): # noqa: E501
33353432
"""describe_server_groups # noqa: E501
33363433

0 commit comments

Comments
 (0)