gcore 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of gcore might be problematic. Click here for more details.
- gcore/_base_client.py +22 -2
- gcore/_models.py +2 -0
- gcore/_types.py +2 -0
- gcore/_version.py +1 -1
- gcore/resources/cloud/baremetal/flavors.py +2 -2
- gcore/resources/cloud/baremetal/images.py +2 -2
- gcore/resources/cloud/baremetal/servers.py +46 -52
- gcore/resources/cloud/floating_ips.py +4 -4
- gcore/resources/cloud/gpu_baremetal_clusters/gpu_baremetal_clusters.py +8 -8
- gcore/resources/cloud/gpu_baremetal_clusters/images.py +2 -2
- gcore/resources/cloud/gpu_baremetal_clusters/servers.py +4 -4
- gcore/resources/cloud/inference/deployments/deployments.py +6 -6
- gcore/resources/cloud/instances/flavors.py +2 -2
- gcore/resources/cloud/instances/images.py +2 -2
- gcore/resources/cloud/instances/instances.py +62 -70
- gcore/resources/cloud/instances/interfaces.py +4 -4
- gcore/resources/cloud/load_balancers/flavors.py +2 -2
- gcore/resources/cloud/load_balancers/l7_policies/l7_policies.py +20 -20
- gcore/resources/cloud/load_balancers/listeners.py +14 -14
- gcore/resources/cloud/load_balancers/load_balancers.py +28 -24
- gcore/resources/cloud/load_balancers/pools/members.py +6 -6
- gcore/resources/cloud/networks/networks.py +4 -4
- gcore/resources/cloud/networks/subnets.py +6 -6
- gcore/resources/cloud/registries/registries.py +6 -10
- gcore/resources/cloud/registries/users.py +4 -10
- gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py +10 -10
- gcore/resources/cloud/security_groups/security_groups.py +2 -2
- gcore/resources/cloud/ssh_keys.py +2 -2
- gcore/resources/cloud/tasks.py +98 -90
- gcore/resources/cloud/users/role_assignments.py +4 -4
- gcore/resources/cloud/volumes.py +18 -18
- gcore/resources/waap/__init__.py +98 -0
- gcore/resources/waap/advanced_rules.py +135 -0
- gcore/resources/waap/clients.py +135 -0
- gcore/resources/waap/custom_page_sets.py +805 -0
- gcore/resources/waap/domains/__init__.py +140 -0
- gcore/resources/waap/domains/advanced_rules.py +876 -0
- gcore/resources/waap/domains/analytics/__init__.py +33 -0
- gcore/resources/waap/domains/analytics/analytics.py +676 -0
- gcore/resources/waap/domains/analytics/requests.py +378 -0
- gcore/resources/waap/domains/api_discovery/__init__.py +33 -0
- gcore/resources/waap/domains/api_discovery/api_discovery.py +530 -0
- gcore/resources/waap/domains/api_discovery/scan_results.py +352 -0
- gcore/resources/waap/domains/api_path_groups.py +163 -0
- gcore/resources/waap/domains/api_paths.py +771 -0
- gcore/resources/waap/domains/custom_rules.py +889 -0
- gcore/resources/waap/domains/domains.py +399 -0
- gcore/resources/waap/domains/firewall_rules.py +884 -0
- gcore/resources/waap/domains/insight_silences.py +689 -0
- gcore/resources/waap/domains/insights.py +425 -0
- gcore/resources/waap/domains/policies.py +173 -0
- gcore/resources/waap/domains/settings.py +5 -5
- gcore/resources/waap/ip_info.py +1017 -0
- gcore/resources/waap/organizations.py +217 -0
- gcore/resources/waap/statistics.py +225 -0
- gcore/resources/waap/tags.py +233 -0
- gcore/resources/waap/waap.py +289 -0
- gcore/types/cloud/allowed_address_pairs.py +2 -2
- gcore/types/cloud/baremetal/baremetal_server.py +1 -1
- gcore/types/cloud/baremetal/image_list_params.py +1 -1
- gcore/types/cloud/baremetal/server_create_params.py +9 -9
- gcore/types/cloud/baremetal/server_list_params.py +8 -8
- gcore/types/cloud/baremetal/server_rebuild_params.py +1 -1
- gcore/types/cloud/baremetal_flavor.py +3 -3
- gcore/types/cloud/container_probe_config.py +1 -1
- gcore/types/cloud/container_probe_config_create_param.py +1 -1
- gcore/types/cloud/container_scale_triggers.py +2 -2
- gcore/types/cloud/floating_ip_detailed.py +1 -1
- gcore/types/cloud/floating_ip_list_params.py +2 -2
- gcore/types/cloud/gpu_baremetal_cluster.py +1 -1
- gcore/types/cloud/gpu_baremetal_cluster_create_params.py +2 -2
- gcore/types/cloud/gpu_baremetal_cluster_delete_params.py +1 -1
- gcore/types/cloud/gpu_baremetal_cluster_rebuild_params.py +1 -1
- gcore/types/cloud/gpu_baremetal_cluster_server.py +1 -1
- gcore/types/cloud/gpu_baremetal_clusters/image_upload_params.py +1 -1
- gcore/types/cloud/gpu_baremetal_clusters/server_attach_interface_params.py +10 -10
- gcore/types/cloud/gpu_baremetal_flavor.py +3 -3
- gcore/types/cloud/image.py +1 -1
- gcore/types/cloud/inference/deployment_create_params.py +4 -4
- gcore/types/cloud/inference/deployment_update_params.py +6 -6
- gcore/types/cloud/inference/inference.py +2 -4
- gcore/types/cloud/instance.py +1 -1
- gcore/types/cloud/instance_create_params.py +8 -10
- gcore/types/cloud/instance_list_params.py +8 -8
- gcore/types/cloud/instances/flavor_list_suitable_params.py +4 -1
- gcore/types/cloud/instances/image_list_params.py +1 -1
- gcore/types/cloud/instances/instance_flavor.py +3 -3
- gcore/types/cloud/instances/interface_attach_params.py +10 -10
- gcore/types/cloud/load_balancer_create_params.py +17 -15
- gcore/types/cloud/load_balancer_flavor_detail.py +3 -3
- gcore/types/cloud/load_balancer_l7_policy.py +5 -5
- gcore/types/cloud/load_balancer_list_params.py +5 -5
- gcore/types/cloud/load_balancer_listener_detail.py +4 -4
- gcore/types/cloud/load_balancers/l7_policy_create_params.py +5 -5
- gcore/types/cloud/load_balancers/l7_policy_replace_params.py +5 -5
- gcore/types/cloud/load_balancers/listener_create_params.py +4 -4
- gcore/types/cloud/load_balancers/listener_update_params.py +3 -3
- gcore/types/cloud/load_balancers/pool_create_params.py +4 -4
- gcore/types/cloud/load_balancers/pool_update_params.py +4 -4
- gcore/types/cloud/load_balancers/pools/member_add_params.py +3 -3
- gcore/types/cloud/member.py +2 -2
- gcore/types/cloud/network.py +2 -2
- gcore/types/cloud/network_details.py +2 -2
- gcore/types/cloud/network_list_params.py +2 -2
- gcore/types/cloud/networks/subnet_create_params.py +1 -1
- gcore/types/cloud/networks/subnet_list_params.py +2 -2
- gcore/types/cloud/region.py +4 -4
- gcore/types/cloud/registries/user_create_multiple_params.py +3 -5
- gcore/types/cloud/registries/user_create_params.py +3 -5
- gcore/types/cloud/registry_create_params.py +3 -5
- gcore/types/cloud/reserved_fixed_ip_create_params.py +2 -2
- gcore/types/cloud/reserved_fixed_ip_list_params.py +3 -3
- gcore/types/cloud/security_group_list_params.py +1 -1
- gcore/types/cloud/session_persistence.py +1 -1
- gcore/types/cloud/ssh_key_created.py +3 -6
- gcore/types/cloud/task.py +1 -1
- gcore/types/cloud/task_list_params.py +49 -45
- gcore/types/cloud/users/role_assignment_create_params.py +1 -1
- gcore/types/cloud/users/role_assignment_update_params.py +1 -1
- gcore/types/cloud/volume_create_params.py +6 -6
- gcore/types/cloud/volume_list_params.py +3 -3
- gcore/types/waap/__init__.py +98 -2
- gcore/types/waap/client_me_response.py +34 -0
- gcore/types/waap/custom_page_set_create_params.py +35 -0
- gcore/types/waap/custom_page_set_list_params.py +25 -0
- gcore/types/waap/custom_page_set_preview_params.py +34 -0
- gcore/types/waap/custom_page_set_update_params.py +35 -0
- gcore/types/waap/domain_list_rule_sets_response.py +10 -0
- gcore/types/waap/domains/__init__.py +42 -0
- gcore/types/waap/domains/advanced_rule_create_params.py +80 -0
- gcore/types/waap/domains/advanced_rule_list_params.py +58 -0
- gcore/types/waap/domains/advanced_rule_update_params.py +83 -0
- gcore/types/waap/domains/analytics/__init__.py +5 -0
- gcore/types/waap/domains/analytics/request_list_params.py +53 -0
- gcore/types/waap/domains/analytics_get_event_statistics_params.py +34 -0
- gcore/types/waap/domains/analytics_list_ddos_attacks_params.py +28 -0
- gcore/types/waap/domains/analytics_list_ddos_info_params.py +31 -0
- gcore/types/waap/domains/analytics_list_event_traffic_params.py +26 -0
- gcore/types/waap/domains/analytics_list_event_traffic_response.py +10 -0
- gcore/types/waap/domains/api_discovery/__init__.py +7 -0
- gcore/types/waap/domains/api_discovery/scan_result_get_response.py +29 -0
- gcore/types/waap/domains/api_discovery/scan_result_list_params.py +41 -0
- gcore/types/waap/domains/api_discovery/scan_result_list_response.py +29 -0
- gcore/types/waap/domains/api_discovery_get_settings_response.py +36 -0
- gcore/types/waap/domains/api_discovery_scan_openapi_response.py +10 -0
- gcore/types/waap/domains/api_discovery_update_settings_params.py +34 -0
- gcore/types/waap/domains/api_discovery_update_settings_response.py +36 -0
- gcore/types/waap/domains/api_discovery_upload_openapi_params.py +19 -0
- gcore/types/waap/domains/api_discovery_upload_openapi_response.py +10 -0
- gcore/types/waap/domains/api_path_create_params.py +31 -0
- gcore/types/waap/domains/api_path_create_response.py +50 -0
- gcore/types/waap/domains/api_path_get_response.py +50 -0
- gcore/types/waap/domains/api_path_group_list_response.py +12 -0
- gcore/types/waap/domains/api_path_list_params.py +62 -0
- gcore/types/waap/domains/api_path_list_response.py +50 -0
- gcore/types/waap/domains/api_path_update_params.py +29 -0
- gcore/types/waap/domains/custom_rule_create_params.py +368 -0
- gcore/types/waap/domains/custom_rule_delete_multiple_params.py +13 -0
- gcore/types/waap/domains/custom_rule_list_params.py +35 -0
- gcore/types/waap/domains/custom_rule_update_params.py +371 -0
- gcore/types/waap/domains/firewall_rule_create_params.py +75 -0
- gcore/types/waap/domains/firewall_rule_delete_multiple_params.py +13 -0
- gcore/types/waap/domains/firewall_rule_list_params.py +33 -0
- gcore/types/waap/domains/firewall_rule_update_params.py +78 -0
- gcore/types/waap/domains/insight_list_params.py +34 -0
- gcore/types/waap/domains/insight_replace_params.py +17 -0
- gcore/types/waap/domains/insight_silence_create_params.py +28 -0
- gcore/types/waap/domains/insight_silence_list_params.py +33 -0
- gcore/types/waap/domains/insight_silence_update_params.py +28 -0
- gcore/types/waap/domains/setting_update_params.py +7 -0
- gcore/types/waap/ip_info_get_attack_time_series_params.py +12 -0
- gcore/types/waap/ip_info_get_attack_time_series_response.py +10 -0
- gcore/types/waap/ip_info_get_blocked_requests_params.py +15 -0
- gcore/types/waap/ip_info_get_blocked_requests_response.py +10 -0
- gcore/types/waap/ip_info_get_counts_params.py +19 -0
- gcore/types/waap/ip_info_get_ddos_attack_series_params.py +12 -0
- gcore/types/waap/ip_info_get_params.py +12 -0
- gcore/types/waap/ip_info_get_top_sessions_params.py +15 -0
- gcore/types/waap/ip_info_get_top_sessions_response.py +10 -0
- gcore/types/waap/ip_info_get_top_urls_params.py +15 -0
- gcore/types/waap/ip_info_get_top_urls_response.py +10 -0
- gcore/types/waap/ip_info_get_top_user_agents_params.py +15 -0
- gcore/types/waap/ip_info_get_top_user_agents_response.py +10 -0
- gcore/types/waap/ip_info_list_attacked_countries_params.py +12 -0
- gcore/types/waap/ip_info_list_attacked_countries_response.py +10 -0
- gcore/types/waap/organization_list_params.py +22 -0
- gcore/types/waap/statistic_get_usage_series_params.py +25 -0
- gcore/types/waap/tag_list_params.py +28 -0
- gcore/types/waap/waap_advanced_rule.py +83 -0
- gcore/types/waap/waap_advanced_rule_descriptor.py +49 -0
- gcore/types/waap/waap_advanced_rule_descriptor_list.py +15 -0
- gcore/types/waap/waap_block_csrf_page_data.py +28 -0
- gcore/types/waap/waap_block_csrf_page_data_param.py +28 -0
- gcore/types/waap/waap_block_page_data.py +28 -0
- gcore/types/waap/waap_block_page_data_param.py +28 -0
- gcore/types/waap/waap_blocked_statistics.py +36 -0
- gcore/types/waap/waap_captcha_page_data.py +31 -0
- gcore/types/waap/waap_captcha_page_data_param.py +31 -0
- gcore/types/waap/waap_common_tag.py +16 -0
- gcore/types/waap/waap_cookie_disabled_page_data.py +18 -0
- gcore/types/waap/waap_cookie_disabled_page_data_param.py +18 -0
- gcore/types/waap/waap_count_statistics.py +36 -0
- gcore/types/waap/waap_custom_page_preview.py +10 -0
- gcore/types/waap/waap_custom_page_set.py +36 -0
- gcore/types/waap/waap_custom_rule.py +373 -0
- gcore/types/waap/waap_customer_rule_state.py +7 -0
- gcore/types/waap/waap_ddos_attack.py +16 -0
- gcore/types/waap/waap_ddos_info.py +17 -0
- gcore/types/waap/{waap_api_urls.py → waap_domain_api_settings.py} +9 -2
- gcore/types/waap/waap_domain_policy.py +29 -0
- gcore/types/waap/{waap_domain_settings.py → waap_domain_settings_model.py} +4 -4
- gcore/types/waap/waap_event_statistics.py +15 -0
- gcore/types/waap/waap_firewall_rule.py +78 -0
- gcore/types/waap/waap_get_account_overview_response.py +34 -0
- gcore/types/waap/waap_handshake_page_data.py +25 -0
- gcore/types/waap/waap_handshake_page_data_param.py +25 -0
- gcore/types/waap/waap_insight.py +38 -0
- gcore/types/waap/waap_insight_silence.py +28 -0
- gcore/types/waap/waap_insight_silence_sort_by.py +9 -0
- gcore/types/waap/waap_insight_sort_by.py +20 -0
- gcore/types/waap/waap_insight_status.py +7 -0
- gcore/types/waap/waap_ip_country_attack.py +16 -0
- gcore/types/waap/waap_ip_ddos_info_model.py +23 -0
- gcore/types/waap/waap_ip_info.py +57 -0
- gcore/types/waap/waap_ip_info_counts.py +16 -0
- gcore/types/waap/waap_javascript_disabled_page_data.py +18 -0
- gcore/types/waap/waap_javascript_disabled_page_data_param.py +18 -0
- gcore/types/waap/waap_network_details.py +17 -0
- gcore/types/waap/waap_organization.py +13 -0
- gcore/types/waap/waap_page_type.py +9 -0
- gcore/types/waap/waap_paginated_custom_page_set.py +22 -0
- gcore/types/waap/waap_paginated_ddos_attack.py +22 -0
- gcore/types/waap/waap_paginated_ddos_info.py +22 -0
- gcore/types/waap/waap_paginated_request_summary.py +22 -0
- gcore/types/waap/waap_pattern_matched_tag.py +37 -0
- gcore/types/waap/waap_policy_action.py +7 -0
- gcore/types/waap/waap_policy_mode.py +10 -0
- gcore/types/waap/waap_request_details.py +92 -0
- gcore/types/waap/waap_request_organization.py +13 -0
- gcore/types/waap/waap_request_summary.py +59 -0
- gcore/types/waap/waap_resolution.py +7 -0
- gcore/types/waap/waap_rule_action_type.py +7 -0
- gcore/types/waap/waap_rule_blocked_requests.py +16 -0
- gcore/types/waap/waap_rule_set.py +41 -0
- gcore/types/waap/waap_statistic_item.py +18 -0
- gcore/types/waap/waap_statistics_series.py +16 -0
- gcore/types/waap/waap_tag.py +16 -0
- gcore/types/waap/waap_time_series_attack.py +23 -0
- gcore/types/waap/waap_top_session.py +24 -0
- gcore/types/waap/waap_top_url.py +13 -0
- gcore/types/waap/waap_top_user_agent.py +13 -0
- gcore/types/waap/waap_traffic_metrics.py +68 -0
- gcore/types/waap/waap_traffic_type.py +28 -0
- gcore/types/waap/waap_user_agent_details.py +40 -0
- {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/METADATA +1 -1
- {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/RECORD +258 -109
- {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/WHEEL +0 -0
- {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -58,10 +58,10 @@ class NewInterfaceExternalExtendSchemaWithDdosddosProfileField(TypedDict, total=
|
|
|
58
58
|
"""Name of DDoS profile field"""
|
|
59
59
|
|
|
60
60
|
field_value: object
|
|
61
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
61
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
62
62
|
|
|
63
63
|
value: Optional[str]
|
|
64
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
64
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
class NewInterfaceExternalExtendSchemaWithDDOSDDOSProfile(TypedDict, total=False):
|
|
@@ -112,10 +112,10 @@ class NewInterfaceSpecificSubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
112
112
|
"""Name of DDoS profile field"""
|
|
113
113
|
|
|
114
114
|
field_value: object
|
|
115
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
115
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
116
116
|
|
|
117
117
|
value: Optional[str]
|
|
118
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
118
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
class NewInterfaceSpecificSubnetSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -158,7 +158,7 @@ class NewInterfaceAnySubnetSchema(TypedDict, total=False):
|
|
|
158
158
|
"""List of security group IDs"""
|
|
159
159
|
|
|
160
160
|
type: str
|
|
161
|
-
"""Must be 'any_subnet'"""
|
|
161
|
+
"""Must be '`any_subnet`'"""
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
class NewInterfaceAnySubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
@@ -169,10 +169,10 @@ class NewInterfaceAnySubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
169
169
|
"""Name of DDoS profile field"""
|
|
170
170
|
|
|
171
171
|
field_value: object
|
|
172
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
172
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
173
173
|
|
|
174
174
|
value: Optional[str]
|
|
175
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
175
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
176
176
|
|
|
177
177
|
|
|
178
178
|
class NewInterfaceAnySubnetSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -212,7 +212,7 @@ class NewInterfaceReservedFixedIPSchema(TypedDict, total=False):
|
|
|
212
212
|
"""List of security group IDs"""
|
|
213
213
|
|
|
214
214
|
type: str
|
|
215
|
-
"""Must be 'reserved_fixed_ip'. Union tag"""
|
|
215
|
+
"""Must be '`reserved_fixed_ip`'. Union tag"""
|
|
216
216
|
|
|
217
217
|
|
|
218
218
|
class NewInterfaceReservedFixedIPSchemaDDOSProfileField(TypedDict, total=False):
|
|
@@ -223,10 +223,10 @@ class NewInterfaceReservedFixedIPSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
223
223
|
"""Name of DDoS profile field"""
|
|
224
224
|
|
|
225
225
|
field_value: object
|
|
226
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
226
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
227
227
|
|
|
228
228
|
value: Optional[str]
|
|
229
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
229
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
230
230
|
|
|
231
231
|
|
|
232
232
|
class NewInterfaceReservedFixedIPSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -95,13 +95,13 @@ class GPUBaremetalFlavorSerializerWithPricesHardwareProperties(BaseModel):
|
|
|
95
95
|
|
|
96
96
|
class GPUBaremetalFlavorSerializerWithPricesPrice(BaseModel):
|
|
97
97
|
currency_code: Optional[str] = None
|
|
98
|
-
"""Currency code. Shown if the include_prices query parameter if set to true"""
|
|
98
|
+
"""Currency code. Shown if the `include_prices` query parameter if set to true"""
|
|
99
99
|
|
|
100
100
|
price_per_hour: Optional[float] = None
|
|
101
|
-
"""Price per hour. Shown if the include_prices query parameter if set to true"""
|
|
101
|
+
"""Price per hour. Shown if the `include_prices` query parameter if set to true"""
|
|
102
102
|
|
|
103
103
|
price_per_month: Optional[float] = None
|
|
104
|
-
"""Price per month. Shown if the include_prices query parameter if set to true"""
|
|
104
|
+
"""Price per month. Shown if the `include_prices` query parameter if set to true"""
|
|
105
105
|
|
|
106
106
|
price_status: Optional[Literal["error", "hide", "show"]] = None
|
|
107
107
|
"""Price status for the UI"""
|
gcore/types/cloud/image.py
CHANGED
|
@@ -70,7 +70,7 @@ class Image(BaseModel):
|
|
|
70
70
|
"""Image visibility. Globally visible images are public"""
|
|
71
71
|
|
|
72
72
|
architecture: Optional[Literal["aarch64", "x86_64"]] = None
|
|
73
|
-
"""An image architecture type: aarch64, x86_64"""
|
|
73
|
+
"""An image architecture type: aarch64, `x86_64`"""
|
|
74
74
|
|
|
75
75
|
creator_task_id: Optional[str] = None
|
|
76
76
|
"""Task that created this entity"""
|
|
@@ -53,7 +53,7 @@ class DeploymentCreateParams(TypedDict, total=False):
|
|
|
53
53
|
auth_enabled: bool
|
|
54
54
|
"""Set to `true` to enable API key authentication for the inference instance.
|
|
55
55
|
|
|
56
|
-
`"Authorization": "Bearer
|
|
56
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
57
57
|
for the requests to the instance if enabled
|
|
58
58
|
"""
|
|
59
59
|
|
|
@@ -78,7 +78,7 @@ class DeploymentCreateParams(TypedDict, total=False):
|
|
|
78
78
|
probes: Optional[Probes]
|
|
79
79
|
"""Probes configured for all containers of the inference instance.
|
|
80
80
|
|
|
81
|
-
If probes are not provided, and the image_name is from a the Model Catalog
|
|
81
|
+
If probes are not provided, and the `image_name` is from a the Model Catalog
|
|
82
82
|
registry, the default probes will be used.
|
|
83
83
|
"""
|
|
84
84
|
|
|
@@ -153,13 +153,13 @@ class ContainerScaleTriggers(TypedDict, total=False):
|
|
|
153
153
|
gpu_memory: Optional[ContainerScaleTriggersGPUMemory]
|
|
154
154
|
"""GPU memory trigger configuration.
|
|
155
155
|
|
|
156
|
-
Calculated by DCGM_FI_DEV_MEM_COPY_UTIL metric
|
|
156
|
+
Calculated by `DCGM_FI_DEV_MEM_COPY_UTIL` metric
|
|
157
157
|
"""
|
|
158
158
|
|
|
159
159
|
gpu_utilization: Optional[ContainerScaleTriggersGPUUtilization]
|
|
160
160
|
"""GPU utilization trigger configuration.
|
|
161
161
|
|
|
162
|
-
Calculated by DCGM_FI_DEV_GPU_UTIL metric
|
|
162
|
+
Calculated by `DCGM_FI_DEV_GPU_UTIL` metric
|
|
163
163
|
"""
|
|
164
164
|
|
|
165
165
|
http: Optional[ContainerScaleTriggersHTTP]
|
|
@@ -47,7 +47,7 @@ class DeploymentUpdateParams(TypedDict, total=False):
|
|
|
47
47
|
auth_enabled: bool
|
|
48
48
|
"""Set to `true` to enable API key authentication for the inference instance.
|
|
49
49
|
|
|
50
|
-
`"Authorization": "Bearer
|
|
50
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
51
51
|
for the requests to the instance if enabled
|
|
52
52
|
"""
|
|
53
53
|
|
|
@@ -160,13 +160,13 @@ class ContainerScaleTriggers(TypedDict, total=False):
|
|
|
160
160
|
gpu_memory: Optional[ContainerScaleTriggersGPUMemory]
|
|
161
161
|
"""GPU memory trigger configuration.
|
|
162
162
|
|
|
163
|
-
Calculated by DCGM_FI_DEV_MEM_COPY_UTIL metric
|
|
163
|
+
Calculated by `DCGM_FI_DEV_MEM_COPY_UTIL` metric
|
|
164
164
|
"""
|
|
165
165
|
|
|
166
166
|
gpu_utilization: Optional[ContainerScaleTriggersGPUUtilization]
|
|
167
167
|
"""GPU utilization trigger configuration.
|
|
168
168
|
|
|
169
|
-
Calculated by DCGM_FI_DEV_GPU_UTIL metric
|
|
169
|
+
Calculated by `DCGM_FI_DEV_GPU_UTIL` metric
|
|
170
170
|
"""
|
|
171
171
|
|
|
172
172
|
http: Optional[ContainerScaleTriggersHTTP]
|
|
@@ -276,7 +276,7 @@ class ProbesLivenessProbe(TypedDict, total=False):
|
|
|
276
276
|
"""Whether the probe is enabled or not."""
|
|
277
277
|
|
|
278
278
|
probe: ProbesLivenessProbeProbe
|
|
279
|
-
"""Probe configuration (exec, http_get or tcp_socket)"""
|
|
279
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
280
280
|
|
|
281
281
|
|
|
282
282
|
class ProbesReadinessProbeProbeExec(TypedDict, total=False):
|
|
@@ -337,7 +337,7 @@ class ProbesReadinessProbe(TypedDict, total=False):
|
|
|
337
337
|
"""Whether the probe is enabled or not."""
|
|
338
338
|
|
|
339
339
|
probe: ProbesReadinessProbeProbe
|
|
340
|
-
"""Probe configuration (exec, http_get or tcp_socket)"""
|
|
340
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
341
341
|
|
|
342
342
|
|
|
343
343
|
class ProbesStartupProbeProbeExec(TypedDict, total=False):
|
|
@@ -398,7 +398,7 @@ class ProbesStartupProbe(TypedDict, total=False):
|
|
|
398
398
|
"""Whether the probe is enabled or not."""
|
|
399
399
|
|
|
400
400
|
probe: ProbesStartupProbeProbe
|
|
401
|
-
"""Probe configuration (exec, http_get or tcp_socket)"""
|
|
401
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
402
402
|
|
|
403
403
|
|
|
404
404
|
class Probes(TypedDict, total=False):
|
|
@@ -19,7 +19,7 @@ class Inference(BaseModel):
|
|
|
19
19
|
auth_enabled: bool
|
|
20
20
|
"""`true` if instance uses API key authentication.
|
|
21
21
|
|
|
22
|
-
`"Authorization": "Bearer
|
|
22
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
23
23
|
for the requests to the instance if enabled.
|
|
24
24
|
"""
|
|
25
25
|
|
|
@@ -71,9 +71,7 @@ class Inference(BaseModel):
|
|
|
71
71
|
"""Project ID. If not provided, your default project ID will be used."""
|
|
72
72
|
|
|
73
73
|
status: Literal["ACTIVE", "DELETING", "DEPLOYING", "DISABLED", "PARTIALLYDEPLOYED", "PENDING"]
|
|
74
|
-
"""Inference instance status.
|
|
75
|
-
|
|
76
|
-
Value can be one of the following:
|
|
74
|
+
"""Inference instance status. Value can be one of the following:
|
|
77
75
|
|
|
78
76
|
- `DEPLOYING` - The instance is being deployed. Containers are not yet created.
|
|
79
77
|
- `PARTIALLYDEPLOYED` - All containers have been created, but some may not be
|
gcore/types/cloud/instance.py
CHANGED
|
@@ -185,7 +185,7 @@ class Instance(BaseModel):
|
|
|
185
185
|
"""Instance ID"""
|
|
186
186
|
|
|
187
187
|
addresses: Dict[str, List[Address]]
|
|
188
|
-
"""Map of network_name to list of addresses in that network"""
|
|
188
|
+
"""Map of `network_name` to list of addresses in that network"""
|
|
189
189
|
|
|
190
190
|
blackhole_ports: List[BlackholePort]
|
|
191
191
|
"""IP addresses of the instances that are blackholed by DDoS mitigation system"""
|
|
@@ -78,8 +78,8 @@ class InstanceCreateParams(TypedDict, total=False):
|
|
|
78
78
|
If you want the instance name to be automatically generated based on IP
|
|
79
79
|
addresses, you can provide a name template instead of specifying the name
|
|
80
80
|
manually. The template should include a placeholder that will be replaced during
|
|
81
|
-
provisioning. Supported placeholders are: `{ip_octets}` (last 3 octets of the
|
|
82
|
-
IP), `{two_ip_octets}`, and `{one_ip_octet}`.
|
|
81
|
+
provisioning. Supported placeholders are: `{`ip_octets`}` (last 3 octets of the
|
|
82
|
+
IP), `{`two_ip_octets`}`, and `{`one_ip_octet`}`.
|
|
83
83
|
"""
|
|
84
84
|
|
|
85
85
|
password: str
|
|
@@ -88,8 +88,8 @@ class InstanceCreateParams(TypedDict, total=False):
|
|
|
88
88
|
When only 'password' is provided, it is set as the password for the default user
|
|
89
89
|
of the image. For Windows instances, 'username' cannot be specified. Use the
|
|
90
90
|
'password' field to set the password for the 'Admin' user on Windows. Use the
|
|
91
|
-
'user_data' field to provide a script to create new users on Windows. The
|
|
92
|
-
password of the Admin user cannot be updated via 'user_data'.
|
|
91
|
+
'`user_data`' field to provide a script to create new users on Windows. The
|
|
92
|
+
password of the Admin user cannot be updated via '`user_data`'.
|
|
93
93
|
"""
|
|
94
94
|
|
|
95
95
|
security_groups: Iterable[SecurityGroup]
|
|
@@ -98,9 +98,7 @@ class InstanceCreateParams(TypedDict, total=False):
|
|
|
98
98
|
"""
|
|
99
99
|
|
|
100
100
|
servergroup_id: str
|
|
101
|
-
"""Placement group ID for instance placement policy.
|
|
102
|
-
|
|
103
|
-
Supported group types:
|
|
101
|
+
"""Placement group ID for instance placement policy. Supported group types:
|
|
104
102
|
|
|
105
103
|
- `anti-affinity`: Ensures instances are placed on different hosts for high
|
|
106
104
|
availability.
|
|
@@ -112,7 +110,7 @@ class InstanceCreateParams(TypedDict, total=False):
|
|
|
112
110
|
ssh_key_name: Optional[str]
|
|
113
111
|
"""
|
|
114
112
|
Specifies the name of the SSH keypair, created via the
|
|
115
|
-
|
|
113
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
116
114
|
"""
|
|
117
115
|
|
|
118
116
|
tags: TagUpdateMapParam
|
|
@@ -128,9 +126,9 @@ class InstanceCreateParams(TypedDict, total=False):
|
|
|
128
126
|
user_data: str
|
|
129
127
|
"""String in base64 format.
|
|
130
128
|
|
|
131
|
-
For Linux instances, 'user_data' is ignored when 'password' field is provided.
|
|
129
|
+
For Linux instances, '`user_data`' is ignored when 'password' field is provided.
|
|
132
130
|
For Windows instances, Admin user password is set by 'password' field and cannot
|
|
133
|
-
be updated via 'user_data'. Examples of the user_data
|
|
131
|
+
be updated via '`user_data`'. Examples of the `user_data`:
|
|
134
132
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
135
133
|
"""
|
|
136
134
|
|
|
@@ -37,10 +37,10 @@ class InstanceListParams(TypedDict, total=False):
|
|
|
37
37
|
"""Exclude instances with specified security group name"""
|
|
38
38
|
|
|
39
39
|
flavor_id: str
|
|
40
|
-
"""Filter out instances by flavor_id
|
|
40
|
+
"""Filter out instances by `flavor_id`. Flavor id must match exactly."""
|
|
41
41
|
|
|
42
42
|
flavor_prefix: str
|
|
43
|
-
"""Filter out instances by flavor_prefix
|
|
43
|
+
"""Filter out instances by `flavor_prefix`."""
|
|
44
44
|
|
|
45
45
|
include_ai: bool
|
|
46
46
|
"""Include GPU clusters' servers"""
|
|
@@ -87,13 +87,13 @@ class InstanceListParams(TypedDict, total=False):
|
|
|
87
87
|
profile_name: str
|
|
88
88
|
"""Filter result by ddos protection profile name.
|
|
89
89
|
|
|
90
|
-
Effective only with with_ddos set to true.
|
|
90
|
+
Effective only with `with_ddos` set to true.
|
|
91
91
|
"""
|
|
92
92
|
|
|
93
93
|
protection_status: Literal["Active", "Queued", "Error"]
|
|
94
|
-
"""Filter result by DDoS protection_status
|
|
94
|
+
"""Filter result by DDoS `protection_status`.
|
|
95
95
|
|
|
96
|
-
if parameter is provided. Effective only with with_ddos set to true. (Active,
|
|
96
|
+
if parameter is provided. Effective only with `with_ddos` set to true. (Active,
|
|
97
97
|
Queued or Error)
|
|
98
98
|
"""
|
|
99
99
|
|
|
@@ -120,17 +120,17 @@ class InstanceListParams(TypedDict, total=False):
|
|
|
120
120
|
tag_key_value: str
|
|
121
121
|
"""Optional.
|
|
122
122
|
|
|
123
|
-
Filter by tag key-value pairs. curl -G --data-urlencode "tag_key_value
|
|
123
|
+
Filter by tag key-value pairs. curl -G --data-urlencode "`tag_key_value`={"key":
|
|
124
124
|
"value"}" --url "https://example.com/cloud/v1/resource/1/1"
|
|
125
125
|
"""
|
|
126
126
|
|
|
127
127
|
tag_value: List[str]
|
|
128
|
-
"""Optional. Filter by tag values.
|
|
128
|
+
"""Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2"""
|
|
129
129
|
|
|
130
130
|
type_ddos_profile: Literal["basic", "advanced"]
|
|
131
131
|
"""Return bare metals either only with advanced or only basic DDoS protection.
|
|
132
132
|
|
|
133
|
-
Effective only with with_ddos set to true. (advanced or basic)
|
|
133
|
+
Effective only with `with_ddos` set to true. (advanced or basic)
|
|
134
134
|
"""
|
|
135
135
|
|
|
136
136
|
uuid: str
|
|
@@ -50,7 +50,10 @@ class Volume(TypedDict, total=False):
|
|
|
50
50
|
"""Volume snapshot ID. Mandatory if volume is created from a snapshot"""
|
|
51
51
|
|
|
52
52
|
type_name: Literal["cold", "ssd_hiiops", "ssd_local", "ssd_lowlatency", "standard", "ultra"]
|
|
53
|
-
"""
|
|
53
|
+
"""
|
|
54
|
+
One of 'standard', '`ssd_hiiops`', '`ssd_local`', '`ssd_lowlatency`', 'cold',
|
|
55
|
+
'ultra'
|
|
56
|
+
"""
|
|
54
57
|
|
|
55
58
|
volume_id: str
|
|
56
59
|
"""Volume ID. Mandatory if volume is pre-existing volume"""
|
|
@@ -25,7 +25,7 @@ class ImageListParams(TypedDict, total=False):
|
|
|
25
25
|
tag_key_value: str
|
|
26
26
|
"""Filter by tag key-value pairs.
|
|
27
27
|
|
|
28
|
-
Must be a valid JSON string. 'curl -G --data-urlencode 'tag_key_value
|
|
28
|
+
Must be a valid JSON string. 'curl -G --data-urlencode '`tag_key_value`={"key":
|
|
29
29
|
"value"}' --url 'http://localhost:1111/v1/images/1/1'"
|
|
30
30
|
"""
|
|
31
31
|
|
|
@@ -34,16 +34,16 @@ class InstanceFlavor(BaseModel):
|
|
|
34
34
|
"""Number of available instances of given configuration"""
|
|
35
35
|
|
|
36
36
|
currency_code: Optional[str] = None
|
|
37
|
-
"""Currency code. Shown if the include_prices query parameter if set to true"""
|
|
37
|
+
"""Currency code. Shown if the `include_prices` query parameter if set to true"""
|
|
38
38
|
|
|
39
39
|
hardware_description: Optional[Dict[str, str]] = None
|
|
40
40
|
"""Additional hardware description"""
|
|
41
41
|
|
|
42
42
|
price_per_hour: Optional[float] = None
|
|
43
|
-
"""Price per hour. Shown if the include_prices query parameter if set to true"""
|
|
43
|
+
"""Price per hour. Shown if the `include_prices` query parameter if set to true"""
|
|
44
44
|
|
|
45
45
|
price_per_month: Optional[float] = None
|
|
46
|
-
"""Price per month. Shown if the include_prices query parameter if set to true"""
|
|
46
|
+
"""Price per month. Shown if the `include_prices` query parameter if set to true"""
|
|
47
47
|
|
|
48
48
|
price_status: Optional[Literal["error", "hide", "show"]] = None
|
|
49
49
|
"""Price status for the UI"""
|
|
@@ -58,10 +58,10 @@ class NewInterfaceExternalExtendSchemaWithDdosddosProfileField(TypedDict, total=
|
|
|
58
58
|
"""Name of DDoS profile field"""
|
|
59
59
|
|
|
60
60
|
field_value: object
|
|
61
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
61
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
62
62
|
|
|
63
63
|
value: Optional[str]
|
|
64
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
64
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
class NewInterfaceExternalExtendSchemaWithDDOSDDOSProfile(TypedDict, total=False):
|
|
@@ -112,10 +112,10 @@ class NewInterfaceSpecificSubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
112
112
|
"""Name of DDoS profile field"""
|
|
113
113
|
|
|
114
114
|
field_value: object
|
|
115
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
115
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
116
116
|
|
|
117
117
|
value: Optional[str]
|
|
118
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
118
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
class NewInterfaceSpecificSubnetSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -158,7 +158,7 @@ class NewInterfaceAnySubnetSchema(TypedDict, total=False):
|
|
|
158
158
|
"""List of security group IDs"""
|
|
159
159
|
|
|
160
160
|
type: str
|
|
161
|
-
"""Must be 'any_subnet'"""
|
|
161
|
+
"""Must be '`any_subnet`'"""
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
class NewInterfaceAnySubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
@@ -169,10 +169,10 @@ class NewInterfaceAnySubnetSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
169
169
|
"""Name of DDoS profile field"""
|
|
170
170
|
|
|
171
171
|
field_value: object
|
|
172
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
172
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
173
173
|
|
|
174
174
|
value: Optional[str]
|
|
175
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
175
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
176
176
|
|
|
177
177
|
|
|
178
178
|
class NewInterfaceAnySubnetSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -212,7 +212,7 @@ class NewInterfaceReservedFixedIPSchema(TypedDict, total=False):
|
|
|
212
212
|
"""List of security group IDs"""
|
|
213
213
|
|
|
214
214
|
type: str
|
|
215
|
-
"""Must be 'reserved_fixed_ip'. Union tag"""
|
|
215
|
+
"""Must be '`reserved_fixed_ip`'. Union tag"""
|
|
216
216
|
|
|
217
217
|
|
|
218
218
|
class NewInterfaceReservedFixedIPSchemaDDOSProfileField(TypedDict, total=False):
|
|
@@ -223,10 +223,10 @@ class NewInterfaceReservedFixedIPSchemaDDOSProfileField(TypedDict, total=False):
|
|
|
223
223
|
"""Name of DDoS profile field"""
|
|
224
224
|
|
|
225
225
|
field_value: object
|
|
226
|
-
"""Complex value. Only one of 'value' or 'field_value' must be specified."""
|
|
226
|
+
"""Complex value. Only one of 'value' or '`field_value`' must be specified."""
|
|
227
227
|
|
|
228
228
|
value: Optional[str]
|
|
229
|
-
"""Basic type value. Only one of 'value' or 'field_value' must be specified."""
|
|
229
|
+
"""Basic type value. Only one of 'value' or '`field_value`' must be specified."""
|
|
230
230
|
|
|
231
231
|
|
|
232
232
|
class NewInterfaceReservedFixedIPSchemaDDOSProfile(TypedDict, total=False):
|
|
@@ -61,8 +61,9 @@ class LoadBalancerCreateParams(TypedDict, total=False):
|
|
|
61
61
|
"""
|
|
62
62
|
Preferred option to establish connectivity between load balancer and its pools
|
|
63
63
|
members. L2 provides best performance, L3 provides less IPs usage. It is taking
|
|
64
|
-
effect only if instance_id + ip_address is provided, not subnet_id +
|
|
65
|
-
because we're considering this as intentional subnet_id
|
|
64
|
+
effect only if `instance_id` + `ip_address` is provided, not `subnet_id` +
|
|
65
|
+
`ip_address`, because we're considering this as intentional `subnet_id`
|
|
66
|
+
specification.
|
|
66
67
|
"""
|
|
67
68
|
|
|
68
69
|
tags: TagUpdateMapParam
|
|
@@ -77,27 +78,28 @@ class LoadBalancerCreateParams(TypedDict, total=False):
|
|
|
77
78
|
|
|
78
79
|
vip_ip_family: InterfaceIPFamily
|
|
79
80
|
"""
|
|
80
|
-
IP family for load balancer subnet auto-selection if vip_network_id is
|
|
81
|
+
IP family for load balancer subnet auto-selection if `vip_network_id` is
|
|
82
|
+
specified
|
|
81
83
|
"""
|
|
82
84
|
|
|
83
85
|
vip_network_id: str
|
|
84
86
|
"""Network ID for load balancer.
|
|
85
87
|
|
|
86
88
|
If not specified, default external network will be used. Mutually exclusive with
|
|
87
|
-
vip_port_id
|
|
89
|
+
`vip_port_id`
|
|
88
90
|
"""
|
|
89
91
|
|
|
90
92
|
vip_port_id: str
|
|
91
93
|
"""Existing Reserved Fixed IP port ID for load balancer.
|
|
92
94
|
|
|
93
|
-
Mutually exclusive with vip_network_id
|
|
95
|
+
Mutually exclusive with `vip_network_id`
|
|
94
96
|
"""
|
|
95
97
|
|
|
96
98
|
vip_subnet_id: str
|
|
97
99
|
"""Subnet ID for load balancer.
|
|
98
100
|
|
|
99
|
-
If not specified, any subnet from vip_network_id will be selected. Ignored
|
|
100
|
-
vip_network_id is not specified.
|
|
101
|
+
If not specified, any subnet from `vip_network_id` will be selected. Ignored
|
|
102
|
+
when `vip_network_id` is not specified.
|
|
101
103
|
"""
|
|
102
104
|
|
|
103
105
|
|
|
@@ -176,7 +178,7 @@ class ListenerPoolMember(TypedDict, total=False):
|
|
|
176
178
|
"""true if enabled. Defaults to true"""
|
|
177
179
|
|
|
178
180
|
instance_id: Optional[str]
|
|
179
|
-
"""Either subnet_id or instance_id should be provided"""
|
|
181
|
+
"""Either `subnet_id` or `instance_id` should be provided"""
|
|
180
182
|
|
|
181
183
|
monitor_address: Optional[str]
|
|
182
184
|
"""An alternate IP address used for health monitoring of a backend member.
|
|
@@ -187,11 +189,11 @@ class ListenerPoolMember(TypedDict, total=False):
|
|
|
187
189
|
monitor_port: Optional[int]
|
|
188
190
|
"""An alternate protocol port used for health monitoring of a backend member.
|
|
189
191
|
|
|
190
|
-
Default is null which monitors the member protocol_port
|
|
192
|
+
Default is null which monitors the member `protocol_port`.
|
|
191
193
|
"""
|
|
192
194
|
|
|
193
195
|
subnet_id: Optional[str]
|
|
194
|
-
"""Either subnet_id or instance_id should be provided"""
|
|
196
|
+
"""Either `subnet_id` or `instance_id` should be provided"""
|
|
195
197
|
|
|
196
198
|
weight: Optional[int]
|
|
197
199
|
"""Member weight. Valid values: 0 to 256, defaults to 1"""
|
|
@@ -205,7 +207,7 @@ class ListenerPoolSessionPersistence(TypedDict, total=False):
|
|
|
205
207
|
"""Should be set if app cookie or http cookie is used"""
|
|
206
208
|
|
|
207
209
|
persistence_granularity: Optional[str]
|
|
208
|
-
"""Subnet mask if source_ip is used. For UDP ports only"""
|
|
210
|
+
"""Subnet mask if `source_ip` is used. For UDP ports only"""
|
|
209
211
|
|
|
210
212
|
persistence_timeout: Optional[int]
|
|
211
213
|
"""Session persistence timeout. For UDP ports only"""
|
|
@@ -282,7 +284,7 @@ class Listener(TypedDict, total=False):
|
|
|
282
284
|
insert_x_forwarded: bool
|
|
283
285
|
"""Add headers X-Forwarded-For, X-Forwarded-Port, X-Forwarded-Proto to requests.
|
|
284
286
|
|
|
285
|
-
Only used with HTTP or TERMINATED_HTTPS protocols.
|
|
287
|
+
Only used with HTTP or `TERMINATED_HTTPS` protocols.
|
|
286
288
|
"""
|
|
287
289
|
|
|
288
290
|
pools: Iterable[ListenerPool]
|
|
@@ -290,14 +292,14 @@ class Listener(TypedDict, total=False):
|
|
|
290
292
|
|
|
291
293
|
secret_id: str
|
|
292
294
|
"""
|
|
293
|
-
ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or
|
|
294
|
-
listener
|
|
295
|
+
ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
|
|
296
|
+
PROMETHEUS listener
|
|
295
297
|
"""
|
|
296
298
|
|
|
297
299
|
sni_secret_id: List[str]
|
|
298
300
|
"""
|
|
299
301
|
List of secrets IDs containing PKCS12 format certificate/key bundles for
|
|
300
|
-
TERMINATED_HTTPS or PROMETHEUS listeners
|
|
302
|
+
`TERMINATED_HTTPS` or PROMETHEUS listeners
|
|
301
303
|
"""
|
|
302
304
|
|
|
303
305
|
timeout_client_data: Optional[int]
|
|
@@ -28,13 +28,13 @@ class LoadBalancerFlavorDetail(BaseModel):
|
|
|
28
28
|
"""Virtual CPU count. For bare metal flavors, it's a physical CPU count"""
|
|
29
29
|
|
|
30
30
|
currency_code: Optional[str] = None
|
|
31
|
-
"""Currency code. Shown if the include_prices query parameter if set to true"""
|
|
31
|
+
"""Currency code. Shown if the `include_prices` query parameter if set to true"""
|
|
32
32
|
|
|
33
33
|
price_per_hour: Optional[float] = None
|
|
34
|
-
"""Price per hour. Shown if the include_prices query parameter if set to true"""
|
|
34
|
+
"""Price per hour. Shown if the `include_prices` query parameter if set to true"""
|
|
35
35
|
|
|
36
36
|
price_per_month: Optional[float] = None
|
|
37
|
-
"""Price per month. Shown if the include_prices query parameter if set to true"""
|
|
37
|
+
"""Price per month. Shown if the `include_prices` query parameter if set to true"""
|
|
38
38
|
|
|
39
39
|
price_status: Optional[Literal["error", "hide", "show"]] = None
|
|
40
40
|
"""Price status for the UI"""
|
|
@@ -38,26 +38,26 @@ class LoadBalancerL7Policy(BaseModel):
|
|
|
38
38
|
redirect_http_code: Optional[int] = None
|
|
39
39
|
"""
|
|
40
40
|
Requests matching this policy will be redirected to the specified URL or Prefix
|
|
41
|
-
URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or
|
|
42
|
-
REDIRECT_PREFIX
|
|
41
|
+
URL with the HTTP response code. Valid if action is `REDIRECT_TO_URL` or
|
|
42
|
+
`REDIRECT_PREFIX`. Valid options are 301, 302, 303, 307, or 308. Default is 302.
|
|
43
43
|
"""
|
|
44
44
|
|
|
45
45
|
redirect_pool_id: Optional[str] = None
|
|
46
46
|
"""Requests matching this policy will be redirected to the pool with this ID.
|
|
47
47
|
|
|
48
|
-
Only valid if action is REDIRECT_TO_POOL
|
|
48
|
+
Only valid if action is `REDIRECT_TO_POOL`.
|
|
49
49
|
"""
|
|
50
50
|
|
|
51
51
|
redirect_prefix: Optional[str] = None
|
|
52
52
|
"""Requests matching this policy will be redirected to this Prefix URL.
|
|
53
53
|
|
|
54
|
-
Only valid if action is REDIRECT_PREFIX
|
|
54
|
+
Only valid if action is `REDIRECT_PREFIX`.
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
redirect_url: Optional[str] = None
|
|
58
58
|
"""Requests matching this policy will be redirected to this URL.
|
|
59
59
|
|
|
60
|
-
Only valid if action is REDIRECT_TO_URL
|
|
60
|
+
Only valid if action is `REDIRECT_TO_URL`.
|
|
61
61
|
"""
|
|
62
62
|
|
|
63
63
|
region: Optional[str] = None
|
|
@@ -30,10 +30,10 @@ class LoadBalancerListParams(TypedDict, total=False):
|
|
|
30
30
|
|
|
31
31
|
order_by: str
|
|
32
32
|
"""
|
|
33
|
-
Ordering Load Balancer list result by name, created_at
|
|
34
|
-
operating_status
|
|
35
|
-
fields of the load balancer and directions (name.asc), default is
|
|
36
|
-
"created_at
|
|
33
|
+
Ordering Load Balancer list result by name, `created_at`, `updated_at`,
|
|
34
|
+
`operating_status`, `provisioning_status`, `vip_address`, `vip_ip_family` and
|
|
35
|
+
flavor fields of the load balancer and directions (name.asc), default is
|
|
36
|
+
"`created_at`.asc"
|
|
37
37
|
"""
|
|
38
38
|
|
|
39
39
|
show_stats: bool
|
|
@@ -45,7 +45,7 @@ class LoadBalancerListParams(TypedDict, total=False):
|
|
|
45
45
|
tag_key_value: str
|
|
46
46
|
"""Filter by tag key-value pairs.
|
|
47
47
|
|
|
48
|
-
Must be a valid JSON string. curl -G --data-urlencode "tag_key_value
|
|
48
|
+
Must be a valid JSON string. curl -G --data-urlencode "`tag_key_value`={"key":
|
|
49
49
|
"value"}" --url "http://localhost:1111/v1/loadbalancers/1/1"
|
|
50
50
|
"""
|
|
51
51
|
|
|
@@ -35,7 +35,7 @@ class LoadBalancerListenerDetail(BaseModel):
|
|
|
35
35
|
insert_headers: object
|
|
36
36
|
"""Dictionary of additional header insertion into HTTP headers.
|
|
37
37
|
|
|
38
|
-
Only used with HTTP and TERMINATED_HTTPS protocols.
|
|
38
|
+
Only used with HTTP and `TERMINATED_HTTPS` protocols.
|
|
39
39
|
"""
|
|
40
40
|
|
|
41
41
|
loadbalancer_id: Optional[str] = None
|
|
@@ -61,14 +61,14 @@ class LoadBalancerListenerDetail(BaseModel):
|
|
|
61
61
|
|
|
62
62
|
secret_id: Optional[str] = None
|
|
63
63
|
"""
|
|
64
|
-
ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or
|
|
65
|
-
load balancer
|
|
64
|
+
ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
|
|
65
|
+
PROMETHEUS load balancer
|
|
66
66
|
"""
|
|
67
67
|
|
|
68
68
|
sni_secret_id: Optional[List[str]] = None
|
|
69
69
|
"""
|
|
70
70
|
List of secret's ID containing PKCS12 format certificate/key bundles for
|
|
71
|
-
TERMINATED_HTTPS or PROMETHEUS listeners
|
|
71
|
+
`TERMINATED_HTTPS` or PROMETHEUS listeners
|
|
72
72
|
"""
|
|
73
73
|
|
|
74
74
|
stats: Optional[LoadBalancerStatistics] = None
|