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
gcore/_base_client.py
CHANGED
|
@@ -960,6 +960,9 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
|
|
|
960
960
|
if self.custom_auth is not None:
|
|
961
961
|
kwargs["auth"] = self.custom_auth
|
|
962
962
|
|
|
963
|
+
if options.follow_redirects is not None:
|
|
964
|
+
kwargs["follow_redirects"] = options.follow_redirects
|
|
965
|
+
|
|
963
966
|
log.debug("Sending HTTP Request: %s %s", request.method, request.url)
|
|
964
967
|
|
|
965
968
|
response = None
|
|
@@ -1068,7 +1071,14 @@ class SyncAPIClient(BaseClient[httpx.Client, Stream[Any]]):
|
|
|
1068
1071
|
) -> ResponseT:
|
|
1069
1072
|
origin = get_origin(cast_to) or cast_to
|
|
1070
1073
|
|
|
1071
|
-
if
|
|
1074
|
+
if (
|
|
1075
|
+
inspect.isclass(origin)
|
|
1076
|
+
and issubclass(origin, BaseAPIResponse)
|
|
1077
|
+
# we only want to actually return the custom BaseAPIResponse class if we're
|
|
1078
|
+
# returning the raw response, or if we're not streaming SSE, as if we're streaming
|
|
1079
|
+
# SSE then `cast_to` doesn't actively reflect the type we need to parse into
|
|
1080
|
+
and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
|
|
1081
|
+
):
|
|
1072
1082
|
if not issubclass(origin, APIResponse):
|
|
1073
1083
|
raise TypeError(f"API Response types must subclass {APIResponse}; Received {origin}")
|
|
1074
1084
|
|
|
@@ -1460,6 +1470,9 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
|
|
|
1460
1470
|
if self.custom_auth is not None:
|
|
1461
1471
|
kwargs["auth"] = self.custom_auth
|
|
1462
1472
|
|
|
1473
|
+
if options.follow_redirects is not None:
|
|
1474
|
+
kwargs["follow_redirects"] = options.follow_redirects
|
|
1475
|
+
|
|
1463
1476
|
log.debug("Sending HTTP Request: %s %s", request.method, request.url)
|
|
1464
1477
|
|
|
1465
1478
|
response = None
|
|
@@ -1568,7 +1581,14 @@ class AsyncAPIClient(BaseClient[httpx.AsyncClient, AsyncStream[Any]]):
|
|
|
1568
1581
|
) -> ResponseT:
|
|
1569
1582
|
origin = get_origin(cast_to) or cast_to
|
|
1570
1583
|
|
|
1571
|
-
if
|
|
1584
|
+
if (
|
|
1585
|
+
inspect.isclass(origin)
|
|
1586
|
+
and issubclass(origin, BaseAPIResponse)
|
|
1587
|
+
# we only want to actually return the custom BaseAPIResponse class if we're
|
|
1588
|
+
# returning the raw response, or if we're not streaming SSE, as if we're streaming
|
|
1589
|
+
# SSE then `cast_to` doesn't actively reflect the type we need to parse into
|
|
1590
|
+
and (not stream or bool(response.request.headers.get(RAW_RESPONSE_HEADER)))
|
|
1591
|
+
):
|
|
1572
1592
|
if not issubclass(origin, AsyncAPIResponse):
|
|
1573
1593
|
raise TypeError(f"API Response types must subclass {AsyncAPIResponse}; Received {origin}")
|
|
1574
1594
|
|
gcore/_models.py
CHANGED
|
@@ -737,6 +737,7 @@ class FinalRequestOptionsInput(TypedDict, total=False):
|
|
|
737
737
|
idempotency_key: str
|
|
738
738
|
json_data: Body
|
|
739
739
|
extra_json: AnyMapping
|
|
740
|
+
follow_redirects: bool
|
|
740
741
|
|
|
741
742
|
|
|
742
743
|
@final
|
|
@@ -750,6 +751,7 @@ class FinalRequestOptions(pydantic.BaseModel):
|
|
|
750
751
|
files: Union[HttpxRequestFiles, None] = None
|
|
751
752
|
idempotency_key: Union[str, None] = None
|
|
752
753
|
post_parser: Union[Callable[[Any], Any], NotGiven] = NotGiven()
|
|
754
|
+
follow_redirects: Union[bool, None] = None
|
|
753
755
|
|
|
754
756
|
# It should be noted that we cannot use `json` here as that would override
|
|
755
757
|
# a BaseModel method in an incompatible fashion.
|
gcore/_types.py
CHANGED
|
@@ -100,6 +100,7 @@ class RequestOptions(TypedDict, total=False):
|
|
|
100
100
|
params: Query
|
|
101
101
|
extra_json: AnyMapping
|
|
102
102
|
idempotency_key: str
|
|
103
|
+
follow_redirects: bool
|
|
103
104
|
|
|
104
105
|
|
|
105
106
|
# Sentinel class used until PEP 0661 is accepted
|
|
@@ -215,3 +216,4 @@ class _GenericAlias(Protocol):
|
|
|
215
216
|
|
|
216
217
|
class HttpxSendArgs(TypedDict, total=False):
|
|
217
218
|
auth: httpx.Auth
|
|
219
|
+
follow_redirects: bool
|
gcore/_version.py
CHANGED
|
@@ -61,7 +61,7 @@ class FlavorsResource(SyncAPIResource):
|
|
|
61
61
|
) -> BaremetalFlavorList:
|
|
62
62
|
"""Retrieve a list of flavors.
|
|
63
63
|
|
|
64
|
-
When the include_prices query parameter is
|
|
64
|
+
When the `include_prices` query parameter is
|
|
65
65
|
specified, the list shows prices. A client in trial mode gets all price values
|
|
66
66
|
as 0. If you get Pricing Error contact the support
|
|
67
67
|
|
|
@@ -212,7 +212,7 @@ class AsyncFlavorsResource(AsyncAPIResource):
|
|
|
212
212
|
) -> BaremetalFlavorList:
|
|
213
213
|
"""Retrieve a list of flavors.
|
|
214
214
|
|
|
215
|
-
When the include_prices query parameter is
|
|
215
|
+
When the `include_prices` query parameter is
|
|
216
216
|
specified, the list shows prices. A client in trial mode gets all price values
|
|
217
217
|
as 0. If you get Pricing Error contact the support
|
|
218
218
|
|
|
@@ -74,7 +74,7 @@ class ImagesResource(SyncAPIResource):
|
|
|
74
74
|
tag_key: Filter by tag keys.
|
|
75
75
|
|
|
76
76
|
tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
|
|
77
|
-
--data-urlencode 'tag_key_value
|
|
77
|
+
--data-urlencode '`tag_key_value`={"key": "value"}' --url
|
|
78
78
|
'http://localhost:1111/v1/images/1/1'"
|
|
79
79
|
|
|
80
80
|
visibility: Image visibility. Globally visible images are public
|
|
@@ -163,7 +163,7 @@ class AsyncImagesResource(AsyncAPIResource):
|
|
|
163
163
|
tag_key: Filter by tag keys.
|
|
164
164
|
|
|
165
165
|
tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
|
|
166
|
-
--data-urlencode 'tag_key_value
|
|
166
|
+
--data-urlencode '`tag_key_value`={"key": "value"}' --url
|
|
167
167
|
'http://localhost:1111/v1/images/1/1'"
|
|
168
168
|
|
|
169
169
|
visibility: Image visibility. Globally visible images are public
|
|
@@ -77,18 +77,15 @@ class ServersResource(SyncAPIResource):
|
|
|
77
77
|
For Linux,
|
|
78
78
|
|
|
79
79
|
- Use the `user_data` field to provide a
|
|
80
|
-
|
|
81
|
-
|
|
80
|
+
[cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
|
|
81
|
+
in base64 to apply configurations to the instance.
|
|
82
82
|
- Specify the `username` and `password` to create a new user.
|
|
83
83
|
- When only `password` is provided, it is set as the password for the default
|
|
84
84
|
user of the image.
|
|
85
|
-
- The `user_data` is ignored when the `password` is specified.
|
|
86
|
-
|
|
87
|
-
For Windows,
|
|
88
|
-
|
|
85
|
+
- The `user_data` is ignored when the `password` is specified. For Windows,
|
|
89
86
|
- Use the `user_data` field to provide a
|
|
90
|
-
|
|
91
|
-
|
|
87
|
+
[cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
|
|
88
|
+
in base64 to create new users on Windows.
|
|
92
89
|
- Use the `password` field to set the password for the 'Admin' user on Windows.
|
|
93
90
|
- The password of the Admin user cannot be updated via `user_data`.
|
|
94
91
|
- The `username` cannot be specified in the request.
|
|
@@ -117,18 +114,18 @@ class ServersResource(SyncAPIResource):
|
|
|
117
114
|
name_template: If you want server names to be automatically generated based on IP addresses,
|
|
118
115
|
you can provide a name template instead of specifying the name manually. The
|
|
119
116
|
template should include a placeholder that will be replaced during provisioning.
|
|
120
|
-
Supported placeholders are: `{ip_octets}` (last 3 octets of the IP),
|
|
121
|
-
`{two_ip_octets}`, and `{one_ip_octet}`.
|
|
117
|
+
Supported placeholders are: `{`ip_octets`}` (last 3 octets of the IP),
|
|
118
|
+
`{`two_ip_octets`}`, and `{`one_ip_octet`}`.
|
|
122
119
|
|
|
123
120
|
password: For Linux instances, 'username' and 'password' are used to create a new user.
|
|
124
121
|
When only 'password' is provided, it is set as the password for the default user
|
|
125
122
|
of the image. For Windows instances, 'username' cannot be specified. Use the
|
|
126
123
|
'password' field to set the password for the 'Admin' user on Windows. Use the
|
|
127
|
-
'user_data' field to provide a script to create new users on Windows. The
|
|
128
|
-
password of the Admin user cannot be updated via 'user_data'.
|
|
124
|
+
'`user_data`' field to provide a script to create new users on Windows. The
|
|
125
|
+
password of the Admin user cannot be updated via '`user_data`'.
|
|
129
126
|
|
|
130
127
|
ssh_key_name: Specifies the name of the SSH keypair, created via the
|
|
131
|
-
|
|
128
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
132
129
|
|
|
133
130
|
tags: Key-value tags to associate with the resource. A tag is a key-value pair that
|
|
134
131
|
can be associated with a resource, enabling efficient filtering and grouping for
|
|
@@ -136,10 +133,10 @@ class ServersResource(SyncAPIResource):
|
|
|
136
133
|
modified by the user. Tags are also integrated with cost reports, allowing cost
|
|
137
134
|
data to be filtered based on tag keys or values.
|
|
138
135
|
|
|
139
|
-
user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
|
|
136
|
+
user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
|
|
140
137
|
'password' field is provided. For Windows instances, Admin user password is set
|
|
141
|
-
by 'password' field and cannot be updated via 'user_data'. Examples of the
|
|
142
|
-
user_data
|
|
138
|
+
by 'password' field and cannot be updated via '`user_data`'. Examples of the
|
|
139
|
+
`user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
143
140
|
|
|
144
141
|
username: For Linux instances, 'username' and 'password' are used to create a new user.
|
|
145
142
|
For Windows instances, 'username' cannot be specified. Use 'password' field to
|
|
@@ -233,9 +230,9 @@ class ServersResource(SyncAPIResource):
|
|
|
233
230
|
changes_since: Filters the instances by a date and time stamp when the instances last changed
|
|
234
231
|
status.
|
|
235
232
|
|
|
236
|
-
flavor_id: Filter out instances by flavor_id
|
|
233
|
+
flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
|
|
237
234
|
|
|
238
|
-
flavor_prefix: Filter out instances by flavor_prefix
|
|
235
|
+
flavor_prefix: Filter out instances by `flavor_prefix`.
|
|
239
236
|
|
|
240
237
|
include_k8s: Include managed k8s worker nodes
|
|
241
238
|
|
|
@@ -258,22 +255,22 @@ class ServersResource(SyncAPIResource):
|
|
|
258
255
|
|
|
259
256
|
order_by: Order by field and direction.
|
|
260
257
|
|
|
261
|
-
profile_name: Filter result by ddos protection profile name. Effective only with with_ddos
|
|
262
|
-
to true.
|
|
258
|
+
profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
|
|
259
|
+
set to true.
|
|
263
260
|
|
|
264
|
-
protection_status: Filter result by DDoS protection_status
|
|
265
|
-
true. (Active, Queued or Error)
|
|
261
|
+
protection_status: Filter result by DDoS `protection_status`. Effective only with `with_ddos` set
|
|
262
|
+
to true. (Active, Queued or Error)
|
|
266
263
|
|
|
267
264
|
status: Filters instances by a server status, as a string.
|
|
268
265
|
|
|
269
266
|
tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
|
|
270
|
-
"tag_key_value
|
|
267
|
+
"`tag_key_value`={"key": "value"}" --url
|
|
271
268
|
"https://example.com/cloud/v1/resource/1/1"
|
|
272
269
|
|
|
273
|
-
tag_value: Optional. Filter by tag values.
|
|
270
|
+
tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
|
|
274
271
|
|
|
275
272
|
type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
|
|
276
|
-
Effective only with with_ddos set to true. (advanced or basic)
|
|
273
|
+
Effective only with `with_ddos` set to true. (advanced or basic)
|
|
277
274
|
|
|
278
275
|
uuid: Filter the server list result by the UUID of the server. Allowed UUID part
|
|
279
276
|
|
|
@@ -355,7 +352,7 @@ class ServersResource(SyncAPIResource):
|
|
|
355
352
|
image_id: Image ID
|
|
356
353
|
|
|
357
354
|
user_data: String in base64 format. Must not be passed together with 'username' or
|
|
358
|
-
'password'. Examples of the user_data
|
|
355
|
+
'password'. Examples of the `user_data`:
|
|
359
356
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
360
357
|
|
|
361
358
|
extra_headers: Send extra headers
|
|
@@ -554,18 +551,15 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
554
551
|
For Linux,
|
|
555
552
|
|
|
556
553
|
- Use the `user_data` field to provide a
|
|
557
|
-
|
|
558
|
-
|
|
554
|
+
[cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
|
|
555
|
+
in base64 to apply configurations to the instance.
|
|
559
556
|
- Specify the `username` and `password` to create a new user.
|
|
560
557
|
- When only `password` is provided, it is set as the password for the default
|
|
561
558
|
user of the image.
|
|
562
|
-
- The `user_data` is ignored when the `password` is specified.
|
|
563
|
-
|
|
564
|
-
For Windows,
|
|
565
|
-
|
|
559
|
+
- The `user_data` is ignored when the `password` is specified. For Windows,
|
|
566
560
|
- Use the `user_data` field to provide a
|
|
567
|
-
|
|
568
|
-
|
|
561
|
+
[cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
|
|
562
|
+
in base64 to create new users on Windows.
|
|
569
563
|
- Use the `password` field to set the password for the 'Admin' user on Windows.
|
|
570
564
|
- The password of the Admin user cannot be updated via `user_data`.
|
|
571
565
|
- The `username` cannot be specified in the request.
|
|
@@ -594,18 +588,18 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
594
588
|
name_template: If you want server names to be automatically generated based on IP addresses,
|
|
595
589
|
you can provide a name template instead of specifying the name manually. The
|
|
596
590
|
template should include a placeholder that will be replaced during provisioning.
|
|
597
|
-
Supported placeholders are: `{ip_octets}` (last 3 octets of the IP),
|
|
598
|
-
`{two_ip_octets}`, and `{one_ip_octet}`.
|
|
591
|
+
Supported placeholders are: `{`ip_octets`}` (last 3 octets of the IP),
|
|
592
|
+
`{`two_ip_octets`}`, and `{`one_ip_octet`}`.
|
|
599
593
|
|
|
600
594
|
password: For Linux instances, 'username' and 'password' are used to create a new user.
|
|
601
595
|
When only 'password' is provided, it is set as the password for the default user
|
|
602
596
|
of the image. For Windows instances, 'username' cannot be specified. Use the
|
|
603
597
|
'password' field to set the password for the 'Admin' user on Windows. Use the
|
|
604
|
-
'user_data' field to provide a script to create new users on Windows. The
|
|
605
|
-
password of the Admin user cannot be updated via 'user_data'.
|
|
598
|
+
'`user_data`' field to provide a script to create new users on Windows. The
|
|
599
|
+
password of the Admin user cannot be updated via '`user_data`'.
|
|
606
600
|
|
|
607
601
|
ssh_key_name: Specifies the name of the SSH keypair, created via the
|
|
608
|
-
|
|
602
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
609
603
|
|
|
610
604
|
tags: Key-value tags to associate with the resource. A tag is a key-value pair that
|
|
611
605
|
can be associated with a resource, enabling efficient filtering and grouping for
|
|
@@ -613,10 +607,10 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
613
607
|
modified by the user. Tags are also integrated with cost reports, allowing cost
|
|
614
608
|
data to be filtered based on tag keys or values.
|
|
615
609
|
|
|
616
|
-
user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
|
|
610
|
+
user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
|
|
617
611
|
'password' field is provided. For Windows instances, Admin user password is set
|
|
618
|
-
by 'password' field and cannot be updated via 'user_data'. Examples of the
|
|
619
|
-
user_data
|
|
612
|
+
by 'password' field and cannot be updated via '`user_data`'. Examples of the
|
|
613
|
+
`user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
620
614
|
|
|
621
615
|
username: For Linux instances, 'username' and 'password' are used to create a new user.
|
|
622
616
|
For Windows instances, 'username' cannot be specified. Use 'password' field to
|
|
@@ -710,9 +704,9 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
710
704
|
changes_since: Filters the instances by a date and time stamp when the instances last changed
|
|
711
705
|
status.
|
|
712
706
|
|
|
713
|
-
flavor_id: Filter out instances by flavor_id
|
|
707
|
+
flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
|
|
714
708
|
|
|
715
|
-
flavor_prefix: Filter out instances by flavor_prefix
|
|
709
|
+
flavor_prefix: Filter out instances by `flavor_prefix`.
|
|
716
710
|
|
|
717
711
|
include_k8s: Include managed k8s worker nodes
|
|
718
712
|
|
|
@@ -735,22 +729,22 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
735
729
|
|
|
736
730
|
order_by: Order by field and direction.
|
|
737
731
|
|
|
738
|
-
profile_name: Filter result by ddos protection profile name. Effective only with with_ddos
|
|
739
|
-
to true.
|
|
732
|
+
profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
|
|
733
|
+
set to true.
|
|
740
734
|
|
|
741
|
-
protection_status: Filter result by DDoS protection_status
|
|
742
|
-
true. (Active, Queued or Error)
|
|
735
|
+
protection_status: Filter result by DDoS `protection_status`. Effective only with `with_ddos` set
|
|
736
|
+
to true. (Active, Queued or Error)
|
|
743
737
|
|
|
744
738
|
status: Filters instances by a server status, as a string.
|
|
745
739
|
|
|
746
740
|
tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
|
|
747
|
-
"tag_key_value
|
|
741
|
+
"`tag_key_value`={"key": "value"}" --url
|
|
748
742
|
"https://example.com/cloud/v1/resource/1/1"
|
|
749
743
|
|
|
750
|
-
tag_value: Optional. Filter by tag values.
|
|
744
|
+
tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
|
|
751
745
|
|
|
752
746
|
type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
|
|
753
|
-
Effective only with with_ddos set to true. (advanced or basic)
|
|
747
|
+
Effective only with `with_ddos` set to true. (advanced or basic)
|
|
754
748
|
|
|
755
749
|
uuid: Filter the server list result by the UUID of the server. Allowed UUID part
|
|
756
750
|
|
|
@@ -832,7 +826,7 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
832
826
|
image_id: Image ID
|
|
833
827
|
|
|
834
828
|
user_data: String in base64 format. Must not be passed together with 'username' or
|
|
835
|
-
'password'. Examples of the user_data
|
|
829
|
+
'password'. Examples of the `user_data`:
|
|
836
830
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
837
831
|
|
|
838
832
|
extra_headers: Send extra headers
|
|
@@ -139,10 +139,10 @@ class FloatingIPsResource(SyncAPIResource):
|
|
|
139
139
|
offset: Optional. Offset value is used to exclude the first set of records from the
|
|
140
140
|
result
|
|
141
141
|
|
|
142
|
-
tag_key: Optional. Filter by tag keys.
|
|
142
|
+
tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
|
|
143
143
|
|
|
144
144
|
tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
|
|
145
|
-
"tag_key_value
|
|
145
|
+
"`tag_key_value`={"key": "value"}" --url
|
|
146
146
|
"https://example.com/cloud/v1/resource/1/1"
|
|
147
147
|
|
|
148
148
|
extra_headers: Send extra headers
|
|
@@ -460,10 +460,10 @@ class AsyncFloatingIPsResource(AsyncAPIResource):
|
|
|
460
460
|
offset: Optional. Offset value is used to exclude the first set of records from the
|
|
461
461
|
result
|
|
462
462
|
|
|
463
|
-
tag_key: Optional. Filter by tag keys.
|
|
463
|
+
tag_key: Optional. Filter by tag keys. ?`tag_key`=key1&`tag_key`=key2
|
|
464
464
|
|
|
465
465
|
tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
|
|
466
|
-
"tag_key_value
|
|
466
|
+
"`tag_key_value`={"key": "value"}" --url
|
|
467
467
|
"https://example.com/cloud/v1/resource/1/1"
|
|
468
468
|
|
|
469
469
|
extra_headers: Send extra headers
|
|
@@ -143,7 +143,7 @@ class GPUBaremetalClustersResource(SyncAPIResource):
|
|
|
143
143
|
instance
|
|
144
144
|
|
|
145
145
|
ssh_key_name: Specifies the name of the SSH keypair, created via the
|
|
146
|
-
|
|
146
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
147
147
|
|
|
148
148
|
tags: Key-value tags to associate with the resource. A tag is a key-value pair that
|
|
149
149
|
can be associated with a resource, enabling efficient filtering and grouping for
|
|
@@ -152,7 +152,7 @@ class GPUBaremetalClustersResource(SyncAPIResource):
|
|
|
152
152
|
data to be filtered based on tag keys or values.
|
|
153
153
|
|
|
154
154
|
user_data: String in base64 format. Must not be passed together with 'username' or
|
|
155
|
-
'password'. Examples of the user_data
|
|
155
|
+
'password'. Examples of the `user_data`:
|
|
156
156
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
157
157
|
|
|
158
158
|
username: A name of a new user in the Linux instance. It may be passed with a 'password'
|
|
@@ -270,7 +270,7 @@ class GPUBaremetalClustersResource(SyncAPIResource):
|
|
|
270
270
|
used with floatings.
|
|
271
271
|
|
|
272
272
|
floatings: Comma separated list of floating ids that should be deleted. Can't be used with
|
|
273
|
-
delete_floatings
|
|
273
|
+
`delete_floatings`.
|
|
274
274
|
|
|
275
275
|
reserved_fixed_ips: Comma separated list of port IDs to be deleted with the servers
|
|
276
276
|
|
|
@@ -449,7 +449,7 @@ class GPUBaremetalClustersResource(SyncAPIResource):
|
|
|
449
449
|
image_id: AI GPU image ID
|
|
450
450
|
|
|
451
451
|
user_data:
|
|
452
|
-
String in base64 format.Examples of the user_data
|
|
452
|
+
String in base64 format.Examples of the `user_data`:
|
|
453
453
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
454
454
|
|
|
455
455
|
extra_headers: Send extra headers
|
|
@@ -765,7 +765,7 @@ class AsyncGPUBaremetalClustersResource(AsyncAPIResource):
|
|
|
765
765
|
instance
|
|
766
766
|
|
|
767
767
|
ssh_key_name: Specifies the name of the SSH keypair, created via the
|
|
768
|
-
|
|
768
|
+
[/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
|
|
769
769
|
|
|
770
770
|
tags: Key-value tags to associate with the resource. A tag is a key-value pair that
|
|
771
771
|
can be associated with a resource, enabling efficient filtering and grouping for
|
|
@@ -774,7 +774,7 @@ class AsyncGPUBaremetalClustersResource(AsyncAPIResource):
|
|
|
774
774
|
data to be filtered based on tag keys or values.
|
|
775
775
|
|
|
776
776
|
user_data: String in base64 format. Must not be passed together with 'username' or
|
|
777
|
-
'password'. Examples of the user_data
|
|
777
|
+
'password'. Examples of the `user_data`:
|
|
778
778
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
779
779
|
|
|
780
780
|
username: A name of a new user in the Linux instance. It may be passed with a 'password'
|
|
@@ -892,7 +892,7 @@ class AsyncGPUBaremetalClustersResource(AsyncAPIResource):
|
|
|
892
892
|
used with floatings.
|
|
893
893
|
|
|
894
894
|
floatings: Comma separated list of floating ids that should be deleted. Can't be used with
|
|
895
|
-
delete_floatings
|
|
895
|
+
`delete_floatings`.
|
|
896
896
|
|
|
897
897
|
reserved_fixed_ips: Comma separated list of port IDs to be deleted with the servers
|
|
898
898
|
|
|
@@ -1071,7 +1071,7 @@ class AsyncGPUBaremetalClustersResource(AsyncAPIResource):
|
|
|
1071
1071
|
image_id: AI GPU image ID
|
|
1072
1072
|
|
|
1073
1073
|
user_data:
|
|
1074
|
-
String in base64 format.Examples of the user_data
|
|
1074
|
+
String in base64 format.Examples of the `user_data`:
|
|
1075
1075
|
https://cloudinit.readthedocs.io/en/latest/topics/examples.html
|
|
1076
1076
|
|
|
1077
1077
|
extra_headers: Send extra headers
|
|
@@ -247,7 +247,7 @@ class ImagesResource(SyncAPIResource):
|
|
|
247
247
|
|
|
248
248
|
url: Image URL
|
|
249
249
|
|
|
250
|
-
architecture: Image architecture type: aarch64, x86_64
|
|
250
|
+
architecture: Image architecture type: aarch64, `x86_64`
|
|
251
251
|
|
|
252
252
|
cow_format: When True, image cannot be deleted unless all volumes, created from it, are
|
|
253
253
|
deleted.
|
|
@@ -590,7 +590,7 @@ class AsyncImagesResource(AsyncAPIResource):
|
|
|
590
590
|
|
|
591
591
|
url: Image URL
|
|
592
592
|
|
|
593
|
-
architecture: Image architecture type: aarch64, x86_64
|
|
593
|
+
architecture: Image architecture type: aarch64, `x86_64`
|
|
594
594
|
|
|
595
595
|
cow_format: When True, image cannot be deleted unless all volumes, created from it, are
|
|
596
596
|
deleted.
|
|
@@ -273,7 +273,7 @@ class ServersResource(SyncAPIResource):
|
|
|
273
273
|
|
|
274
274
|
security_groups: List of security group IDs
|
|
275
275
|
|
|
276
|
-
type: Must be 'any_subnet'
|
|
276
|
+
type: Must be '`any_subnet`'
|
|
277
277
|
|
|
278
278
|
extra_headers: Send extra headers
|
|
279
279
|
|
|
@@ -321,7 +321,7 @@ class ServersResource(SyncAPIResource):
|
|
|
321
321
|
|
|
322
322
|
security_groups: List of security group IDs
|
|
323
323
|
|
|
324
|
-
type: Must be 'reserved_fixed_ip'. Union tag
|
|
324
|
+
type: Must be '`reserved_fixed_ip`'. Union tag
|
|
325
325
|
|
|
326
326
|
extra_headers: Send extra headers
|
|
327
327
|
|
|
@@ -800,7 +800,7 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
800
800
|
|
|
801
801
|
security_groups: List of security group IDs
|
|
802
802
|
|
|
803
|
-
type: Must be 'any_subnet'
|
|
803
|
+
type: Must be '`any_subnet`'
|
|
804
804
|
|
|
805
805
|
extra_headers: Send extra headers
|
|
806
806
|
|
|
@@ -848,7 +848,7 @@ class AsyncServersResource(AsyncAPIResource):
|
|
|
848
848
|
|
|
849
849
|
security_groups: List of security group IDs
|
|
850
850
|
|
|
851
|
-
type: Must be 'reserved_fixed_ip'. Union tag
|
|
851
|
+
type: Must be '`reserved_fixed_ip`'. Union tag
|
|
852
852
|
|
|
853
853
|
extra_headers: Send extra headers
|
|
854
854
|
|
|
@@ -104,7 +104,7 @@ class DeploymentsResource(SyncAPIResource):
|
|
|
104
104
|
name: Inference instance name.
|
|
105
105
|
|
|
106
106
|
auth_enabled: Set to `true` to enable API key authentication for the inference instance.
|
|
107
|
-
`"Authorization": "Bearer
|
|
107
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
108
108
|
for the requests to the instance if enabled
|
|
109
109
|
|
|
110
110
|
command: Command to be executed when running a container from an image.
|
|
@@ -120,7 +120,7 @@ class DeploymentsResource(SyncAPIResource):
|
|
|
120
120
|
logging: Logging configuration for the inference instance
|
|
121
121
|
|
|
122
122
|
probes: Probes configured for all containers of the inference instance. If probes are
|
|
123
|
-
not provided, and the image_name is from a the Model Catalog registry, the
|
|
123
|
+
not provided, and the `image_name` is from a the Model Catalog registry, the
|
|
124
124
|
default probes will be used.
|
|
125
125
|
|
|
126
126
|
api_timeout: Specifies the duration in seconds without any requests after which the
|
|
@@ -200,7 +200,7 @@ class DeploymentsResource(SyncAPIResource):
|
|
|
200
200
|
deployment_name: Inference instance name.
|
|
201
201
|
|
|
202
202
|
auth_enabled: Set to `true` to enable API key authentication for the inference instance.
|
|
203
|
-
`"Authorization": "Bearer
|
|
203
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
204
204
|
for the requests to the instance if enabled
|
|
205
205
|
|
|
206
206
|
command: Command to be executed when running a container from an image.
|
|
@@ -771,7 +771,7 @@ class AsyncDeploymentsResource(AsyncAPIResource):
|
|
|
771
771
|
name: Inference instance name.
|
|
772
772
|
|
|
773
773
|
auth_enabled: Set to `true` to enable API key authentication for the inference instance.
|
|
774
|
-
`"Authorization": "Bearer
|
|
774
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
775
775
|
for the requests to the instance if enabled
|
|
776
776
|
|
|
777
777
|
command: Command to be executed when running a container from an image.
|
|
@@ -787,7 +787,7 @@ class AsyncDeploymentsResource(AsyncAPIResource):
|
|
|
787
787
|
logging: Logging configuration for the inference instance
|
|
788
788
|
|
|
789
789
|
probes: Probes configured for all containers of the inference instance. If probes are
|
|
790
|
-
not provided, and the image_name is from a the Model Catalog registry, the
|
|
790
|
+
not provided, and the `image_name` is from a the Model Catalog registry, the
|
|
791
791
|
default probes will be used.
|
|
792
792
|
|
|
793
793
|
api_timeout: Specifies the duration in seconds without any requests after which the
|
|
@@ -867,7 +867,7 @@ class AsyncDeploymentsResource(AsyncAPIResource):
|
|
|
867
867
|
deployment_name: Inference instance name.
|
|
868
868
|
|
|
869
869
|
auth_enabled: Set to `true` to enable API key authentication for the inference instance.
|
|
870
|
-
`"Authorization": "Bearer
|
|
870
|
+
`"Authorization": "Bearer ****\\**"` or `"X-Api-Key": "****\\**"` header is required
|
|
871
871
|
for the requests to the instance if enabled
|
|
872
872
|
|
|
873
873
|
command: Command to be executed when running a container from an image.
|
|
@@ -61,7 +61,7 @@ class FlavorsResource(SyncAPIResource):
|
|
|
61
61
|
) -> InstanceFlavorList:
|
|
62
62
|
"""Retrieve a list of flavors.
|
|
63
63
|
|
|
64
|
-
When the include_prices query parameter is
|
|
64
|
+
When the `include_prices` query parameter is
|
|
65
65
|
specified, the list shows prices. A client in trial mode gets all price values
|
|
66
66
|
as 0. If you get Pricing Error contact the support
|
|
67
67
|
|
|
@@ -243,7 +243,7 @@ class AsyncFlavorsResource(AsyncAPIResource):
|
|
|
243
243
|
) -> InstanceFlavorList:
|
|
244
244
|
"""Retrieve a list of flavors.
|
|
245
245
|
|
|
246
|
-
When the include_prices query parameter is
|
|
246
|
+
When the `include_prices` query parameter is
|
|
247
247
|
specified, the list shows prices. A client in trial mode gets all price values
|
|
248
248
|
as 0. If you get Pricing Error contact the support
|
|
249
249
|
|
|
@@ -159,7 +159,7 @@ class ImagesResource(SyncAPIResource):
|
|
|
159
159
|
tag_key: Filter by tag keys.
|
|
160
160
|
|
|
161
161
|
tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
|
|
162
|
-
--data-urlencode 'tag_key_value
|
|
162
|
+
--data-urlencode '`tag_key_value`={"key": "value"}' --url
|
|
163
163
|
'http://localhost:1111/v1/images/1/1'"
|
|
164
164
|
|
|
165
165
|
visibility: Image visibility. Globally visible images are public
|
|
@@ -746,7 +746,7 @@ class AsyncImagesResource(AsyncAPIResource):
|
|
|
746
746
|
tag_key: Filter by tag keys.
|
|
747
747
|
|
|
748
748
|
tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. 'curl -G
|
|
749
|
-
--data-urlencode 'tag_key_value
|
|
749
|
+
--data-urlencode '`tag_key_value`={"key": "value"}' --url
|
|
750
750
|
'http://localhost:1111/v1/images/1/1'"
|
|
751
751
|
|
|
752
752
|
visibility: Image visibility. Globally visible images are public
|