gcore 0.1.0a2__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/__init__.py +5 -0
- gcore/_base_client.py +22 -2
- gcore/_client.py +9 -0
- gcore/_models.py +2 -0
- gcore/_types.py +2 -0
- gcore/_utils/_proxy.py +4 -1
- gcore/_utils/_resources_proxy.py +24 -0
- gcore/_version.py +1 -1
- gcore/resources/__init__.py +14 -0
- gcore/resources/cloud/baremetal/flavors.py +2 -2
- gcore/resources/cloud/baremetal/images.py +2 -2
- gcore/resources/cloud/baremetal/servers.py +280 -52
- gcore/resources/cloud/billing_reservations.py +24 -0
- gcore/resources/cloud/file_shares/file_shares.py +16 -0
- gcore/resources/cloud/floating_ips.py +4 -4
- gcore/resources/cloud/gpu_baremetal_clusters/gpu_baremetal_clusters.py +358 -8
- gcore/resources/cloud/gpu_baremetal_clusters/images.py +206 -2
- gcore/resources/cloud/gpu_baremetal_clusters/servers.py +84 -4
- gcore/resources/cloud/inference/deployments/deployments.py +328 -10
- gcore/resources/cloud/instances/flavors.py +2 -2
- gcore/resources/cloud/instances/images.py +318 -2
- gcore/resources/cloud/instances/instances.py +534 -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 +302 -20
- gcore/resources/cloud/load_balancers/l7_policies/rules.py +326 -0
- gcore/resources/cloud/load_balancers/listeners.py +385 -20
- gcore/resources/cloud/load_balancers/load_balancers.py +392 -24
- gcore/resources/cloud/load_balancers/pools/health_monitors.py +24 -0
- gcore/resources/cloud/load_balancers/pools/members.py +34 -6
- gcore/resources/cloud/load_balancers/pools/pools.py +388 -8
- gcore/resources/cloud/networks/networks.py +72 -16
- 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/secrets.py +56 -11
- gcore/resources/cloud/security_groups/security_groups.py +2 -2
- gcore/resources/cloud/ssh_keys.py +2 -2
- gcore/resources/cloud/tasks.py +203 -184
- gcore/resources/cloud/users/role_assignments.py +4 -4
- gcore/resources/cloud/volumes.py +18 -18
- gcore/resources/waap/__init__.py +131 -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 +173 -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 +914 -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 +271 -0
- 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 +391 -0
- gcore/types/cloud/__init__.py +1 -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/billing_reservation_list_params.py +5 -0
- gcore/types/cloud/container_probe_config.py +1 -1
- gcore/types/cloud/container_probe_config_create_param.py +2 -3
- gcore/types/cloud/container_scale_triggers.py +2 -2
- gcore/types/cloud/file_share.py +3 -0
- gcore/types/cloud/file_share_list_params.py +7 -1
- 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 +21 -1
- 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 +206 -9
- gcore/types/cloud/inference/inference.py +5 -5
- 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 +17 -17
- gcore/types/cloud/load_balancer_pool.py +13 -13
- gcore/types/cloud/load_balancer_pool_list.py +99 -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 +6 -4
- gcore/types/cloud/load_balancers/listener_get_params.py +3 -1
- gcore/types/cloud/load_balancers/listener_list_params.py +4 -2
- gcore/types/cloud/load_balancers/listener_update_params.py +5 -3
- gcore/types/cloud/load_balancers/pool_create_params.py +6 -4
- gcore/types/cloud/load_balancers/pool_list_params.py +5 -6
- gcore/types/cloud/load_balancers/pool_update_params.py +6 -4
- gcore/types/cloud/load_balancers/pools/health_monitor_create_params.py +2 -0
- gcore/types/cloud/load_balancers/pools/member_add_params.py +5 -3
- gcore/types/cloud/member.py +2 -2
- gcore/types/cloud/network.py +22 -22
- gcore/types/cloud/network_create_params.py +2 -0
- gcore/types/cloud/network_details.py +25 -24
- gcore/types/cloud/network_list_params.py +15 -10
- gcore/types/cloud/network_update_params.py +2 -0
- gcore/types/cloud/networks/subnet_create_params.py +1 -1
- gcore/types/cloud/networks/subnet_list_params.py +2 -2
- gcore/types/cloud/quota_get_all_response.py +18 -0
- gcore/types/cloud/quota_get_by_region_response.py +18 -0
- gcore/types/cloud/quotas/request_create_params.py +9 -0
- gcore/types/cloud/quotas/request_get_response.py +9 -0
- gcore/types/cloud/quotas/request_list_response.py +9 -0
- 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/secret_list_params.py +24 -0
- 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 -4
- gcore/types/cloud/task_list_params.py +56 -46
- 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 +108 -0
- 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_params.py +30 -0
- gcore/types/waap/domain_list_rule_sets_response.py +10 -0
- gcore/types/waap/domain_update_params.py +12 -0
- gcore/types/waap/domains/__init__.py +47 -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 +48 -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_detailed_domain.py +37 -0
- gcore/types/waap/waap_domain_api_settings.py +22 -0
- gcore/types/waap/waap_domain_ddos_settings.py +31 -0
- gcore/types/waap/waap_domain_policy.py +29 -0
- gcore/types/waap/waap_domain_settings_model.py +15 -0
- gcore/types/waap/waap_domain_status.py +7 -0
- 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_summary_domain.py +26 -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.1.0a2.dist-info → gcore-0.3.0.dist-info}/METADATA +3 -3
- {gcore-0.1.0a2.dist-info → gcore-0.3.0.dist-info}/RECORD +293 -126
- {gcore-0.1.0a2.dist-info → gcore-0.3.0.dist-info}/WHEEL +0 -0
- {gcore-0.1.0a2.dist-info → gcore-0.3.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -25,11 +25,11 @@ class FloatingIPListParams(TypedDict, total=False):
|
|
|
25
25
|
"""
|
|
26
26
|
|
|
27
27
|
tag_key: List[str]
|
|
28
|
-
"""Optional. Filter by tag keys.
|
|
28
|
+
"""Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2"""
|
|
29
29
|
|
|
30
30
|
tag_key_value: str
|
|
31
31
|
"""Optional.
|
|
32
32
|
|
|
33
|
-
Filter by tag key-value pairs. curl -G --data-urlencode "tag_key_value
|
|
33
|
+
Filter by tag key-value pairs. curl -G --data-urlencode "`tag_key_value`={"key":
|
|
34
34
|
"value"}" --url "https://example.com/cloud/v1/resource/1/1"
|
|
35
35
|
"""
|
|
@@ -106,7 +106,7 @@ class GPUBaremetalCluster(BaseModel):
|
|
|
106
106
|
"""String in base64 format.
|
|
107
107
|
|
|
108
108
|
Must not be passed together with 'username' or 'password'. Examples of the
|
|
109
|
-
user_data
|
|
109
|
+
`user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
110
110
|
"""
|
|
111
111
|
|
|
112
112
|
username: Optional[str] = None
|
|
@@ -42,10 +42,17 @@ class GPUBaremetalClusterCreateParams(TypedDict, total=False):
|
|
|
42
42
|
instances_count: int
|
|
43
43
|
"""Number of servers to create"""
|
|
44
44
|
|
|
45
|
+
password: str
|
|
46
|
+
"""A password for a bare metal server.
|
|
47
|
+
|
|
48
|
+
This parameter is used to set a password for the "Admin" user on a Windows
|
|
49
|
+
instance, a default user or a new user on a Linux instance
|
|
50
|
+
"""
|
|
51
|
+
|
|
45
52
|
ssh_key_name: str
|
|
46
53
|
"""
|
|
47
54
|
Specifies the name of the SSH keypair, created via the
|
|
48
|
-
|
|
55
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
49
56
|
"""
|
|
50
57
|
|
|
51
58
|
tags: TagUpdateMapParam
|
|
@@ -58,6 +65,19 @@ class GPUBaremetalClusterCreateParams(TypedDict, total=False):
|
|
|
58
65
|
values.
|
|
59
66
|
"""
|
|
60
67
|
|
|
68
|
+
user_data: str
|
|
69
|
+
"""String in base64 format.
|
|
70
|
+
|
|
71
|
+
Must not be passed together with 'username' or 'password'. Examples of the
|
|
72
|
+
`user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
73
|
+
"""
|
|
74
|
+
|
|
75
|
+
username: str
|
|
76
|
+
"""A name of a new user in the Linux instance.
|
|
77
|
+
|
|
78
|
+
It may be passed with a 'password' parameter
|
|
79
|
+
"""
|
|
80
|
+
|
|
61
81
|
|
|
62
82
|
class InterfaceCreateGPUClusterExternalInterfaceSerializer(TypedDict, total=False):
|
|
63
83
|
type: Required[Literal["external"]]
|
|
@@ -21,7 +21,7 @@ class GPUBaremetalClusterDeleteParams(TypedDict, total=False):
|
|
|
21
21
|
floatings: str
|
|
22
22
|
"""Comma separated list of floating ids that should be deleted.
|
|
23
23
|
|
|
24
|
-
Can't be used with delete_floatings
|
|
24
|
+
Can't be used with `delete_floatings`.
|
|
25
25
|
"""
|
|
26
26
|
|
|
27
27
|
reserved_fixed_ips: str
|
|
@@ -21,6 +21,6 @@ class GPUBaremetalClusterRebuildParams(TypedDict, total=False):
|
|
|
21
21
|
|
|
22
22
|
user_data: Optional[str]
|
|
23
23
|
"""
|
|
24
|
-
String in base64 format.Examples of the user_data
|
|
24
|
+
String in base64 format.Examples of the `user_data`:
|
|
25
25
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
26
26
|
"""
|
|
@@ -92,7 +92,7 @@ class GPUBaremetalClusterServer(BaseModel):
|
|
|
92
92
|
"""GPU server ID"""
|
|
93
93
|
|
|
94
94
|
addresses: Dict[str, List[Address]]
|
|
95
|
-
"""Map of network_name to list of addresses in that network"""
|
|
95
|
+
"""Map of `network_name` to list of addresses in that network"""
|
|
96
96
|
|
|
97
97
|
blackhole_ports: List[BlackholePort]
|
|
98
98
|
"""IP addresses of the instances that are blackholed by DDoS mitigation system"""
|
|
@@ -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]
|
|
@@ -8,7 +8,6 @@ from typing_extensions import Required, Annotated, TypedDict
|
|
|
8
8
|
from ...._utils import PropertyInfo
|
|
9
9
|
from ..ingress_opts_param import IngressOptsParam
|
|
10
10
|
from ..laas_index_retention_policy_param import LaasIndexRetentionPolicyParam
|
|
11
|
-
from ..container_probe_config_create_param import ContainerProbeConfigCreateParam
|
|
12
11
|
|
|
13
12
|
__all__ = [
|
|
14
13
|
"DeploymentUpdateParams",
|
|
@@ -23,6 +22,21 @@ __all__ = [
|
|
|
23
22
|
"ContainerScaleTriggersSqs",
|
|
24
23
|
"Logging",
|
|
25
24
|
"Probes",
|
|
25
|
+
"ProbesLivenessProbe",
|
|
26
|
+
"ProbesLivenessProbeProbe",
|
|
27
|
+
"ProbesLivenessProbeProbeExec",
|
|
28
|
+
"ProbesLivenessProbeProbeHTTPGet",
|
|
29
|
+
"ProbesLivenessProbeProbeTcpSocket",
|
|
30
|
+
"ProbesReadinessProbe",
|
|
31
|
+
"ProbesReadinessProbeProbe",
|
|
32
|
+
"ProbesReadinessProbeProbeExec",
|
|
33
|
+
"ProbesReadinessProbeProbeHTTPGet",
|
|
34
|
+
"ProbesReadinessProbeProbeTcpSocket",
|
|
35
|
+
"ProbesStartupProbe",
|
|
36
|
+
"ProbesStartupProbeProbe",
|
|
37
|
+
"ProbesStartupProbeProbeExec",
|
|
38
|
+
"ProbesStartupProbeProbeHTTPGet",
|
|
39
|
+
"ProbesStartupProbeProbeTcpSocket",
|
|
26
40
|
]
|
|
27
41
|
|
|
28
42
|
|
|
@@ -30,10 +44,10 @@ class DeploymentUpdateParams(TypedDict, total=False):
|
|
|
30
44
|
project_id: int
|
|
31
45
|
"""Project ID"""
|
|
32
46
|
|
|
33
|
-
auth_enabled:
|
|
47
|
+
auth_enabled: bool
|
|
34
48
|
"""Set to `true` to enable API key authentication for the inference instance.
|
|
35
49
|
|
|
36
|
-
`"Authorization": "Bearer
|
|
50
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
37
51
|
for the requests to the instance if enabled
|
|
38
52
|
"""
|
|
39
53
|
|
|
@@ -52,7 +66,7 @@ class DeploymentUpdateParams(TypedDict, total=False):
|
|
|
52
66
|
envs: Optional[Dict[str, str]]
|
|
53
67
|
"""Environment variables for the inference instance."""
|
|
54
68
|
|
|
55
|
-
flavor_name:
|
|
69
|
+
flavor_name: str
|
|
56
70
|
"""Flavor name for the inference instance."""
|
|
57
71
|
|
|
58
72
|
image: Optional[str]
|
|
@@ -146,13 +160,13 @@ class ContainerScaleTriggers(TypedDict, total=False):
|
|
|
146
160
|
gpu_memory: Optional[ContainerScaleTriggersGPUMemory]
|
|
147
161
|
"""GPU memory trigger configuration.
|
|
148
162
|
|
|
149
|
-
Calculated by DCGM_FI_DEV_MEM_COPY_UTIL metric
|
|
163
|
+
Calculated by `DCGM_FI_DEV_MEM_COPY_UTIL` metric
|
|
150
164
|
"""
|
|
151
165
|
|
|
152
166
|
gpu_utilization: Optional[ContainerScaleTriggersGPUUtilization]
|
|
153
167
|
"""GPU utilization trigger configuration.
|
|
154
168
|
|
|
155
|
-
Calculated by DCGM_FI_DEV_GPU_UTIL metric
|
|
169
|
+
Calculated by `DCGM_FI_DEV_GPU_UTIL` metric
|
|
156
170
|
"""
|
|
157
171
|
|
|
158
172
|
http: Optional[ContainerScaleTriggersHTTP]
|
|
@@ -204,12 +218,195 @@ class Logging(TypedDict, total=False):
|
|
|
204
218
|
"""The topic name to stream logs to"""
|
|
205
219
|
|
|
206
220
|
|
|
221
|
+
class ProbesLivenessProbeProbeExec(TypedDict, total=False):
|
|
222
|
+
command: List[str]
|
|
223
|
+
"""Command to be executed inside the running container."""
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
class ProbesLivenessProbeProbeHTTPGet(TypedDict, total=False):
|
|
227
|
+
headers: Dict[str, str]
|
|
228
|
+
"""HTTP headers to be sent with the request."""
|
|
229
|
+
|
|
230
|
+
host: str
|
|
231
|
+
"""Host name to send HTTP request to."""
|
|
232
|
+
|
|
233
|
+
path: str
|
|
234
|
+
"""The endpoint to send the HTTP request to."""
|
|
235
|
+
|
|
236
|
+
port: int
|
|
237
|
+
"""Port number the probe should connect to."""
|
|
238
|
+
|
|
239
|
+
schema: str
|
|
240
|
+
"""Schema to use for the HTTP request."""
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
class ProbesLivenessProbeProbeTcpSocket(TypedDict, total=False):
|
|
244
|
+
port: int
|
|
245
|
+
"""Port number to check if it's open."""
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
class ProbesLivenessProbeProbe(TypedDict, total=False):
|
|
249
|
+
exec: Optional[ProbesLivenessProbeProbeExec]
|
|
250
|
+
"""Exec probe configuration"""
|
|
251
|
+
|
|
252
|
+
failure_threshold: int
|
|
253
|
+
"""The number of consecutive probe failures that mark the container as unhealthy."""
|
|
254
|
+
|
|
255
|
+
http_get: Optional[ProbesLivenessProbeProbeHTTPGet]
|
|
256
|
+
"""HTTP GET probe configuration"""
|
|
257
|
+
|
|
258
|
+
initial_delay_seconds: int
|
|
259
|
+
"""The initial delay before starting the first probe."""
|
|
260
|
+
|
|
261
|
+
period_seconds: int
|
|
262
|
+
"""How often (in seconds) to perform the probe."""
|
|
263
|
+
|
|
264
|
+
success_threshold: int
|
|
265
|
+
"""The number of consecutive successful probes that mark the container as healthy."""
|
|
266
|
+
|
|
267
|
+
tcp_socket: Optional[ProbesLivenessProbeProbeTcpSocket]
|
|
268
|
+
"""TCP socket probe configuration"""
|
|
269
|
+
|
|
270
|
+
timeout_seconds: int
|
|
271
|
+
"""The timeout for each probe."""
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
class ProbesLivenessProbe(TypedDict, total=False):
|
|
275
|
+
enabled: bool
|
|
276
|
+
"""Whether the probe is enabled or not."""
|
|
277
|
+
|
|
278
|
+
probe: ProbesLivenessProbeProbe
|
|
279
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
class ProbesReadinessProbeProbeExec(TypedDict, total=False):
|
|
283
|
+
command: List[str]
|
|
284
|
+
"""Command to be executed inside the running container."""
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
class ProbesReadinessProbeProbeHTTPGet(TypedDict, total=False):
|
|
288
|
+
headers: Dict[str, str]
|
|
289
|
+
"""HTTP headers to be sent with the request."""
|
|
290
|
+
|
|
291
|
+
host: str
|
|
292
|
+
"""Host name to send HTTP request to."""
|
|
293
|
+
|
|
294
|
+
path: str
|
|
295
|
+
"""The endpoint to send the HTTP request to."""
|
|
296
|
+
|
|
297
|
+
port: int
|
|
298
|
+
"""Port number the probe should connect to."""
|
|
299
|
+
|
|
300
|
+
schema: str
|
|
301
|
+
"""Schema to use for the HTTP request."""
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
class ProbesReadinessProbeProbeTcpSocket(TypedDict, total=False):
|
|
305
|
+
port: int
|
|
306
|
+
"""Port number to check if it's open."""
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
class ProbesReadinessProbeProbe(TypedDict, total=False):
|
|
310
|
+
exec: Optional[ProbesReadinessProbeProbeExec]
|
|
311
|
+
"""Exec probe configuration"""
|
|
312
|
+
|
|
313
|
+
failure_threshold: int
|
|
314
|
+
"""The number of consecutive probe failures that mark the container as unhealthy."""
|
|
315
|
+
|
|
316
|
+
http_get: Optional[ProbesReadinessProbeProbeHTTPGet]
|
|
317
|
+
"""HTTP GET probe configuration"""
|
|
318
|
+
|
|
319
|
+
initial_delay_seconds: int
|
|
320
|
+
"""The initial delay before starting the first probe."""
|
|
321
|
+
|
|
322
|
+
period_seconds: int
|
|
323
|
+
"""How often (in seconds) to perform the probe."""
|
|
324
|
+
|
|
325
|
+
success_threshold: int
|
|
326
|
+
"""The number of consecutive successful probes that mark the container as healthy."""
|
|
327
|
+
|
|
328
|
+
tcp_socket: Optional[ProbesReadinessProbeProbeTcpSocket]
|
|
329
|
+
"""TCP socket probe configuration"""
|
|
330
|
+
|
|
331
|
+
timeout_seconds: int
|
|
332
|
+
"""The timeout for each probe."""
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
class ProbesReadinessProbe(TypedDict, total=False):
|
|
336
|
+
enabled: bool
|
|
337
|
+
"""Whether the probe is enabled or not."""
|
|
338
|
+
|
|
339
|
+
probe: ProbesReadinessProbeProbe
|
|
340
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
class ProbesStartupProbeProbeExec(TypedDict, total=False):
|
|
344
|
+
command: List[str]
|
|
345
|
+
"""Command to be executed inside the running container."""
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
class ProbesStartupProbeProbeHTTPGet(TypedDict, total=False):
|
|
349
|
+
headers: Dict[str, str]
|
|
350
|
+
"""HTTP headers to be sent with the request."""
|
|
351
|
+
|
|
352
|
+
host: str
|
|
353
|
+
"""Host name to send HTTP request to."""
|
|
354
|
+
|
|
355
|
+
path: str
|
|
356
|
+
"""The endpoint to send the HTTP request to."""
|
|
357
|
+
|
|
358
|
+
port: int
|
|
359
|
+
"""Port number the probe should connect to."""
|
|
360
|
+
|
|
361
|
+
schema: str
|
|
362
|
+
"""Schema to use for the HTTP request."""
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
class ProbesStartupProbeProbeTcpSocket(TypedDict, total=False):
|
|
366
|
+
port: int
|
|
367
|
+
"""Port number to check if it's open."""
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
class ProbesStartupProbeProbe(TypedDict, total=False):
|
|
371
|
+
exec: Optional[ProbesStartupProbeProbeExec]
|
|
372
|
+
"""Exec probe configuration"""
|
|
373
|
+
|
|
374
|
+
failure_threshold: int
|
|
375
|
+
"""The number of consecutive probe failures that mark the container as unhealthy."""
|
|
376
|
+
|
|
377
|
+
http_get: Optional[ProbesStartupProbeProbeHTTPGet]
|
|
378
|
+
"""HTTP GET probe configuration"""
|
|
379
|
+
|
|
380
|
+
initial_delay_seconds: int
|
|
381
|
+
"""The initial delay before starting the first probe."""
|
|
382
|
+
|
|
383
|
+
period_seconds: int
|
|
384
|
+
"""How often (in seconds) to perform the probe."""
|
|
385
|
+
|
|
386
|
+
success_threshold: int
|
|
387
|
+
"""The number of consecutive successful probes that mark the container as healthy."""
|
|
388
|
+
|
|
389
|
+
tcp_socket: Optional[ProbesStartupProbeProbeTcpSocket]
|
|
390
|
+
"""TCP socket probe configuration"""
|
|
391
|
+
|
|
392
|
+
timeout_seconds: int
|
|
393
|
+
"""The timeout for each probe."""
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
class ProbesStartupProbe(TypedDict, total=False):
|
|
397
|
+
enabled: bool
|
|
398
|
+
"""Whether the probe is enabled or not."""
|
|
399
|
+
|
|
400
|
+
probe: ProbesStartupProbeProbe
|
|
401
|
+
"""Probe configuration (exec, `http_get` or `tcp_socket`)"""
|
|
402
|
+
|
|
403
|
+
|
|
207
404
|
class Probes(TypedDict, total=False):
|
|
208
|
-
liveness_probe: Optional[
|
|
405
|
+
liveness_probe: Optional[ProbesLivenessProbe]
|
|
209
406
|
"""Liveness probe configuration"""
|
|
210
407
|
|
|
211
|
-
readiness_probe: Optional[
|
|
408
|
+
readiness_probe: Optional[ProbesReadinessProbe]
|
|
212
409
|
"""Readiness probe configuration"""
|
|
213
410
|
|
|
214
|
-
startup_probe: Optional[
|
|
411
|
+
startup_probe: Optional[ProbesStartupProbe]
|
|
215
412
|
"""Startup probe configuration"""
|
|
@@ -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
|
|
|
@@ -70,10 +70,8 @@ class Inference(BaseModel):
|
|
|
70
70
|
project_id: int
|
|
71
71
|
"""Project ID. If not provided, your default project ID will be used."""
|
|
72
72
|
|
|
73
|
-
status: Literal["ACTIVE", "DELETING", "DEPLOYING", "DISABLED", "PARTIALLYDEPLOYED"]
|
|
74
|
-
"""Inference instance status.
|
|
75
|
-
|
|
76
|
-
Value can be one of the following:
|
|
73
|
+
status: Literal["ACTIVE", "DELETING", "DEPLOYING", "DISABLED", "PARTIALLYDEPLOYED", "PENDING"]
|
|
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
|
|
@@ -83,6 +81,8 @@ class Inference(BaseModel):
|
|
|
83
81
|
explains the failure reason.
|
|
84
82
|
- `ACTIVE` - The instance is running and ready to accept requests.
|
|
85
83
|
- `DISABLED` - The instance is disabled and not accepting any requests.
|
|
84
|
+
- `PENDING` - The instance is running but scaled to zero. It will be
|
|
85
|
+
automatically scaled up when a request is made.
|
|
86
86
|
- `DELETING` - The instance is being deleted.
|
|
87
87
|
"""
|
|
88
88
|
|
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"""
|