diff --git a/README.md b/README.md
index a7d9dc5..6a4e387 100644
--- a/README.md
+++ b/README.md
@@ -79,7 +79,7 @@ make package
Then install the built wheel:
```bash
-pip install dist/osc_sdk_python-0.41.0-py3-none-any.whl
+pip install dist/osc_sdk_python-0.42.0-py3-none-any.whl
```
---
diff --git a/osc_sdk_python/VERSION b/osc_sdk_python/VERSION
index 72a8a63..787ffc3 100644
--- a/osc_sdk_python/VERSION
+++ b/osc_sdk_python/VERSION
@@ -1 +1 @@
-0.41.0
+0.42.0
diff --git a/osc_sdk_python/generated/oks/__init__.py b/osc_sdk_python/generated/oks/__init__.py
index 3226057..c97f220 100644
--- a/osc_sdk_python/generated/oks/__init__.py
+++ b/osc_sdk_python/generated/oks/__init__.py
@@ -6,8 +6,11 @@
from .async_client import AsyncOksTypedMixin
from .models import (
+ AccessKey,
AdmissionFlags,
AdmissionFlagsInput,
+ AdmissionPlugins,
+ AdmissionPluginsResponse,
AuthStrategy,
AutoMaintenances,
AutoUpgradeMaintenance,
@@ -20,18 +23,30 @@
ClusterUpdate,
ControlPlanesResponse,
CreateClusterRequest,
+ CreateEimUserRequest,
CreateProjectRequest,
Cursor,
DeleteClusterRequest,
+ DeleteEimUserRequest,
DeleteProjectRequest,
DetailResponse,
+ DetailsResponse,
+ EimUser,
+ EimUserResponse,
+ EimUserType,
+ EimUserTypesResponse,
+ EimUsersResponse,
+ EnryptedResponse,
ErrorItem,
ErrorResponse,
+ GetAdmissionPluginsRequest,
GetCPSubregionsRequest,
GetClientIPRequest,
GetClusterRequest,
GetClusterTemplateRequest,
GetControlPlanePlansRequest,
+ GetEimUserTypesRequest,
+ GetEimUsersRequest,
GetKubeconfigRequest,
GetKubeconfigWithPubkeyNACLRequest,
GetKubernetesVersionsRequest,
@@ -58,6 +73,7 @@
Net,
NetPeeringAcceptance,
NetPeeringRequest,
+ NetSpecific,
NetsResponse,
Nodepool,
OKSQuotas,
@@ -109,8 +125,11 @@
__all__ = [
"AsyncOksTypedMixin",
+ 'AccessKey',
'AdmissionFlags',
'AdmissionFlagsInput',
+ 'AdmissionPlugins',
+ 'AdmissionPluginsResponse',
'AuthStrategy',
'AutoMaintenances',
'AutoUpgradeMaintenance',
@@ -123,18 +142,30 @@
'ClusterUpdate',
'ControlPlanesResponse',
'CreateClusterRequest',
+ 'CreateEimUserRequest',
'CreateProjectRequest',
'Cursor',
'DeleteClusterRequest',
+ 'DeleteEimUserRequest',
'DeleteProjectRequest',
'DetailResponse',
+ 'DetailsResponse',
+ 'EimUser',
+ 'EimUserResponse',
+ 'EimUserType',
+ 'EimUserTypesResponse',
+ 'EimUsersResponse',
+ 'EnryptedResponse',
'ErrorItem',
'ErrorResponse',
+ 'GetAdmissionPluginsRequest',
'GetCPSubregionsRequest',
'GetClientIPRequest',
'GetClusterRequest',
'GetClusterTemplateRequest',
'GetControlPlanePlansRequest',
+ 'GetEimUserTypesRequest',
+ 'GetEimUsersRequest',
'GetKubeconfigRequest',
'GetKubeconfigWithPubkeyNACLRequest',
'GetKubernetesVersionsRequest',
@@ -161,6 +192,7 @@
'Net',
'NetPeeringAcceptance',
'NetPeeringRequest',
+ 'NetSpecific',
'NetsResponse',
'Nodepool',
'OKSQuotas',
diff --git a/osc_sdk_python/generated/oks/async_client.py b/osc_sdk_python/generated/oks/async_client.py
index 9284ba7..312db3c 100644
--- a/osc_sdk_python/generated/oks/async_client.py
+++ b/osc_sdk_python/generated/oks/async_client.py
@@ -16,20 +16,29 @@
from osc_sdk_python.exceptions import SdkResponseError, SdkValidationError
from osc_sdk_python.runtime.request import RequestSpec
from .models import (
+ AdmissionPluginsResponse,
CPSubregionsResponse,
ClusterResponse,
ClusterResponseList,
ControlPlanesResponse,
CreateClusterRequest,
+ CreateEimUserRequest,
CreateProjectRequest,
DeleteClusterRequest,
+ DeleteEimUserRequest,
DeleteProjectRequest,
DetailResponse,
+ DetailsResponse,
+ EimUserTypesResponse,
+ EimUsersResponse,
+ GetAdmissionPluginsRequest,
GetCPSubregionsRequest,
GetClientIPRequest,
GetClusterRequest,
GetClusterTemplateRequest,
GetControlPlanePlansRequest,
+ GetEimUserTypesRequest,
+ GetEimUsersRequest,
GetKubeconfigRequest,
GetKubeconfigWithPubkeyNACLRequest,
GetKubernetesVersionsRequest,
@@ -340,6 +349,117 @@ async def get_project_nets(
)
return _validate_response(NetsResponse, response)
+ async def get_eim_users(
+ self,
+ request: GetEimUsersRequest | None = None,
+ ) -> EimUsersResponse:
+ request = _validate_request(GetEimUsersRequest, request)
+
+ path_params = {
+ 'project_id': request.project_id,
+ }
+ query_params = {
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="oks",
+ method="GET",
+ path="/projects/{project_id}/eim_users",
+ json_body=None,
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(EimUsersResponse, response)
+
+ async def create_eim_user(
+ self,
+ request: CreateEimUserRequest | None = None,
+ ) -> EimUserResponse | EnryptedResponse:
+ request = _validate_request(CreateEimUserRequest, request)
+
+ path_params = {
+ 'project_id': request.project_id,
+ }
+ query_params = {
+ 'user': request.user,
+ 'ttl': request.ttl,
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="oks",
+ method="POST",
+ path="/projects/{project_id}/eim_users",
+ json_body=None,
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(EimUserResponse | EnryptedResponse, response)
+
+ async def get_eim_user_types(
+ self,
+ request: GetEimUserTypesRequest | None = None,
+ ) -> EimUserTypesResponse:
+ request = _validate_request(GetEimUserTypesRequest, request)
+
+ path_params = {
+ 'project_id': request.project_id,
+ }
+ query_params = {
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="oks",
+ method="GET",
+ path="/projects/{project_id}/eim_users/types",
+ json_body=None,
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(EimUserTypesResponse, response)
+
+ async def delete_eim_user(
+ self,
+ request: DeleteEimUserRequest | None = None,
+ ) -> DetailsResponse:
+ request = _validate_request(DeleteEimUserRequest, request)
+
+ path_params = {
+ 'project_id': request.project_id,
+ 'user': request.user,
+ }
+ query_params = {
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="oks",
+ method="DELETE",
+ path="/projects/{project_id}/eim_users/{user}",
+ json_body=None,
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(DetailsResponse, response)
+
async def list_clusters_by_project_id(
self,
request: ListClustersByProjectIDRequest | None = None,
@@ -679,6 +799,33 @@ async def get_control_plane_plans(
)
return _validate_response(ControlPlanesResponse, response)
+ async def get_admission_plugins(
+ self,
+ request: GetAdmissionPluginsRequest | None = None,
+ ) -> AdmissionPluginsResponse:
+ request = _validate_request(GetAdmissionPluginsRequest, request)
+
+ path_params = {
+ }
+ query_params = {
+ 'version': request.version,
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="oks",
+ method="GET",
+ path="/clusters/limits/admission_plugins",
+ json_body=None,
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(AdmissionPluginsResponse, response)
+
async def get_project_template(
self,
request: GetProjectTemplateRequest | None = None,
diff --git a/osc_sdk_python/generated/oks/models.py b/osc_sdk_python/generated/oks/models.py
index 8644e6d..802d3d5 100644
--- a/osc_sdk_python/generated/oks/models.py
+++ b/osc_sdk_python/generated/oks/models.py
@@ -12,7 +12,7 @@
import datetime
-from typing import Literal
+from typing import Any, Literal
from pydantic import BaseModel, ConfigDict, Field
@@ -21,6 +21,13 @@ class GeneratedModel(BaseModel):
model_config = ConfigDict(populate_by_name=True, extra="allow")
+class AccessKey(GeneratedModel):
+ state: Literal['ACTIVE', 'INACTIVE'] = Field(alias='State')
+ access_key_id: str = Field(alias='AccessKeyId')
+ creation_date: str = Field(alias='CreationDate')
+ expiration_date: Any | None = Field(default=None, alias='ExpirationDate')
+ secret_key: Any | None = Field(default=None, alias='SecretKey')
+
class AdmissionFlags(GeneratedModel):
disable_admission_plugins: list[str] | None = Field(default=None, alias='disable_admission_plugins')
enable_admission_plugins: list[str] | None = Field(default=None, alias='enable_admission_plugins')
@@ -30,8 +37,17 @@ class AdmissionFlagsInput(GeneratedModel):
disable_admission_plugins: list[str] | None = Field(default=None, alias='disable_admission_plugins')
enable_admission_plugins: list[str] | None = Field(default=None, alias='enable_admission_plugins')
+class AdmissionPlugins(GeneratedModel):
+ enable_admission_plugins: list[str] = Field(alias='EnableAdmissionPlugins')
+ disable_admission_plugins: list[str] = Field(alias='DisableAdmissionPlugins')
+ default_admission_plugins: list[str] = Field(alias='DefaultAdmissionPlugins')
+
+class AdmissionPluginsResponse(GeneratedModel):
+ response_context: clusters__cluster_schema__ResponseContext = Field(alias='ResponseContext')
+ admission_plugins: AdmissionPlugins = Field(alias='AdmissionPlugins')
+
class AuthStrategy(GeneratedModel):
- oidc: OpenIdConnectConfig = Field(alias='oidc')
+ oidc: Any | None = Field(default=None, alias='oidc')
class AutoMaintenances(GeneratedModel):
minor_upgrade_maintenance: MaintenanceWindow = Field(alias='minor_upgrade_maintenance')
@@ -54,7 +70,7 @@ class Cluster(GeneratedModel):
cp_multi_az: bool = Field(alias='cp_multi_az')
cp_subregions: list[str] = Field(alias='cp_subregions')
version: str = Field(alias='version')
- expected_version: str | None = Field(default=None, alias='expected_version')
+ expected_version: Any | None = Field(default=None, alias='expected_version')
cni: str = Field(alias='cni')
admin_lbu: bool = Field(alias='admin_lbu')
admission_flags: AdmissionFlags = Field(alias='admission_flags')
@@ -62,39 +78,40 @@ class Cluster(GeneratedModel):
cidr_service: str = Field(alias='cidr_service')
cluster_dns: str = Field(alias='cluster_dns')
tags: dict[str, str] = Field(alias='tags')
- auto_maintenances: AutoMaintenances | None = Field(default=None, alias='auto_maintenances')
- maintenance_window: Maintenance | None = Field(default=None, alias='maintenance_window')
+ auto_maintenances: Any | None = Field(default=None, alias='auto_maintenances')
+ maintenance_window: Any | None = Field(default=None, alias='maintenance_window')
control_planes: str = Field(alias='control_planes')
- expected_control_planes: str | None = Field(default=None, alias='expected_control_planes')
+ expected_control_planes: Any | None = Field(default=None, alias='expected_control_planes')
admin_whitelist: list[str] = Field(alias='admin_whitelist')
statuses: Statuses = Field(alias='statuses')
disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
- auth: AuthStrategy | None = Field(default=None, alias='auth')
+ auth: Any | None = Field(default=None, alias='auth')
class ClusterInput(GeneratedModel):
name: str = Field(alias='name')
project_id: str = Field(alias='project_id')
- description: str | None = Field(default=None, alias='description')
+ description: Any | None = Field(default=None, alias='description')
cp_multi_az: bool | None = Field(default=None, alias='cp_multi_az')
cp_subregions: list[str] | None = Field(default=None, alias='cp_subregions')
version: str = Field(alias='version')
admin_lbu: bool | None = Field(default=None, alias='admin_lbu')
admission_flags: AdmissionFlagsInput | None = Field(default=None, alias='admission_flags')
+ cni: Any | None = Field(default=None, alias='cni')
cidr_pods: str = Field(alias='cidr_pods')
cidr_service: str = Field(alias='cidr_service')
cluster_dns: str | None = Field(default=None, alias='cluster_dns')
- tags: dict[str, str] | None = Field(default=None, alias='tags')
+ tags: Any | None = Field(default=None, alias='tags')
auto_maintenances: AutoMaintenances | None = Field(default=None, alias='auto_maintenances')
maintenance_window: Maintenance | None = Field(default=None, alias='maintenance_window')
control_planes: str | None = Field(default=None, alias='control_planes')
admin_whitelist: list[str] = Field(alias='admin_whitelist')
- quirks: list[str] | None = Field(default=None, alias='quirks')
+ quirks: Any | None = Field(default=None, alias='quirks')
disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
- auth: AuthStrategy | None = Field(default=None, alias='auth')
+ auth: Any | None = Field(default=None, alias='auth')
class ClusterInputTemplate(GeneratedModel):
project_id: str = Field(alias='project_id')
- description: str | None = Field(default=None, alias='description')
+ description: Any | None = Field(default=None, alias='description')
version: str = Field(alias='version')
admin_lbu: bool | None = Field(default=None, alias='admin_lbu')
admission_flags: AdmissionFlagsInput | None = Field(default=None, alias='admission_flags')
@@ -102,11 +119,11 @@ class ClusterInputTemplate(GeneratedModel):
cidr_service: str | None = Field(default=None, alias='cidr_service')
cluster_dns: str | None = Field(default=None, alias='cluster_dns')
tags: dict[str, str] | None = Field(default=None, alias='tags')
- auto_maintenances: AutoMaintenances | None = Field(default=None, alias='auto_maintenances')
- maintenance_window: Maintenance | None = Field(default=None, alias='maintenance_window')
+ auto_maintenances: Any | None = Field(default=None, alias='auto_maintenances')
+ maintenance_window: Any | None = Field(default=None, alias='maintenance_window')
control_planes: str | None = Field(default=None, alias='control_planes')
admin_whitelist: list[str] = Field(alias='admin_whitelist')
- quirks: list[str] | None = Field(default=None, alias='quirks')
+ quirks: Any | None = Field(default=None, alias='quirks')
disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
class ClusterResponse(GeneratedModel):
@@ -119,29 +136,57 @@ class ClusterResponseList(GeneratedModel):
clusters: list[Cluster] = Field(alias='Clusters')
class ClusterUpdate(GeneratedModel):
- description: str | None = Field(default=None, alias='description')
- admission_flags: AdmissionFlagsInput | None = Field(default=None, alias='admission_flags')
- tags: dict[str, str] | None = Field(default=None, alias='tags')
- auto_maintenances: AutoMaintenances | None = Field(default=None, alias='auto_maintenances')
- maintenance_window: Maintenance | None = Field(default=None, alias='maintenance_window')
- admin_whitelist: list[str] | None = Field(default=None, alias='admin_whitelist')
- quirks: list[str] | None = Field(default=None, alias='quirks')
- disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
- version: str | None = Field(default=None, alias='version')
+ description: Any | None = Field(default=None, alias='description')
+ admission_flags: Any | None = Field(default=None, alias='admission_flags')
+ tags: Any | None = Field(default=None, alias='tags')
+ auto_maintenances: Any | None = Field(default=None, alias='auto_maintenances')
+ maintenance_window: Any | None = Field(default=None, alias='maintenance_window')
+ admin_whitelist: Any | None = Field(default=None, alias='admin_whitelist')
+ quirks: Any | None = Field(default=None, alias='quirks')
+ disable_api_termination: Any | None = Field(default=None, alias='disable_api_termination')
+ version: Any | None = Field(default=None, alias='version')
control_planes: str | None = Field(default=None, alias='control_planes')
- auth: AuthStrategy | None = Field(default=None, alias='auth')
+ auth: Any | None = Field(default=None, alias='auth')
class ControlPlanesResponse(GeneratedModel):
response_context: clusters__cluster_schema__ResponseContext = Field(alias='ResponseContext')
control_planes: list[str] = Field(alias='ControlPlanes')
class Cursor(GeneratedModel):
- next_cursor: str | None = Field(default=None, alias='next_cursor')
+ next_cursor: Any | None = Field(default=None, alias='next_cursor')
class DetailResponse(GeneratedModel):
response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
detail: str = Field(alias='detail')
+class DetailsResponse(GeneratedModel):
+ response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
+ details: str = Field(alias='Details')
+
+class EimUser(GeneratedModel):
+ user_name: str = Field(alias='UserName')
+ access_keys: list[AccessKey] | None = Field(default=None, alias='AccessKeys')
+
+class EimUserResponse(GeneratedModel):
+ response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
+ eim_user: EimUser = Field(alias='EimUser')
+
+class EimUserType(GeneratedModel):
+ user_type: str = Field(alias='UserType')
+ description: Any = Field(alias='Description')
+
+class EimUserTypesResponse(GeneratedModel):
+ response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
+ eim_user_types: list[EimUserType] = Field(alias='EimUserTypes')
+
+class EimUsersResponse(GeneratedModel):
+ response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
+ eim_users: list[EimUser] | None = Field(default=None, alias='EimUsers')
+
+class EnryptedResponse(GeneratedModel):
+ response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
+ data: str = Field(alias='Data')
+
class ErrorItem(GeneratedModel):
type: str = Field(alias='Type')
details: str | list[ValidationDetail] = Field(alias='Details')
@@ -152,7 +197,7 @@ class ErrorResponse(GeneratedModel):
response_context: ResponseContext_Input = Field(alias='ResponseContext')
class IPDetails(GeneratedModel):
- x_real_ip: str | None = Field(default=None, alias='x_real_ip')
+ x_real_ip: Any | None = Field(default=None, alias='x_real_ip')
class IPResponse(GeneratedModel):
response_context: myip__myip_schema__ResponseContext = Field(alias='ResponseContext')
@@ -201,6 +246,9 @@ class NetPeeringRequest(GeneratedModel):
metadata: netpeerings__netpeering_schema__Metadata = Field(alias='metadata')
spec: SpecNetPeeringRequest = Field(alias='spec')
+class NetSpecific(GeneratedModel):
+ disable_lan_security_groups: bool = Field(alias='disable_lan_security_groups')
+
class NetsResponse(GeneratedModel):
response_context: projects__project_schema__ResponseContext = Field(alias='ResponseContext')
nets: list[Net] = Field(alias='Nets')
@@ -218,22 +266,22 @@ class OKSQuotas(GeneratedModel):
cp_subregions: list[str] = Field(alias='CPSubregions')
class Offset(GeneratedModel):
- page: int | None = Field(default=None, alias='page')
- limit: int | None = Field(default=None, alias='limit')
- total: int | None = Field(default=None, alias='total')
+ page: Any | None = Field(default=None, alias='page')
+ limit: Any | None = Field(default=None, alias='limit')
+ total: Any | None = Field(default=None, alias='total')
class OpenIdConnectConfig(GeneratedModel):
issuer_url: str = Field(alias='issuer-url')
client_id: str = Field(alias='client-id')
- username_claim: str | None = Field(default=None, alias='username-claim')
- username_prefix: str | None = Field(default=None, alias='username-prefix')
- groups_claim: list[str] | None = Field(default=None, alias='groups-claim')
- groups_prefix: str | None = Field(default=None, alias='groups-prefix')
- required_claim: dict[str, str] | None = Field(default=None, alias='required-claim')
+ username_claim: Any | None = Field(default=None, alias='username-claim')
+ username_prefix: Any | None = Field(default=None, alias='username-prefix')
+ groups_claim: Any | None = Field(default=None, alias='groups-claim')
+ groups_prefix: Any | None = Field(default=None, alias='groups-prefix')
+ required_claim: Any | None = Field(default=None, alias='required-claim')
class Pagination(GeneratedModel):
- cursor: Cursor | None = Field(default=None, alias='cursor')
- offset: Offset | None = Field(default=None, alias='offset')
+ cursor: Any | None = Field(default=None, alias='cursor')
+ offset: Any | None = Field(default=None, alias='offset')
class PermissionsOnResource(GeneratedModel):
global_permission: int = Field(alias='GlobalPermission')
@@ -247,18 +295,20 @@ class Project(GeneratedModel):
region: str = Field(alias='region')
status: str = Field(alias='status')
tags: dict[str, str] = Field(alias='tags')
+ net_specific: Any | None = Field(default=None, alias='net_specific')
disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
created_at: datetime.datetime = Field(alias='created_at')
updated_at: datetime.datetime = Field(alias='updated_at')
- deleted_at: datetime.datetime | None = Field(default=None, alias='deleted_at')
+ deleted_at: Any | None = Field(default=None, alias='deleted_at')
class ProjectInput(GeneratedModel):
name: str = Field(alias='name')
description: str | None = Field(default=None, alias='description')
cidr: str = Field(alias='cidr')
region: str = Field(alias='region')
- tags: dict[str, str] | None = Field(default=None, alias='tags')
- quirks: list[str] | None = Field(default=None, alias='quirks')
+ tags: Any | None = Field(default=None, alias='tags')
+ net_specific: Any | None = Field(default=None, alias='net_specific')
+ quirks: Any | None = Field(default=None, alias='quirks')
disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
class ProjectResponse(GeneratedModel):
@@ -271,10 +321,10 @@ class ProjectResponseList(GeneratedModel):
projects: list[Project] = Field(alias='Projects')
class ProjectUpdate(GeneratedModel):
- description: str | None = Field(default=None, alias='description')
- tags: dict[str, str] | None = Field(default=None, alias='tags')
- quirks: list[str] | None = Field(default=None, alias='quirks')
- disable_api_termination: bool | None = Field(default=None, alias='disable_api_termination')
+ description: Any | None = Field(default=None, alias='description')
+ tags: Any | None = Field(default=None, alias='tags')
+ quirks: Any | None = Field(default=None, alias='quirks')
+ disable_api_termination: Any | None = Field(default=None, alias='disable_api_termination')
class PublicIp(GeneratedModel):
tags: list[ResourceTag] = Field(alias='Tags')
@@ -338,9 +388,9 @@ class SpecNetPeeringRequest(GeneratedModel):
class Statuses(GeneratedModel):
created_at: datetime.datetime = Field(alias='created_at')
- deleted_at: datetime.datetime | None = Field(default=None, alias='deleted_at')
- updated_at: datetime.datetime | None = Field(default=None, alias='updated_at')
- status: str | None = Field(default=None, alias='status')
+ deleted_at: Any | None = Field(default=None, alias='deleted_at')
+ updated_at: Any | None = Field(default=None, alias='updated_at')
+ status: Any | None = Field(default=None, alias='status')
available_upgrade: str | None = Field(default=None, alias='available_upgrade')
class Subregion(GeneratedModel):
@@ -424,13 +474,13 @@ class templates__template_schema__ResponseContext(GeneratedModel):
request_id: str = Field(alias='RequestId')
class ListProjectsRequest(GeneratedModel):
- name: str | None = Field(default=None, alias='name')
- status: str | None = Field(default=None, alias='status')
- cidr: str | None = Field(default=None, alias='cidr')
- deleted: bool | None = Field(default=None, alias='deleted')
- cursor: str | None = Field(default=None, alias='cursor')
- page: int | None = Field(default=None, alias='page')
- limit: int | None = Field(default=None, alias='limit')
+ name: Any | None = Field(default=None, alias='name')
+ status: Any | None = Field(default=None, alias='status')
+ cidr: Any | None = Field(default=None, alias='cidr')
+ deleted: Any | None = Field(default=None, alias='deleted')
+ cursor: Any | None = Field(default=None, alias='cursor')
+ page: Any | None = Field(default=None, alias='page')
+ limit: Any | None = Field(default=None, alias='limit')
class CreateProjectRequest(GeneratedModel):
body: ProjectInput = Field(alias='body')
@@ -457,27 +507,42 @@ class GetProjectPublicIpsRequest(GeneratedModel):
class GetProjectNetsRequest(GeneratedModel):
project_id: str = Field(alias='project_id')
+class GetEimUsersRequest(GeneratedModel):
+ project_id: str = Field(alias='project_id')
+
+class CreateEimUserRequest(GeneratedModel):
+ project_id: str = Field(alias='project_id')
+ user: str = Field(alias='user')
+ ttl: Any | None = Field(default=None, alias='ttl')
+
+class GetEimUserTypesRequest(GeneratedModel):
+ project_id: str = Field(alias='project_id')
+
+class DeleteEimUserRequest(GeneratedModel):
+ project_id: str = Field(alias='project_id')
+ user: str = Field(alias='user')
+
class ListClustersByProjectIDRequest(GeneratedModel):
- project_id: str | None = Field(default=None, alias='project_id')
- name: str | None = Field(default=None, alias='name')
- status: str | None = Field(default=None, alias='status')
- version: str | None = Field(default=None, alias='version')
- deleted: bool | None = Field(default=None, alias='deleted')
- cursor: str | None = Field(default=None, alias='cursor')
- page: int | None = Field(default=None, alias='page')
- limit: int | None = Field(default=None, alias='limit')
+ project_id: Any | None = Field(default=None, alias='project_id')
+ name: Any | None = Field(default=None, alias='name')
+ status: Any | None = Field(default=None, alias='status')
+ version: Any | None = Field(default=None, alias='version')
+ deleted: Any | None = Field(default=None, alias='deleted')
+ cursor: Any | None = Field(default=None, alias='cursor')
+ page: Any | None = Field(default=None, alias='page')
+ limit: Any | None = Field(default=None, alias='limit')
class CreateClusterRequest(GeneratedModel):
body: ClusterInput = Field(alias='body')
class ListAllClustersRequest(GeneratedModel):
- name: str | None = Field(default=None, alias='name')
- status: str | None = Field(default=None, alias='status')
- version: str | None = Field(default=None, alias='version')
- deleted: bool | None = Field(default=None, alias='deleted')
- cursor: str | None = Field(default=None, alias='cursor')
- page: int | None = Field(default=None, alias='page')
- limit: int | None = Field(default=None, alias='limit')
+ name: Any | None = Field(default=None, alias='name')
+ status: Any | None = Field(default=None, alias='status')
+ version: Any | None = Field(default=None, alias='version')
+ deleted: Any | None = Field(default=None, alias='deleted')
+ cursor: Any | None = Field(default=None, alias='cursor')
+ page: Any | None = Field(default=None, alias='page')
+ limit: Any | None = Field(default=None, alias='limit')
class GetClusterRequest(GeneratedModel):
cluster_id: str = Field(alias='cluster_id')
@@ -491,15 +556,15 @@ class DeleteClusterRequest(GeneratedModel):
class GetKubeconfigRequest(GeneratedModel):
cluster_id: str = Field(alias='cluster_id')
- user: str | None = Field(default=None, alias='user')
- group: str | None = Field(default=None, alias='group')
- ttl: str | None = Field(default=None, alias='ttl')
+ user: Any | None = Field(default=None, alias='user')
+ group: Any | None = Field(default=None, alias='group')
+ ttl: Any | None = Field(default=None, alias='ttl')
class GetKubeconfigWithPubkeyNACLRequest(GeneratedModel):
cluster_id: str = Field(alias='cluster_id')
- user: str | None = Field(default=None, alias='user')
- group: str | None = Field(default=None, alias='group')
- ttl: str | None = Field(default=None, alias='ttl')
+ user: Any | None = Field(default=None, alias='user')
+ group: Any | None = Field(default=None, alias='group')
+ ttl: Any | None = Field(default=None, alias='ttl')
class UpgradeClusterRequest(GeneratedModel):
cluster_id: str = Field(alias='cluster_id')
@@ -513,6 +578,9 @@ class GetCPSubregionsRequest(GeneratedModel):
class GetControlPlanePlansRequest(GeneratedModel):
pass
+class GetAdmissionPluginsRequest(GeneratedModel):
+ version: str = Field(alias='version')
+
class GetProjectTemplateRequest(GeneratedModel):
pass
diff --git a/osc_sdk_python/generated/osc/__init__.py b/osc_sdk_python/generated/osc/__init__.py
index dd3b80a..d58e3f2 100644
--- a/osc_sdk_python/generated/osc/__init__.py
+++ b/osc_sdk_python/generated/osc/__init__.py
@@ -287,6 +287,7 @@
FiltersVmTemplate,
FiltersVmType,
FiltersVmsState,
+ FiltersVmsStopHistory,
FiltersVolume,
FiltersVpnConnection,
FlexibleGpu,
@@ -515,6 +516,8 @@
ReadVmsResponse,
ReadVmsStateRequest,
ReadVmsStateResponse,
+ ReadVmsStopHistoryRequest,
+ ReadVmsStopHistoryResponse,
ReadVolumeUpdateTasksRequest,
ReadVolumeUpdateTasksResponse,
ReadVolumesRequest,
@@ -550,6 +553,7 @@
Service,
SetDefaultPolicyVersionRequest,
SetDefaultPolicyVersionResponse,
+ ShutdownBehaviorConfiguration,
Snapshot,
SnapshotExportTask,
SourceNet,
@@ -649,6 +653,7 @@
VmStates,
VmTemplate,
VmType,
+ VmsStopHistory,
Volume,
VolumeUpdate,
VolumeUpdateParameters,
@@ -941,6 +946,7 @@
'FiltersVmTemplate',
'FiltersVmType',
'FiltersVmsState',
+ 'FiltersVmsStopHistory',
'FiltersVolume',
'FiltersVpnConnection',
'FlexibleGpu',
@@ -1169,6 +1175,8 @@
'ReadVmsResponse',
'ReadVmsStateRequest',
'ReadVmsStateResponse',
+ 'ReadVmsStopHistoryRequest',
+ 'ReadVmsStopHistoryResponse',
'ReadVolumeUpdateTasksRequest',
'ReadVolumeUpdateTasksResponse',
'ReadVolumesRequest',
@@ -1204,6 +1212,7 @@
'Service',
'SetDefaultPolicyVersionRequest',
'SetDefaultPolicyVersionResponse',
+ 'ShutdownBehaviorConfiguration',
'Snapshot',
'SnapshotExportTask',
'SourceNet',
@@ -1303,6 +1312,7 @@
'VmStates',
'VmTemplate',
'VmType',
+ 'VmsStopHistory',
'Volume',
'VolumeUpdate',
'VolumeUpdateParameters',
diff --git a/osc_sdk_python/generated/osc/async_client.py b/osc_sdk_python/generated/osc/async_client.py
index 44de1b7..748e9c3 100644
--- a/osc_sdk_python/generated/osc/async_client.py
+++ b/osc_sdk_python/generated/osc/async_client.py
@@ -384,6 +384,8 @@
ReadVmsResponse,
ReadVmsStateRequest,
ReadVmsStateResponse,
+ ReadVmsStopHistoryRequest,
+ ReadVmsStopHistoryResponse,
ReadVolumeUpdateTasksRequest,
ReadVolumeUpdateTasksResponse,
ReadVolumesRequest,
@@ -5322,6 +5324,32 @@ async def read_vms_state(
)
return _validate_response(ReadVmsStateResponse, response)
+ async def read_vms_stop_history(
+ self,
+ request: ReadVmsStopHistoryRequest | None = None,
+ ) -> ReadVmsStopHistoryResponse:
+ request = _validate_request(ReadVmsStopHistoryRequest, request)
+
+ path_params = {
+ }
+ query_params = {
+ }
+ response = await self.call.request(
+ RequestSpec(
+ service="api",
+ method="POST",
+ path="/ReadVmsStopHistory",
+ json_body=_dump_json_body(request),
+ query_params={
+ key: value
+ for key, value in query_params.items()
+ if value is not None
+ },
+ ),
+ path_params=path_params,
+ )
+ return _validate_response(ReadVmsStopHistoryResponse, response)
+
async def read_volume_update_tasks(
self,
request: ReadVolumeUpdateTasksRequest | None = None,
diff --git a/osc_sdk_python/generated/osc/models.py b/osc_sdk_python/generated/osc/models.py
index 89a025e..86c2272 100644
--- a/osc_sdk_python/generated/osc/models.py
+++ b/osc_sdk_python/generated/osc/models.py
@@ -134,7 +134,7 @@ class BlockDeviceMappingVmUpdate(GeneratedModel):
class BsuCreated(GeneratedModel):
delete_on_vm_deletion: bool | None = Field(default=None, alias='DeleteOnVmDeletion')
- link_date: str | None = Field(default=None, alias='LinkDate')
+ link_date: datetime.datetime | None = Field(default=None, alias='LinkDate')
state: str | None = Field(default=None, alias='State')
volume_id: str | None = Field(default=None, alias='VolumeId')
@@ -223,7 +223,7 @@ class ConsumptionEntry(GeneratedModel):
class CreateAccessKeyRequest(GeneratedModel):
dry_run: bool | None = Field(default=None, alias='DryRun')
- expiration_date: datetime.datetime | None = Field(default=None, alias='ExpirationDate')
+ expiration_date: datetime.datetime | str | None = Field(default=None, alias='ExpirationDate')
tag: str | None = Field(default=None, alias='Tag')
user_name: str | None = Field(default=None, alias='UserName')
@@ -697,6 +697,7 @@ class CreateVmsRequest(GeneratedModel):
private_ips: list[str] | None = Field(default=None, alias='PrivateIps')
security_group_ids: list[str] | None = Field(default=None, alias='SecurityGroupIds')
security_groups: list[str] | None = Field(default=None, alias='SecurityGroups')
+ shutdown_behavior_configuration: ShutdownBehaviorConfiguration | None = Field(default=None, alias='ShutdownBehaviorConfiguration')
subnet_id: str | None = Field(default=None, alias='SubnetId')
tpm_enabled: bool | None = Field(default=None, alias='TpmEnabled')
user_data: str | None = Field(default=None, alias='UserData')
@@ -1214,8 +1215,8 @@ class FiltersApiLog(GeneratedModel):
query_access_keys: list[str] | None = Field(default=None, alias='QueryAccessKeys')
query_api_names: list[str] | None = Field(default=None, alias='QueryApiNames')
query_call_names: list[str] | None = Field(default=None, alias='QueryCallNames')
- query_date_after: str | None = Field(default=None, alias='QueryDateAfter')
- query_date_before: str | None = Field(default=None, alias='QueryDateBefore')
+ query_date_after: datetime.datetime | str | None = Field(default=None, alias='QueryDateAfter')
+ query_date_before: datetime.datetime | str | None = Field(default=None, alias='QueryDateBefore')
query_ip_addresses: list[str] | None = Field(default=None, alias='QueryIpAddresses')
query_user_agents: list[str] | None = Field(default=None, alias='QueryUserAgents')
request_ids: list[str] | None = Field(default=None, alias='RequestIds')
@@ -1547,12 +1548,12 @@ class FiltersVm(GeneratedModel):
architectures: list[str] | None = Field(default=None, alias='Architectures')
block_device_mapping_delete_on_vm_deletion: bool | None = Field(default=None, alias='BlockDeviceMappingDeleteOnVmDeletion')
block_device_mapping_device_names: list[str] | None = Field(default=None, alias='BlockDeviceMappingDeviceNames')
- block_device_mapping_link_dates: list[str] | None = Field(default=None, alias='BlockDeviceMappingLinkDates')
+ block_device_mapping_link_dates: list[str | datetime.datetime] | None = Field(default=None, alias='BlockDeviceMappingLinkDates')
block_device_mapping_states: list[str] | None = Field(default=None, alias='BlockDeviceMappingStates')
block_device_mapping_volume_ids: list[str] | None = Field(default=None, alias='BlockDeviceMappingVolumeIds')
boot_modes: list[BootMode] | None = Field(default=None, alias='BootModes')
client_tokens: list[str] | None = Field(default=None, alias='ClientTokens')
- creation_dates: list[str] | None = Field(default=None, alias='CreationDates')
+ creation_dates: list[str | datetime.datetime] | None = Field(default=None, alias='CreationDates')
image_ids: list[str] | None = Field(default=None, alias='ImageIds')
is_source_dest_checked: bool | None = Field(default=None, alias='IsSourceDestChecked')
keypair_names: list[str] | None = Field(default=None, alias='KeypairNames')
@@ -1564,7 +1565,7 @@ class FiltersVm(GeneratedModel):
nic_is_source_dest_checked: bool | None = Field(default=None, alias='NicIsSourceDestChecked')
nic_link_nic_delete_on_vm_deletion: bool | None = Field(default=None, alias='NicLinkNicDeleteOnVmDeletion')
nic_link_nic_device_numbers: list[int] | None = Field(default=None, alias='NicLinkNicDeviceNumbers')
- nic_link_nic_link_nic_dates: list[str] | None = Field(default=None, alias='NicLinkNicLinkNicDates')
+ nic_link_nic_link_nic_dates: list[str | datetime.datetime] | None = Field(default=None, alias='NicLinkNicLinkNicDates')
nic_link_nic_link_nic_ids: list[str] | None = Field(default=None, alias='NicLinkNicLinkNicIds')
nic_link_nic_states: list[str] | None = Field(default=None, alias='NicLinkNicStates')
nic_link_nic_vm_account_ids: list[str] | None = Field(default=None, alias='NicLinkNicVmAccountIds')
@@ -1651,12 +1652,18 @@ class FiltersVmType(GeneratedModel):
class FiltersVmsState(GeneratedModel):
maintenance_event_codes: list[str] | None = Field(default=None, alias='MaintenanceEventCodes')
maintenance_event_descriptions: list[str] | None = Field(default=None, alias='MaintenanceEventDescriptions')
- maintenance_events_not_after: list[str] | None = Field(default=None, alias='MaintenanceEventsNotAfter')
- maintenance_events_not_before: list[str] | None = Field(default=None, alias='MaintenanceEventsNotBefore')
+ maintenance_events_not_after: list[str | datetime.datetime] | None = Field(default=None, alias='MaintenanceEventsNotAfter')
+ maintenance_events_not_before: list[str | datetime.datetime] | None = Field(default=None, alias='MaintenanceEventsNotBefore')
subregion_names: list[str] | None = Field(default=None, alias='SubregionNames')
vm_ids: list[str] | None = Field(default=None, alias='VmIds')
vm_states: list[str] | None = Field(default=None, alias='VmStates')
+class FiltersVmsStopHistory(GeneratedModel):
+ state_reasons: list[str] | None = Field(default=None, alias='StateReasons')
+ stop_date_after: str | datetime.datetime | None = Field(default=None, alias='StopDateAfter')
+ stop_date_before: str | datetime.datetime | None = Field(default=None, alias='StopDateBefore')
+ vm_ids: list[str] | None = Field(default=None, alias='VmIds')
+
class FiltersVolume(GeneratedModel):
client_tokens: list[str] | None = Field(default=None, alias='ClientTokens')
creation_dates: list[datetime.datetime] | None = Field(default=None, alias='CreationDates')
@@ -1720,7 +1727,7 @@ class Image(GeneratedModel):
architecture: str | None = Field(default=None, alias='Architecture')
block_device_mappings: list[BlockDeviceMappingImage] | None = Field(default=None, alias='BlockDeviceMappings')
boot_modes: list[BootMode] | None = Field(default=None, alias='BootModes')
- creation_date: str | None = Field(default=None, alias='CreationDate')
+ creation_date: datetime.datetime | None = Field(default=None, alias='CreationDate')
description: str | None = Field(default=None, alias='Description')
file_location: str | None = Field(default=None, alias='FileLocation')
image_id: str | None = Field(default=None, alias='ImageId')
@@ -1966,6 +1973,7 @@ class LoadBalancer(GeneratedModel):
load_balancer_sticky_cookie_policies: list[LoadBalancerStickyCookiePolicy] | None = Field(default=None, alias='LoadBalancerStickyCookiePolicies')
load_balancer_type: str | None = Field(default=None, alias='LoadBalancerType')
net_id: str | None = Field(default=None, alias='NetId')
+ private_ip: str | None = Field(default=None, alias='PrivateIp')
public_ip: str | None = Field(default=None, alias='PublicIp')
secured_cookies: bool | None = Field(default=None, alias='SecuredCookies')
security_groups: list[str] | None = Field(default=None, alias='SecurityGroups')
@@ -1999,7 +2007,7 @@ class Log(GeneratedModel):
query_api_name: str | None = Field(default=None, alias='QueryApiName')
query_api_version: str | None = Field(default=None, alias='QueryApiVersion')
query_call_name: str | None = Field(default=None, alias='QueryCallName')
- query_date: str | None = Field(default=None, alias='QueryDate')
+ query_date: datetime.datetime | None = Field(default=None, alias='QueryDate')
query_header_raw: str | None = Field(default=None, alias='QueryHeaderRaw')
query_header_size: int | None = Field(default=None, alias='QueryHeaderSize')
query_ip_address: str | None = Field(default=None, alias='QueryIpAddress')
@@ -2206,6 +2214,8 @@ class ProductType(GeneratedModel):
class PublicIp(GeneratedModel):
link_public_ip_id: str | None = Field(default=None, alias='LinkPublicIpId')
+ nat_service_id: str | None = Field(default=None, alias='NatServiceId')
+ net_access_point_ids: list[str] | None = Field(default=None, alias='NetAccessPointIds')
nic_account_id: str | None = Field(default=None, alias='NicAccountId')
nic_id: str | None = Field(default=None, alias='NicId')
private_ip: str | None = Field(default=None, alias='PrivateIp')
@@ -2304,9 +2314,9 @@ class ReadApiLogsResponse(GeneratedModel):
response_context: ResponseContext | None = Field(default=None, alias='ResponseContext')
class ReadCO2EmissionAccountRequest(GeneratedModel):
- from_month: str = Field(alias='FromMonth')
+ from_month: str | datetime.datetime = Field(alias='FromMonth')
overall: bool | None = Field(default=None, alias='Overall')
- to_month: str = Field(alias='ToMonth')
+ to_month: str | datetime.datetime = Field(alias='ToMonth')
class ReadCO2EmissionAccountResponse(GeneratedModel):
co2_emission_entries: list[CO2EmissionEntry] | None = Field(default=None, alias='CO2EmissionEntries')
@@ -2359,11 +2369,11 @@ class ReadConsoleOutputResponse(GeneratedModel):
class ReadConsumptionAccountRequest(GeneratedModel):
dry_run: bool | None = Field(default=None, alias='DryRun')
- from_date: datetime.datetime = Field(alias='FromDate')
+ from_date: str | datetime.datetime = Field(alias='FromDate')
overall: bool | None = Field(default=None, alias='Overall')
show_price: bool | None = Field(default=None, alias='ShowPrice')
show_resource_details: bool | None = Field(default=None, alias='ShowResourceDetails')
- to_date: datetime.datetime = Field(alias='ToDate')
+ to_date: str | datetime.datetime = Field(alias='ToDate')
class ReadConsumptionAccountResponse(GeneratedModel):
consumption_entries: list[ConsumptionEntry] | None = Field(default=None, alias='ConsumptionEntries')
@@ -2967,6 +2977,16 @@ class ReadVmsStateResponse(GeneratedModel):
response_context: ResponseContext | None = Field(default=None, alias='ResponseContext')
vm_states: list[VmStates] | None = Field(default=None, alias='VmStates')
+class ReadVmsStopHistoryRequest(GeneratedModel):
+ filters: FiltersVmsStopHistory | None = Field(default=None, alias='Filters')
+ next_page_token: str | None = Field(default=None, alias='NextPageToken')
+ results_per_page: int | None = Field(default=None, alias='ResultsPerPage')
+
+class ReadVmsStopHistoryResponse(GeneratedModel):
+ next_page_token: str | None = Field(default=None, alias='NextPageToken')
+ response_context: ResponseContext | None = Field(default=None, alias='ResponseContext')
+ vms_stop_history: list[VmsStopHistory] | None = Field(default=None, alias='VmsStopHistory')
+
class ReadVolumeUpdateTasksRequest(GeneratedModel):
dry_run: bool | None = Field(default=None, alias='DryRun')
filters: FiltersReadVolumeUpdateTask | None = Field(default=None, alias='Filters')
@@ -3141,6 +3161,10 @@ class SetDefaultPolicyVersionRequest(GeneratedModel):
class SetDefaultPolicyVersionResponse(GeneratedModel):
response_context: ResponseContext | None = Field(default=None, alias='ResponseContext')
+class ShutdownBehaviorConfiguration(GeneratedModel):
+ guest_action: Literal['stop', 'terminate'] | None = Field(default=None, alias='GuestAction')
+ host_action: Literal['restart', 'stop'] | None = Field(default=None, alias='HostAction')
+
class Snapshot(GeneratedModel):
account_alias: str | None = Field(default=None, alias='AccountAlias')
account_id: str | None = Field(default=None, alias='AccountId')
@@ -3315,7 +3339,7 @@ class UpdateAccessKeyRequest(GeneratedModel):
clear_expiration_date: bool | None = Field(default=None, alias='ClearExpirationDate')
clear_tag: bool | None = Field(default=None, alias='ClearTag')
dry_run: bool | None = Field(default=None, alias='DryRun')
- expiration_date: datetime.datetime | None = Field(default=None, alias='ExpirationDate')
+ expiration_date: datetime.datetime | str | None = Field(default=None, alias='ExpirationDate')
state: str | None = Field(default=None, alias='State')
tag: str | None = Field(default=None, alias='Tag')
user_name: str | None = Field(default=None, alias='UserName')
@@ -3575,6 +3599,7 @@ class UpdateVmRequest(GeneratedModel):
nested_virtualization: bool | None = Field(default=None, alias='NestedVirtualization')
performance: Literal['medium', 'high', 'highest'] | None = Field(default=None, alias='Performance')
security_group_ids: list[str] | None = Field(default=None, alias='SecurityGroupIds')
+ shutdown_behavior_configuration: ShutdownBehaviorConfiguration | None = Field(default=None, alias='ShutdownBehaviorConfiguration')
user_data: str | None = Field(default=None, alias='UserData')
vm_id: str = Field(alias='VmId')
vm_initiated_shutdown_behavior: str | None = Field(default=None, alias='VmInitiatedShutdownBehavior')
@@ -3677,6 +3702,7 @@ class Vm(GeneratedModel):
root_device_name: str | None = Field(default=None, alias='RootDeviceName')
root_device_type: str | None = Field(default=None, alias='RootDeviceType')
security_groups: list[SecurityGroupLight] | None = Field(default=None, alias='SecurityGroups')
+ shutdown_behavior_configuration: ShutdownBehaviorConfiguration | None = Field(default=None, alias='ShutdownBehaviorConfiguration')
state: str | None = Field(default=None, alias='State')
state_reason: str | None = Field(default=None, alias='StateReason')
subnet_id: str | None = Field(default=None, alias='SubnetId')
@@ -3737,6 +3763,11 @@ class VmType(GeneratedModel):
volume_count: int | None = Field(default=None, alias='VolumeCount')
volume_size: int | None = Field(default=None, alias='VolumeSize')
+class VmsStopHistory(GeneratedModel):
+ state_reason: str | None = Field(default=None, alias='StateReason')
+ stop_date: datetime.datetime | None = Field(default=None, alias='StopDate')
+ vm_id: str | None = Field(default=None, alias='VmId')
+
class Volume(GeneratedModel):
client_token: str | None = Field(default=None, alias='ClientToken')
creation_date: datetime.datetime | None = Field(default=None, alias='CreationDate')
diff --git a/osc_sdk_python/resources/oks/api.yaml b/osc_sdk_python/resources/oks/api.yaml
index 290c460..61d58a7 100644
--- a/osc_sdk_python/resources/oks/api.yaml
+++ b/osc_sdk_python/resources/oks/api.yaml
@@ -1,8 +1,12 @@
-openapi: 3.0.3
+openapi: 3.1.0
info:
title: OKS API
- description: API for creating your clusters on Kubernetes. Each cluster is
- linked to a project. in a project you can have several clusters
+ description: |-
+ The OKS API enables you to interact with OUTSCALE Kubernetes as a Service (OKS), a managed Kubernetes service on the OUTSCALE Cloud.
+
+ In OKS, each cluster is linked to a project. In a project, you can have several clusters. Templates are also available for different resources. For more information about the service, see [About OKS](https://docs.outscale.com/en/userguide/About-OKS.html).
+
+ An OpenAPI description of this API is also available for download:
version: '1.0'
paths:
/projects:
@@ -10,9 +14,7 @@ paths:
tags:
- Projects
summary: Create Project
- description: Creates a new project with the provided details. The request
- must include the project data in the request body. Returns the details
- of the created project.
+ description: Creates a new project.
operationId: CreateProject
parameters: []
requestBody:
@@ -23,96 +25,93 @@ paths:
$ref: '#/components/schemas/ProjectInput'
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
- '503':
- description: ResourceIsNotReady
+ '403':
+ description: The HTTP 403 response (Forbidden).
content:
application/json:
example:
Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
+ - Type: ForbiddenError
+ Details: You cannot have more than 2 projects.
+ Code: '403'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: ResourceConflict
+ Details: Project with this name already exists.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '409':
- description: ResourceConflict
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- - Type: ResourceConflict
- Details: Project with this name already exists.
- Code: '409'
+ - Type: ValidationError
+ Details: 'Invalid CIDR: ''10.50.15.24/32'' must have a prefix length between /16 and /23.'
+ Code: '422'
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '423':
+ description: The HTTP 423 response (Locked Resource).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Failed to create project
- Code: '500'
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '403':
- description: ForbiddenError
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
Errors:
- - Type: ForbiddenError
- Details: You cannot have more than 2 projects.
- Code: '403'
+ - Type: InternalError
+ Details: Failed to create project
+ Code: '500'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '422':
- description: ValidationError
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- - Type: ValidationError
- Details: "Invalid CIDR: '10.50.15.24/32' must have a prefix length
- between /16 and /23."
- Code: '422'
- - Type: ValidationError
- Details:
- - loc:
- - string
- - 0
- msg: string
- type: string
- Code: '422'
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
@@ -121,77 +120,83 @@ paths:
tags:
- Projects
summary: Get Projects
- description: Retrieves a list of all projects with optional filters for
- name, status, CIDR, and deletion status. Returns a list of matching
- projects based on the specified filters.
+ description: Lists one or more of your projects. The response can be filtered using the parameters.
operationId: ListProjects
parameters:
- name: name
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Name
+ description: The name of the projects.
- name: status
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Status
+ description: The status of the projects (`pending` | `ready` | `updating` | `failed` | `deleting`).
- name: cidr
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Cidr
+ description: The IP ranges for the projects, IN CIDR notation (for example, `192.0.2.0/16`).
- name: deleted
in: query
required: false
schema:
- type: boolean
- nullable: true
+ anyOf:
+ - type: boolean
+ - type: 'null'
+ title: Deleted
+ description: If true, returns deleted projects.
- name: cursor
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Cursor
+ description: The token to indicate where the next set of results should start.
- name: page
in: query
required: false
schema:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Page
+ description: The page number of results to retrieve.
- name: limit
in: query
required: false
schema:
- type: integer
- maximum: 100
- exclusiveMinimum: false
- nullable: true
+ anyOf:
+ - type: integer
+ maximum: 100
+ minimum: 1
+ - type: 'null'
+ title: Limit
+ description: The maximum number of results to return in the response.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponseList'
- '500':
- description: InternalError
- content:
- application/json:
- example:
- Errors:
- - Type: InternalError
- Details: Internal server error
- Code: '500'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -208,13 +213,25 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Internal server error
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
/projects/{project_id}:
get:
tags:
- Projects
summary: Get Project
- description: Retrieves detailed information about a specific project by
- its ID. Returns the details of the project if found.
+ description: Gets information about a specific project.
operationId: GetProject
parameters:
- name: project_id
@@ -223,15 +240,16 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'400':
- description: InvalidResource
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
@@ -244,7 +262,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -256,21 +274,8 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
- content:
- application/json:
- example:
- Errors:
- - Type: InternalError
- Details: Internal server error
- Code: '500'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -287,13 +292,24 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Internal server error
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- Projects
summary: Update Project
- description: Updates the details of an existing project by its ID. The
- request must include the updated project data in the request body.
- Returns the updated project information.
+ description: Updates the details of an existing project.
operationId: UpdateProject
parameters:
- name: project_id
@@ -302,6 +318,7 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
requestBody:
required: true
content:
@@ -310,71 +327,70 @@ paths:
$ref: '#/components/schemas/ProjectUpdate'
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
- '503':
- description: ResourceIsNotReady
+ '404':
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: pending'
- Code: '503'
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the project has been deleted.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '404':
- description: NotFoundError
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- - Type: NotFoundError
- Details: Project $uuid not found.
- Code: '404'
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '409':
- description: ResourceConflict
+ '423':
+ description: The HTTP 423 response (Locked Resource).
content:
application/json:
example:
Errors:
- - Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
- Code: '409'
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -386,20 +402,18 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '422':
- description: ValidationError
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- - Type: ValidationError
- Details:
- - loc:
- - string
- - 0
- msg: string
- type: string
- Code: '422'
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: pending'
+ Code: '503'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
@@ -408,8 +422,7 @@ paths:
tags:
- Projects
summary: Delete Project
- description: Deletes a specific project by its ID. Returns a confirmation
- of the project deletion.
+ description: Deletes a specific project.
operationId: DeleteProject
parameters:
- name: project_id
@@ -418,46 +431,32 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse'
- '503':
- description: ResourceIsNotReady
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: pending'
- Code: '503'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '403':
+ description: The HTTP 403 response (Forbidden).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: ForbiddenError
+ Details: Project $uuid can't be deleted because disable_api_termination is enabled
+ Code: '403'
+ - Type: ForbiddenError
+ Details: 'The requested action cannot be performed because the project has 1 active cluster(s): test'
+ Code: '403'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -470,39 +469,20 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
- description: ResourceConflict
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
+ Details: The requested action cannot be performed because the project has been deleted.
Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '403':
- description: ForbiddenError
- content:
- application/json:
- example:
- Errors:
- - Type: ForbiddenError
- Details: Project $uuid can't be deleted because
- disable_api_termination is enabled
- Code: '403'
- - Type: ForbiddenError
- Details: 'The requested action cannot be performed because the project
- has 1 active cluster(s): test'
- Code: '403'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -519,13 +499,41 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: pending'
+ Code: '503'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
/projects/{project_id}/quotas:
get:
tags:
- Projects
summary: Get Project Quotas
- description: Retrieves the quota details for a specific project by its ID.
- Returns the quota information associated with the specified project.
+ description: Gets the quota details for a specific project.
operationId: GetProjectQuotas
parameters:
- name: project_id
@@ -534,15 +542,474 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/projects__project_schema__QuotasResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '408':
+ description: The HTTP 408 response (Timeout)
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /projects/{project_id}/snapshots:
+ get:
+ tags:
+ - Projects
+ summary: Get Project Snapshots
+ description: Retrieves the snapshot details for a specific project by its ID. Returns the snapshot information associated with the specified project.
+ operationId: GetProjectSnapshots
+ parameters:
+ - name: project_id
+ in: path
+ required: true
+ schema:
+ type: string
+ title: Project Id
+ description: The ID of the project.
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SnapshotsResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '408':
+ description: The HTTP 408 response (Timeout)
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /projects/{project_id}/public_ips:
+ get:
+ tags:
+ - Projects
+ summary: Get Project Public Ips
+ description: Retrieves the Public IP details for a specific project by its ID. Returns the public IP information associated with the specified project.
+ operationId: GetProjectPublicIps
+ parameters:
+ - name: project_id
+ in: path
+ required: true
+ schema:
+ type: string
+ title: Project Id
+ description: The ID of the project.
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PublicIpsResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '408':
+ description: The HTTP 408 response (Timeout)
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /projects/{project_id}/nets:
+ get:
+ tags:
+ - Projects
+ summary: Get Project Nets
+ description: Retrieves the Net details for a specific project by its ID. Returns the Net information associated with the specified project.
+ operationId: GetProjectNets
+ parameters:
+ - name: project_id
+ in: path
+ required: true
+ schema:
+ type: string
+ title: Project Id
+ description: The ID of the project.
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NetsResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '408':
+ description: The HTTP 408 response (Timeout)
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /projects/{project_id}/eim_users:
+ get:
+ tags:
+ - Projects
+ summary: Get Eim Users
+ description: Gets information about EIM users.
+ operationId: GetEimUsers
+ parameters:
+ - name: project_id
+ in: path
+ required: true
+ schema:
+ type: string
+ title: Project Id
+ description: The ID of the project.
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/EimUsersResponse'
+ '400':
+ description: The HTTP 400 response (Bad Request).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InvalidResource
+ Details: Failed to retreive users.
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '408':
+ description: The HTTP 408 response (Timeout)
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ post:
+ tags:
+ - Projects
+ summary: Create Eim User
+ description: Creates an EIM user.
+ operationId: CreateEimUser
+ parameters:
+ - name: project_id
+ in: path
+ required: true
+ schema:
+ type: string
+ title: Project Id
+ description: The ID of the project.
+ - name: user
+ in: query
+ required: true
+ schema:
+ type: string
+ title: User
+ description: The name of the EIM user.
+ - name: ttl
+ in: query
+ required: false
+ schema:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Ttl
+ description: The TTL (time-to-live) for the kubeconfig certificate.
+ - name: x-encrypt-nacl
+ in: header
+ required: false
+ schema:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: X-Encrypt-Nacl
+ description: The header to encrypt the kubeconfig file.
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ anyOf:
+ - $ref: '#/components/schemas/EimUserResponse'
+ - $ref: '#/components/schemas/EnryptedResponse'
+ title: Response Createeimuser
+ description: The HTTP 200 response (OK).
+ '400':
+ description: The HTTP 400 response (Bad Request).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InvalidResource
+ Details: Unsupported user type.
+ Code: '400'
+ - Type: InvalidResource
+ Details: Failed to create requested user.
+ Code: '400'
+ - Type: InvalidResource
+ Details: Failed to link policy.
+ Code: '400'
+ - Type: InvalidResource
+ Details: Failed to generate AccessKey.
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -555,34 +1022,36 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'408':
- description: TimeoutError
+ description: The HTTP 408 response (Timeout)
content:
application/json:
example:
Errors:
- Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
+ Details: Request Timeout. The server timed out waiting for the request.
Code: '408'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing project data
- Code: '500'
+ - Type: ResourceConflict
+ Details: The user 'user' already exist.
+ Code: '409'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the project has been deleted.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -599,58 +1068,21 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- /projects/{project_id}/snapshots:
- get:
- tags:
- - Projects
- summary: Get Project Snapshots
- description: Retrieves the snapshot details for a specific project by its
- ID. Returns the snapshot information associated with the specified
- project.
- operationId: GetProjectSnapshots
- parameters:
- - name: project_id
- in: path
- required: true
- schema:
- type: string
- title: Project Id
- responses:
- '200':
- description: Successful Response
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SnapshotsResponse'
- '404':
- description: NotFoundError
- content:
- application/json:
- example:
- Errors:
- - Type: NotFoundError
- Details: Project $uuid not found.
- Code: '404'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '408':
- description: TimeoutError
+ '423':
+ description: The HTTP 423 response (Locked Resource).
content:
application/json:
example:
Errors:
- - Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
- Code: '408'
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -662,33 +1094,33 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '422':
- description: ValidationError
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- - Type: ValidationError
- Details:
- - loc:
- - string
- - 0
- msg: string
- type: string
- Code: '422'
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: pending'
+ Code: '503'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- /projects/{project_id}/public_ips:
+ /projects/{project_id}/eim_users/types:
get:
tags:
- Projects
- summary: Get Project Public Ips
- description: Retrieves the Public IP details for a specific project by its
- ID. Returns the public IP information associated with the specified
- project.
- operationId: GetProjectPublicIps
+ summary: Get Eim Users Types
+ description: |-
+ Gets information about EIM user types.
+
+ **[IMPORTANT]**
+ In the API, the term `user type` corresponds to the `user role` described in the User Guide. For more information, see [Creating an EIM User Using OKS](Managing-EIM-Users-Using-OKS.html).
+ operationId: GetEimUserTypes
parameters:
- name: project_id
in: path
@@ -696,55 +1128,55 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
- $ref: '#/components/schemas/PublicIpsResponse'
- '404':
- description: NotFoundError
+ $ref: '#/components/schemas/EimUserTypesResponse'
+ '400':
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
Errors:
- - Type: NotFoundError
- Details: Project $uuid not found.
- Code: '404'
+ - Type: InvalidResource
+ Details: Failed to retreive users.
+ Code: '400'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '408':
- description: TimeoutError
+ '404':
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
Errors:
- - Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
- Code: '408'
+ - Type: NotFoundError
+ Details: Project $uuid not found.
+ Code: '404'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '408':
+ description: The HTTP 408 response (Timeout)
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing project data
- Code: '500'
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -761,14 +1193,26 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- /projects/{project_id}/nets:
- get:
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /projects/{project_id}/eim_users/{user}:
+ delete:
tags:
- Projects
- summary: Get Project Ntets
- description: Retrieves the Nets details for a specific project by its ID.
- Returns the Nets information associated with the specified project.
- operationId: GetProjectNets
+ summary: Delete Eim User
+ description: Deletes a specific EIM user.
+ operationId: DeleteEimUser
parameters:
- name: project_id
in: path
@@ -776,15 +1220,39 @@ paths:
schema:
type: string
title: Project Id
+ description: The ID of the project.
+ - name: user
+ in: path
+ required: true
+ schema:
+ type: string
+ title: User
+ description: The name of the EIM user.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
- $ref: '#/components/schemas/NetsResponse'
+ $ref: '#/components/schemas/DetailsResponse'
+ '400':
+ description: The HTTP 400 response (Bad Request).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InvalidResource
+ Details: Unsupported user type.
+ Code: '400'
+ - Type: InvalidResource
+ Details: Failed to delete user.
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -797,34 +1265,33 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'408':
- description: TimeoutError
+ description: The HTTP 408 response (Timeout)
content:
application/json:
example:
Errors:
- Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
+ Details: Request Timeout. The server timed out waiting for the request.
Code: '408'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing project data
- Code: '500'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the project has been deleted.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -841,14 +1308,54 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: pending'
+ Code: '503'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
/clusters:
post:
tags:
- Clusters
summary: Create Cluster
- description: Creates a new cluster with the provided configuration. The
- request must include the cluster details in the request body. all
- clusters are associated to a project
+ description: Creates a cluster with the provided configuration.
operationId: CreateCluster
parameters: []
requestBody:
@@ -859,44 +1366,39 @@ paths:
$ref: '#/components/schemas/ClusterInput'
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponse'
- '503':
- description: ResourceIsNotReady
+ '400':
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: pending'
- Code: '503'
+ - Type: InvalidResource
+ Details: The 'version' field is required.
+ Code: '400'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '403':
+ description: The HTTP 403 response (Forbidden).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: ForbiddenError
+ Details: You cannot have more than 2 clusters.
+ Code: '403'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -909,71 +1411,52 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
- description: ResourceConflict
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- Type: ResourceConflict
- Details: The name 'default' cannot be used because it is a
- reserved keyword.
+ Details: The name 'default' cannot be used because it is a reserved keyword.
Code: '409'
- Type: ResourceConflict
Details: Cluster with this name already exists.
Code: '409'
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
+ Details: The requested action cannot be performed because the project has been deleted.
Code: '409'
- Type: ResourceConflict
- Details: "Network overlap detected between source1 (net1) and source2
- (net2). \nPlease use non-overlapping network ranges."
+ Details: |-
+ Network overlap detected between source1 (net1) and source2 (net2).
+ Please use non-overlapping network ranges.
Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '403':
- description: ForbiddenError
- content:
- application/json:
- example:
- Errors:
- - Type: ForbiddenError
- Details: You cannot have more than 2 clusters.
- Code: '403'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- Type: ValidationError
- Details: "Invalid CIDR: 'cidr' is not an IPv4 range. Only IPv4 CIDR
- blocks are supported."
+ Details: 'Invalid CIDR: ''cidr'' is not an IPv4 range. Only IPv4 CIDR blocks are supported.'
Code: '422'
- Type: ValidationError
- Details: "Invalid CIDR: 'cidr' is not a private IP range as defined
- by RFC1918."
+ Details: 'Invalid CIDR: ''cidr'' is not a private IP range as defined by RFC1918.'
Code: '422'
- Type: ValidationError
- Details: "Invalid CIDR: 'cidr' has a prefix length of /network.prefixlen.
- The minimal accepted prefix length is /23"
+ Details: 'Invalid CIDR: ''cidr'' has a prefix length of /network.prefixlen. The minimal accepted prefix length is /23'
Code: '422'
- Type: ValidationError
- Details: "Invalid CIDR: 'cidr' is not allowed as it belongs to the
- restricted subnet 172.31.0.0/16."
+ Details: 'Invalid CIDR: ''cidr'' is not allowed as it belongs to the restricted subnet 172.31.0.0/16.'
Code: '422'
- Type: ValidationError
- Details: "Invalid CIDR: 'cidr' is not a valid CIDR block."
+ Details: 'Invalid CIDR: ''cidr'' is not a valid CIDR block.'
Code: '422'
- Type: ValidationError
- Details: Failed to create cluster. cluster_dns is not part of
- cidr_service
+ Details: Failed to create cluster. cluster_dns is not part of cidr_service
Code: '422'
- Type: ValidationError
Details: 'Private RFC1918 IPs are not allowed: cidr'
@@ -991,32 +1474,25 @@ paths:
Details: 'Invalid cidr in the admin_whitelist: cidr'
Code: '422'
- Type: ValidationError
- Details: 'Invalid plugin(s): list of invalid_plugins. Allowed plugins
- to enable/disable are: list of allowed_plugins'
+ Details: 'Invalid plugin(s): list of invalid_plugins. Allowed plugins to enable/disable are: list of allowed_plugins'
Code: '422'
- Type: ValidationError
- Details: "Failed to create cluster. Control plane plan 'control_planes'
- does not exist. Valid plans are: list of valid_plans"
+ Details: 'Failed to create cluster. Control plane plan ''control_planes'' does not exist. Valid plans are: list of valid_plans'
Code: '422'
- Type: ValidationError
- Details: Multi AZ is not allowed for the requested
- control_plane size.
+ Details: Multi AZ is not allowed for the requested control_plane size.
Code: '422'
- Type: ValidationError
Details: The requested subregions must be unique.
Code: '422'
- Type: ValidationError
- Details: "The requested subregions 'cp_subregions' cannot be specified
- for multi AZ configuration (cp_multi_az: 'cp_multi_az'). Multi
- AZ cluster must have at least 3 subregions."
+ Details: 'The requested subregions ''cp_subregions'' cannot be specified for multi AZ configuration (cp_multi_az: ''cp_multi_az''). Multi AZ cluster must have at least 3 subregions.'
Code: '422'
- Type: ValidationError
- Details: "The requested subregions 'cp_subregions' cannot be specified
- for the mono AZ configuration (cp_multi_az: 'cp_multi_az')."
+ Details: 'The requested subregions ''cp_subregions'' cannot be specified for the mono AZ configuration (cp_multi_az: ''cp_multi_az'').'
Code: '422'
- Type: ValidationError
- Details: The number of requested subregions exceeds the
- available subregions.
+ Details: The number of requested subregions exceeds the available subregions.
Code: '422'
- Type: ValidationError
Details: The subregion 'subregion' does not exist.
@@ -1028,8 +1504,7 @@ paths:
Details: Invalid version format. Use 'X.Y' (e.g., '1.30').
Code: '422'
- Type: ValidationError
- Details: Invalid cluster version update. Only +1 minor version
- allowed.
+ Details: Invalid cluster version update. Only +1 minor version allowed.
Code: '422'
- Type: ValidationError
Details:
@@ -1043,15 +1518,27 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
Errors:
- Type: InternalError
- Details: Failed to create cluster. Unable to set default
- cp_subregion.
+ Details: Failed to create cluster. Unable to set default cp_subregion.
Code: '500'
- Type: InternalError
Details: Failed to create cluster.
@@ -1061,7 +1548,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'501':
- description: ResourceNotImplemented
+ description: The HTTP 501 response (Not Implemented).
content:
application/json:
example:
@@ -1073,15 +1560,18 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '400':
- description: InvalidResource
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- - Type: InvalidResource
- Details: The 'version' field is required.
- Code: '400'
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: pending'
+ Code: '503'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
@@ -1090,86 +1580,92 @@ paths:
tags:
- Clusters
summary: Get Clusters
- description: Retrieves a list of clusters assosiated to project ID. You
- can optionally filter clusters by name, status, version, or deletion
- status. Returns a list of matching clusters
+ description: Lists one or more clusters associated with a project. The response can be filtered using the parameters.
operationId: ListClustersByProjectID
parameters:
- name: project_id
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Project Id
+ description: The ID of the project.
- name: name
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Name
+ description: The name of the clusters.
- name: status
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Status
+ description: The status of the clusters.
- name: version
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Version
+ description: The version of the clusters.
- name: deleted
in: query
required: false
schema:
- type: boolean
- nullable: true
+ anyOf:
+ - type: boolean
+ - type: 'null'
+ title: Deleted
+ description: If true, returns deleted clusters.
- name: cursor
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Cursor
+ description: The token to indicate where the next set of results should start.
- name: page
in: query
required: false
schema:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Page
+ description: The page number of results to retrieve.
- name: limit
in: query
required: false
schema:
- type: integer
- maximum: 100
- exclusiveMinimum: false
- nullable: true
+ anyOf:
+ - type: integer
+ maximum: 100
+ minimum: 1
+ - type: 'null'
+ title: Limit
+ description: The maximum number of results to return in the response.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponseList'
- '404':
- description: NotFoundError
- content:
- application/json:
- example:
- Errors:
- - Type: NotFoundError
- Details: Cluster $uuid not found.
- Code: '404'
- - Type: NotFoundError
- Details: Project $uuid not found
- Code: '404'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'400':
- description: InvalidResource
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
@@ -1181,21 +1677,24 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '404':
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Internal server error
- Code: '500'
+ - Type: NotFoundError
+ Details: Cluster $uuid not found.
+ Code: '404'
+ - Type: NotFoundError
+ Details: Project $uuid not found
+ Code: '404'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -1212,82 +1711,130 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Internal server error
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
/clusters/all:
get:
tags:
- Clusters
summary: Get All Clusters
- description: Retrieves a list of all clusters, with optional filters for
- name, status, version, and deletion status. Returns a list of matching
- clusters
+ description: Lists one or more of your clusters. The response can be filtered using the parameters.
operationId: ListAllClusters
parameters:
- name: name
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Name
+ description: The name of the clusters.
- name: status
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Status
+ description: The status of the clusters.
- name: version
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Version
+ description: The version of the clusters.
- name: deleted
in: query
required: false
schema:
- type: boolean
- nullable: true
+ anyOf:
+ - type: boolean
+ - type: 'null'
+ title: Deleted
+ description: If true, returns deleted clusters.
- name: cursor
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Cursor
+ description: The token to indicate where the next set of results should start in cursor-based pagination.
- name: page
in: query
required: false
schema:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Page
+ description: The page number of results to retrieve.
- name: limit
in: query
required: false
schema:
- type: integer
- maximum: 100
- exclusiveMinimum: false
- nullable: true
+ anyOf:
+ - type: integer
+ maximum: 100
+ minimum: 1
+ - type: 'null'
+ title: Limit
+ description: The maximum number of results to return in the response.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponseList'
- '500':
- description: InternalError
+ '400':
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Internal server error
- Code: '500'
+ - Type: InvalidResource
+ Details: Invalid cluster data format
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ '404':
+ description: The HTTP 404 response (Not Found).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: NotFoundError
+ Details: Cluster $uuid not found.
+ Code: '404'
+ - Type: NotFoundError
+ Details: Project $uuid not found
+ Code: '404'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -1304,31 +1851,15 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '404':
- description: NotFoundError
- content:
- application/json:
- example:
- Errors:
- - Type: NotFoundError
- Details: Cluster $uuid not found.
- Code: '404'
- - Type: NotFoundError
- Details: Project $uuid not found
- Code: '404'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '400':
- description: InvalidResource
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
Errors:
- - Type: InvalidResource
- Details: Invalid cluster data format
- Code: '400'
+ - Type: InternalError
+ Details: Internal server error
+ Code: '500'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
@@ -1338,8 +1869,7 @@ paths:
tags:
- Clusters
summary: Get Cluster
- description: Retrieves detailed information about a specific cluster by
- its ID. Returns the cluster details if found.
+ description: Gets information about a specific cluster.
operationId: GetCluster
parameters:
- name: cluster_id
@@ -1348,31 +1878,16 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponse'
- '404':
- description: NotFoundError
- content:
- application/json:
- example:
- Errors:
- - Type: NotFoundError
- Details: Cluster $uuid not found.
- Code: '404'
- - Type: NotFoundError
- Details: Project $uuid not found
- Code: '404'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'400':
- description: InvalidResource
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
@@ -1384,21 +1899,24 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '404':
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing cluster data
- Code: '500'
+ - Type: NotFoundError
+ Details: Cluster $uuid not found.
+ Code: '404'
+ - Type: NotFoundError
+ Details: Project $uuid not found
+ Code: '404'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -1415,13 +1933,24 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InternalError
+ Details: Error processing cluster data
+ Code: '500'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- Clusters
summary: Update Cluster
- description: Updates the configuration of an existing cluster by its ID.
- The request must include the updated cluster details in the request
- body. Returns the updated cluster information
+ description: Updates the configuration of an existing cluster.
operationId: UpdateCluster
parameters:
- name: cluster_id
@@ -1430,6 +1959,7 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
requestBody:
required: true
content:
@@ -1438,44 +1968,32 @@ paths:
$ref: '#/components/schemas/ClusterUpdate'
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponse'
- '503':
- description: ResourceIsNotReady
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: status'
- Code: '503'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '400':
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: InvalidResource
+ Details: Invalid value for control_planes
+ Code: '400'
+ - Type: InvalidResource
+ Details: Downgrade from a multi-master setup (cp.3) to a single master (cp.mono.master) is not allowed.
+ Code: '400'
+ - Type: InvalidResource
+ Details: The 'version' field is required.
+ Code: '400'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -1491,52 +2009,29 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
- description: ResourceConflict
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
+ Details: The requested action cannot be performed because the project has been deleted.
Code: '409'
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- cluster has been deleted.
+ Details: The requested action cannot be performed because the cluster has been deleted.
Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '400':
- description: InvalidResource
- content:
- application/json:
- example:
- Errors:
- - Type: InvalidResource
- Details: Invalid value for control_planes
- Code: '400'
- - Type: InvalidResource
- Details: Downgrade from a multi-master setup (cp.3) to a
- single master (cp.mono.master) is not allowed.
- Code: '400'
- - Type: InvalidResource
- Details: The 'version' field is required.
- Code: '400'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- Type: ValidationError
- Details: 'Invalid plugin(s): list of invalid_plugins. Allowed plugins
- to enable/disable are: list of allowed_plugins'
+ Details: 'Invalid plugin(s): list of invalid_plugins. Allowed plugins to enable/disable are: list of allowed_plugins'
Code: '422'
- Type: ValidationError
Details: 'Private RFC1918 IPs are not allowed: cidr'
@@ -1557,8 +2052,7 @@ paths:
Details: This version of Kubernetes is not implemented.
Code: '422'
- Type: ValidationError
- Details: Invalid cluster version update. Only +1 minor version
- allowed.
+ Details: Invalid cluster version update. Only +1 minor version allowed.
Code: '422'
- Type: ValidationError
Details:
@@ -1572,8 +2066,21 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -1585,12 +2092,30 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: status'
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Cluster is not ready: status'
+ Code: '503'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- Clusters
summary: Delete Cluster
- description: Deletes a specific cluster by its ID. Returns confirmation of
- the deletion.
+ description: Deletes a specific cluster.
operationId: DeleteCluster
parameters:
- name: cluster_id
@@ -1599,46 +2124,29 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse'
- '503':
- description: ResourceIsNotReady
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: status'
- Code: '503'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
+ '403':
+ description: The HTTP 403 response (Forbidden).
content:
application/json:
example:
Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
+ - Type: ForbiddenError
+ Details: Cluster $uuid can't be deleted because disable_api_termination is enable
+ Code: '403'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -1654,25 +2162,23 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
- description: ResourceConflict
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
+ Details: The requested action cannot be performed because the project has been deleted.
Code: '409'
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- cluster has been deleted.
+ Details: The requested action cannot be performed because the cluster has been deleted.
Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -1689,8 +2195,21 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -1702,16 +2221,21 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '403':
- description: ForbiddenError
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- - Type: ForbiddenError
- Details: Cluster $uuid can't be deleted because
- disable_api_termination is enable
- Code: '403'
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: status'
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Cluster is not ready: status'
+ Code: '503'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
@@ -1721,9 +2245,7 @@ paths:
tags:
- Clusters
summary: Get Cluster Kubeconfig
- description: Retrieves the kubeconfig for a specific cluster by its ID.
- Optionally, you can specify a user, group, and TTL (time-to-live) for
- the kubeconfig. Returns the kubeconfig details as a dictionary.
+ description: Gets the kubeconfig file for a specific cluster. You can specify query parameters for the kubeconfig file.
operationId: GetKubeconfig
parameters:
- name: cluster_id
@@ -1732,33 +2254,56 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
- name: user
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: User
+ description: The user of the kubeconfig file.
- name: group
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Group
+ description: The group of the kubeconfig file.
- name: ttl
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Ttl
+ description: The time to live (TTL) of the kubeconfig file.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KubeconfigResponse'
+ '400':
+ description: The HTTP 400 response (Bad Request).
content:
application/json:
+ example:
+ Errors:
+ - Type: InvalidResource
+ Details: Invalid cluster data format
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
- $ref: '#/components/schemas/KubeconfigResponse'
+ $ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -1773,45 +2318,46 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '400':
- description: InvalidResource
+ '408':
+ description: The HTTP 408 response (Timeout)
content:
application/json:
example:
Errors:
- - Type: InvalidResource
- Details: Invalid cluster data format
- Code: '400'
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing project data
- Code: '500'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the project has been deleted.
+ Code: '409'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the cluster has been deleted.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- Type: ValidationError
- Details: "Invalid user 'user': Usernames cannot start with 'system:'
- or 'oks:' as these are reserved."
+ Details: 'Invalid user ''user'': Usernames cannot start with ''system:'' or ''oks:'' as these are reserved.'
Code: '422'
- Type: ValidationError
- Details: "Invalid group 'group': Group names cannot start with 'system:'
- or 'oks:' as these are reserved."
+ Details: 'Invalid group ''group'': Group names cannot start with ''system:'' or ''oks:'' as these are reserved.'
Code: '422'
- Type: ValidationError
Details:
@@ -1825,29 +2371,27 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '408':
- description: TimeoutError
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
Errors:
- - Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
- Code: '408'
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
- description: ResourceIsNotReady
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- Type: ResourceIsNotReady
- Details: The cluster is currently being created and is not yet
- available. Please try in few minutes.
+ Details: The cluster is currently being created and is not yet available. Please try in few minutes.
Code: '503'
- Type: ResourceIsNotReady
Details: 'Project not ready: status'
@@ -1856,34 +2400,11 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '409':
- description: ResourceConflict
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
- Code: '409'
- - Type: ResourceConflict
- Details: The requested action cannot be performed because the
- cluster has been deleted.
- Code: '409'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
post:
tags:
- Clusters
summary: Post Cluster Kubeconfig
- description: Retrieves the kubeconfig for a specific cluster by its ID
- with optional NaCl public key encryption. Optionally, you can specify a
- user, group, and TTL (time-to-live) for the kubeconfig. If the
- x_encrypt_nacl header is provided, the kubeconfig will be encrypted
- using the given NaCl public key. Returns the kubeconfig details as a
- dictionary.
+ description: Gets the kubeconfig file for a specific cluster, optionally encrypted with a NaCl public key. For more information, see the [NaCl website](https://nacl.cr.yp.to/). You can specify query parameters for the kubeconfig file.
operationId: GetKubeconfigWithPubkeyNACL
parameters:
- name: cluster_id
@@ -1892,39 +2413,65 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
- name: user
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: User
+ description: The user of the kubeconfig file.
- name: group
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Group
+ description: The group of the kubeconfig file.
- name: ttl
in: query
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Ttl
+ description: The time to live (TTL) of the kubeconfig file.
- name: x-encrypt-nacl
in: header
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: X-Encrypt-Nacl
+ description: The header to encrypt the kubeconfig file.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/KubeconfigResponse'
+ '400':
+ description: The HTTP 400 response (Bad Request).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: InvalidResource
+ Details: Invalid cluster data format
+ Code: '400'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -1939,45 +2486,46 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '400':
- description: InvalidResource
+ '408':
+ description: The HTTP 408 response (Timeout)
content:
application/json:
example:
Errors:
- - Type: InvalidResource
- Details: Invalid cluster data format
- Code: '400'
+ - Type: TimeoutError
+ Details: Request Timeout. The server timed out waiting for the request.
+ Code: '408'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '500':
- description: InternalError
+ '409':
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- - Type: InternalError
- Details: Error processing project data
- Code: '500'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the project has been deleted.
+ Code: '409'
+ - Type: ResourceConflict
+ Details: The requested action cannot be performed because the cluster has been deleted.
+ Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
Errors:
- Type: ValidationError
- Details: "Invalid user 'user': Usernames cannot start with 'system:'
- or 'oks:' as these are reserved."
+ Details: 'Invalid user ''user'': Usernames cannot start with ''system:'' or ''oks:'' as these are reserved.'
Code: '422'
- Type: ValidationError
- Details: "Invalid group 'group': Group names cannot start with 'system:'
- or 'oks:' as these are reserved."
+ Details: 'Invalid group ''group'': Group names cannot start with ''system:'' or ''oks:'' as these are reserved.'
Code: '422'
- Type: ValidationError
Details:
@@ -1991,29 +2539,27 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '408':
- description: TimeoutError
+ '500':
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
Errors:
- - Type: TimeoutError
- Details: Request Timeout. The server timed out waiting for the
- request.
- Code: '408'
+ - Type: InternalError
+ Details: Error processing project data
+ Code: '500'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
- description: ResourceIsNotReady
+ description: The HTTP 503 response (Service Unavailable).
content:
application/json:
example:
Errors:
- Type: ResourceIsNotReady
- Details: The cluster is currently being created and is not yet
- available. Please try in few minutes.
+ Details: The cluster is currently being created and is not yet available. Please try in few minutes.
Code: '503'
- Type: ResourceIsNotReady
Details: 'Project not ready: status'
@@ -2022,32 +2568,12 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '409':
- description: ResourceConflict
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
- Code: '409'
- - Type: ResourceConflict
- Details: The requested action cannot be performed because the
- cluster has been deleted.
- Code: '409'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
/clusters/{cluster_id}/upgrade:
patch:
tags:
- Clusters
summary: Upgrade Cluster
- description: Upgrades a specific cluster by its ID to the latest available
- version. Returns the updated cluster details after the upgrade process
- is completed.
+ description: Upgrades a specific cluster to the latest available version of Kubernetes. For more information, see [GetKubernetesVersions](#getkubernetesversions).
operationId: UpgradeCluster
parameters:
- name: cluster_id
@@ -2056,46 +2582,16 @@ paths:
schema:
type: string
title: Cluster Id
+ description: The ID of the cluster.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ClusterResponse'
- '503':
- description: ResourceIsNotReady
- content:
- application/json:
- example:
- Errors:
- - Type: ResourceIsNotReady
- Details: The service has been under global maintenance for 15
- mins. Please, try again later
- Code: '503'
- - Type: ResourceIsNotReady
- Details: 'Project not ready: status'
- Code: '503'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- '423':
- description: LockedResource
- content:
- application/json:
- example:
- Errors:
- - Type: LockedResource
- Details: The project has been under maintenance for 15 mins.
- Please, try again later
- Code: '423'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
'404':
- description: NotFoundError
+ description: The HTTP 404 response (Not Found).
content:
application/json:
example:
@@ -2111,25 +2607,23 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
- description: ResourceConflict
+ description: The HTTP 409 response (Conflict).
content:
application/json:
example:
Errors:
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- project has been deleted.
+ Details: The requested action cannot be performed because the project has been deleted.
Code: '409'
- Type: ResourceConflict
- Details: The requested action cannot be performed because the
- cluster has been deleted.
+ Details: The requested action cannot be performed because the cluster has been deleted.
Code: '409'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2146,8 +2640,21 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '423':
+ description: The HTTP 423 response (Locked Resource).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: LockedResource
+ Details: The project has been under maintenance for 15 mins. Please, try again later
+ Code: '423'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -2159,24 +2666,42 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
+ '503':
+ description: The HTTP 503 response (Service Unavailable).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ResourceIsNotReady
+ Details: The service has been under global maintenance for 15 mins. Please, try again later
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Project not ready: status'
+ Code: '503'
+ - Type: ResourceIsNotReady
+ Details: 'Cluster is not ready: status'
+ Code: '503'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
/clusters/limits/kubernetes_versions:
get:
tags:
- Clusters
summary: Get Kubernetes Versions
- description: Retrieves the available Kubernetes versions for cluster
- creation or upgrades. Returns a list of supported Kubernetes versions.
+ description: Gets the available Kubernetes versions for cluster creation or upgrades.
operationId: GetKubernetesVersions
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/KubernetesVersionsResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2198,19 +2723,18 @@ paths:
tags:
- Clusters
summary: Get Cp Subregions
- description: Retrieves the available subregions for cluster deployment.
- Returns a list of supported subregions for cluster creation.
+ description: Gets the Subregions where you can deploy control planes for your clusters.
operationId: GetCPSubregions
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/CPSubregionsResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2232,20 +2756,58 @@ paths:
tags:
- Clusters
summary: Get Control Plane Plans
- description: Retrieves the available control plane plans for cluster
- deployment. Returns a list of supported control plane plans for cluster
- creation or upgrades.
+ description: Gets the control plane types that you can use to create your clusters.
operationId: GetControlPlanePlans
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/ControlPlanesResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ /clusters/limits/admission_plugins:
+ get:
+ tags:
+ - Clusters
+ summary: Get Admission Plugins
+ description: Gets the list of admission plugins available for cluster configuration.
+ operationId: GetAdmissionPlugins
+ parameters:
+ - name: version
+ in: query
+ required: true
+ schema:
+ type: string
+ title: Version
+ description: The Kubernetes version to filter admission plugins (e.g. 1.30).
+ responses:
+ '200':
+ description: The HTTP 200 response (OK).
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AdmissionPluginsResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2267,21 +2829,18 @@ paths:
tags:
- Templates
summary: Get Project Template
- description: Retrieves the default project template, including predefined
- network configurations, region, and metadata. Returns a JSON response
- containing the request context and template details, such as CIDR block,
- project name, region, description, and tags.
+ description: Gets the default project template, including the predefined network configurations, Region, and metadata.
operationId: GetProjectTemplate
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_ProjectInput_'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2303,29 +2862,27 @@ paths:
tags:
- Templates
summary: Get Cluster Template
- description: Retrieves the default cluster template, including predefined
- control plane configurations, networking settings, and maintenance
- schedules. Returns a JSON response containing the request context and
- template details, such as control plane type, CIDR ranges for pods and
- services, admission flags, multi-AZ support, Kubernetes version,
- subregions, and scheduled automatic maintenance settings.
+ description: Gets the default cluster template, including the predefined control plane configurations, networking settings, and maintenance schedules.
operationId: GetClusterTemplate
parameters:
- name: X-Real-IP
in: header
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: X-Real-Ip
+ description: A header with the IP of the client making the request.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_ClusterInputTemplate_'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2347,22 +2904,18 @@ paths:
tags:
- Templates
summary: Get Nodepool Template
- description: Retrieves the default node pool template, including
- predefined configurations for node scaling, storage, and upgrade
- strategies. Returns a JSON response containing the request context and
- template details, such as node count, node type, availability zones,
- volume specifications, upgrade strategy, and auto-healing settings.
+ description: Gets the default node pool template, including the predefined configurations for node scaling, storage, and upgrade strategies.
operationId: GetNodepoolTemplate
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_Nodepool_'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2384,18 +2937,18 @@ paths:
tags:
- Templates
summary: Get Netpeering Request Template
- description: NetPeering Request manifest
+ description: Gets the default request template used to configure a Net peering, including the predefined fields and values required to create the request.
operationId: GetNetPeeringRequestTemplate
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_NetPeeringRequest_'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2417,18 +2970,18 @@ paths:
tags:
- Templates
summary: Get Netpeering Acceptance Template
- description: NetPeering Acceptance manifest
+ description: Gets the default request template used to accept a Net peering, including the predefined fields and values required to process the acceptance.
operationId: GetNetPeeringAcceptanceTemplate
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_NetPeeringAcceptance_'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2455,13 +3008,31 @@ paths:
parameters: []
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/quotas__quota_schema__QuotasResponse'
+ '422':
+ description: The HTTP 422 response (Unprocessable Content).
+ content:
+ application/json:
+ example:
+ Errors:
+ - Type: ValidationError
+ Details:
+ - loc:
+ - string
+ - 0
+ msg: string
+ type: string
+ Code: '422'
+ ResponseContext:
+ RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
'500':
- description: InternalError
+ description: The HTTP 500 response (Internal Server Error).
content:
application/json:
example:
@@ -2482,47 +3053,32 @@ paths:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
- '422':
- description: ValidationError
- content:
- application/json:
- example:
- Errors:
- - Type: ValidationError
- Details:
- - loc:
- - string
- - 0
- msg: string
- type: string
- Code: '422'
- ResponseContext:
- RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
- schema:
- $ref: '#/components/schemas/ErrorResponse'
/myip:
get:
tags:
- MyIp
summary: Get Client Ip
- description: Returns client IP headers and request ID.
+ description: Gets the IP of the client making the request.
operationId: GetClientIP
parameters:
- name: X-Real-IP
in: header
required: false
schema:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: X-Real-Ip
+ description: The IP of the client.
responses:
'200':
- description: Successful Response
+ description: The HTTP 200 response (OK).
content:
application/json:
schema:
$ref: '#/components/schemas/IPResponse'
'422':
- description: ValidationError
+ description: The HTTP 422 response (Unprocessable Content).
content:
application/json:
example:
@@ -2541,6 +3097,42 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
+ AccessKey:
+ properties:
+ State:
+ type: string
+ enum:
+ - ACTIVE
+ - INACTIVE
+ title: State
+ description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
+ AccessKeyId:
+ type: string
+ title: Access Key Id
+ description: The ID of the access key.
+ CreationDate:
+ type: string
+ title: Creation Date
+ description: The date and time (UTC) at which the access key was created.
+ ExpirationDate:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Expiration Date
+ description: The date and time (UTC) at which the access key expires.
+ SecretKey:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Secret Key
+ description: The secret key that enables you to send requests.
+ type: object
+ required:
+ - State
+ - AccessKeyId
+ - CreationDate
+ title: Access Key
+ description: Information about the access key.
AdmissionFlags:
properties:
disable_admission_plugins:
@@ -2548,22 +3140,21 @@ components:
type: string
type: array
title: Disable Admission Plugins
- description: List of Kubernetes admission plugins that are disabled
+ description: The list of Kubernetes admission plugins that are disabled.
default: []
enable_admission_plugins:
items:
type: string
type: array
title: Enable Admission Plugins
- description: List of Kubernetes admission plugins that are enabled
+ description: The list of Kubernetes admission plugins that are enabled.
default: []
applied_admission_plugins:
items:
type: string
type: array
title: Applied Admission Plugins
- description: List of admission plugins currently applied to the
- cluster
+ description: The list of admission plugins that are currently applied to the cluster.
default:
- CertificateApproval
- CertificateSigning
@@ -2587,6 +3178,7 @@ components:
- ValidatingAdmissionWebhook
type: object
title: AdmissionFlags
+ description: Information about the Kubernetes admission plugins configuration.
AdmissionFlagsInput:
properties:
disable_admission_plugins:
@@ -2594,58 +3186,97 @@ components:
type: string
type: array
title: Disable Admission Plugins
- description: List of Kubernetes admission plugins to disable
- enable_admission_plugins:
+ description: The list of Kubernetes admission plugins to disable.
+ enable_admission_plugins:
+ items:
+ type: string
+ type: array
+ title: Enable Admission Plugins
+ description: The list of Kubernetes admission plugins to enable.
+ type: object
+ title: AdmissionFlagsInput
+ description: Information about the Kubernetes admission plugins.
+ AdmissionPlugins:
+ properties:
+ EnableAdmissionPlugins:
+ items:
+ type: string
+ type: array
+ title: Enable Admission Plugins
+ description: The list of admission plugins that can be enabled.
+ DisableAdmissionPlugins:
+ items:
+ type: string
+ type: array
+ title: Disable Admission Plugins
+ description: The list of admission plugins that can be disabled.
+ DefaultAdmissionPlugins:
items:
type: string
type: array
- title: Enable Admission Plugins
- description: List of Kubernetes admission plugins to enable
+ title: Default Admission Plugins
+ description: The list of admission plugins enabled by default.
type: object
- title: AdmissionFlagsInput
+ required:
+ - EnableAdmissionPlugins
+ - DisableAdmissionPlugins
+ - DefaultAdmissionPlugins
+ title: AdmissionPlugins
+ description: Information about the admission plugins configuration.
+ AdmissionPluginsResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
+ AdmissionPlugins:
+ $ref: '#/components/schemas/AdmissionPlugins'
+ description: Information about the admission plugins configuration.
+ type: object
+ required:
+ - ResponseContext
+ - AdmissionPlugins
+ title: Admission Plugins Response
AuthStrategy:
properties:
oidc:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/OpenIdConnectConfig'
+ - type: 'null'
title: OpenID Connect Authentication
- description: Configuration for authenticating to the cluster using
- OpenID Connect (OIDC).
+ description: The configuration for authenticating to the cluster using OpenID Connect (OIDC).
type: object
- required:
- - oidc
title: AuthStrategy
+ description: Information about the method used by Kubernetes to authenticate API requests.
AutoMaintenances:
properties:
minor_upgrade_maintenance:
allOf:
- $ref: '#/components/schemas/MaintenanceWindow'
title: Minor Upgrade Maintenance
- description: Maintenance window configuration for minor Kubernetes
- upgrades
+ description: The maintenance window configuration for minor Kubernetes upgrades.
patch_upgrade_maintenance:
allOf:
- $ref: '#/components/schemas/MaintenanceWindow'
title: Patch Upgrade Maintenance
- description: Maintenance window configuration for patch Kubernetes
- upgrades
+ description: The maintenance window configuration for patch Kubernetes upgrades.
type: object
required:
- minor_upgrade_maintenance
- patch_upgrade_maintenance
title: AutoMaintenances
+ description: Information about the automated maintenance windows.
AutoUpgradeMaintenance:
properties:
durationHours:
type: integer
title: Duration Hours
- description: Duration of the maintenance window in hours
+ description: The duration of the maintenance window, in hours.
startHour:
type: integer
- maximum: 23.0
- minimum: 0.0
+ maximum: 23
+ minimum: 0
title: Start Hour
- description: Hour of the day when maintenance window starts (0-23)
+ description: The starting time of the maintenance window, in hours.
weekDay:
type: string
enum:
@@ -2657,24 +3288,25 @@ components:
- Sat
- Sun
title: Week Day
- description: Day of the week for the maintenance window (e.g., Mon,
- Tue)
+ description: The weekday on which the maintenance window begins.
type: object
required:
- durationHours
- startHour
- weekDay
title: AutoUpgradeMaintenance
+ description: Information about the window of the automated upgrade maintenance.
CPSubregionsResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
CPSubregions:
items:
type: string
type: array
title: CP Subregions
- description: List of available control plane subregions
+ description: The list of Subregions where you can deploy control planes for your clusters.
type: object
required:
- ResponseContext
@@ -2685,108 +3317,118 @@ components:
project_id:
type: string
title: Project ID
- description: Unique identifier of the project this cluster belongs to
+ description: The ID of the project this cluster belongs to.
id:
type: string
title: Cluster ID
- description: Unique UUID of the cluster
+ description: The Universally Unique Identifier (UUID) of the cluster.
name:
type: string
title: Cluster Name
- description: Unique cluster name per project
+ description: A unique name for the cluster within the project.
description:
type: string
title: Description
- description: Optional description of the cluster
+ description: An optional description of the cluster.
default: ''
cp_multi_az:
type: boolean
title: Control Plane Multi-AZ
- description: Flag indicating if multi-availability zone is enabled for
- the control plane
+ description: If true, multi-Subregion deployment is enabled for the control plane. If false, it is disabled.
cp_subregions:
items:
type: string
type: array
title: Control Plane Subregions
- description: Subregions where control plane components are deployed
+ description: The Subregions on which the control plane components are deployed.
version:
type: string
title: Kubernetes Version
- description: Version of Kubernetes deployed in the cluster
+ description: The Kubernetes version deployed for the cluster. For more information, see [GetKubernetesVersions](#getkubernetesversions).
expected_version:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Expected Kubernetes Version
+ description: The version of Kubernetes that is expected to be deployed during maintenance.
cni:
type: string
title: CNI
- description: Container Network Interface used in the cluster
+ description: The Container Network Interface (CNI) used in the cluster.
admin_lbu:
type: boolean
title: Admin LBU
- description: Flag indicating if admin load balancer is enabled for
- cluster management
+ description: If true, load balancer administration is enabled for cluster management. If false, it is disabled.
admission_flags:
allOf:
- $ref: '#/components/schemas/AdmissionFlags'
title: Admission Flags
- description: Configuration for Kubernetes admission controllers
+ description: The configuration for Kubernetes admission controllers.
cidr_pods:
type: string
title: Pods CIDR
- description: CIDR block for Kubernetes pods network
+ description: The CIDR block of the Kubernetes pods' network.
cidr_service:
type: string
title: Service CIDR
- description: CIDR block for Kubernetes services network
+ description: The CIDR block of the Kubernetes services' network.
cluster_dns:
type: string
title: Cluster DNS
- description: IP address for cluster DNS service
+ description: The IP of the cluster's DNS service.
tags:
additionalProperties:
type: string
type: object
title: Tags
- description: Key-value pairs for cluster metadata
+ description: The key/value combinations of the tags associated with the cluster, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
example:
key: value
auto_maintenances:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AutoMaintenances'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The configuration for automated maintenance windows.
+ deprecated: true
maintenance_window:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/Maintenance'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The configuration for automated maintenance windows.
control_planes:
type: string
title: Control Planes
- description: Type of control plane deployment for the cluster
+ description: The control plane sizing of the cluster.
expected_control_planes:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Expected Control Planes
+ description: The type of control plane size that is expected.
admin_whitelist:
items:
type: string
type: array
title: Admin Whitelist
- description: List of CIDR blocks or IP addresses allowed to access the
- Kubernetes API
+ description: The list of CIDR blocks or IPs allowed to access the cluster via the Kubernetes API.
statuses:
+ description: The status information of the cluster.
allOf:
- $ref: '#/components/schemas/Statuses'
- description: Current status information about the cluster
disable_api_termination:
type: boolean
title: Disable API Termination
- description: Flag to prevent accidental cluster deletion
+ description: If true, cluster deletion through the API is disabled. If false, it is enabled.
default: false
example: false
auth:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AuthStrategy'
- nullable: true
+ - type: 'null'
+ title: Cluster Authentication Configuration
+ description: The authentication strategy used to access the cluster.
type: object
required:
- project_id
@@ -2806,6 +3448,7 @@ components:
- admin_whitelist
- statuses
title: Cluster
+ description: Information about the cluster.
ClusterInput:
properties:
name:
@@ -2814,102 +3457,119 @@ components:
minLength: 1
pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
title: Cluster Name
- description: Unique cluster name per project, must start with a letter
- and contain only lowercase letters, numbers, or hyphens
+ description: A unique name for the cluster within the project.
example: awesome-cluster
project_id:
type: string
title: Project ID
- description: Unique identifier of the project this cluster belongs to
+ description: The ID of the project in which you want to create a cluster.
description:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Description
+ description: A description of the cluster.
+ default: ''
cp_multi_az:
type: boolean
title: Control Plane Multi-AZ
- description: Flag to enable multi-availability zone for the control
- plane
+ description: If true, multi-Subregion deployment is enabled for the control plane. If false, it is disabled.
cp_subregions:
items:
type: string
type: array
title: Control Plane Subregions
- description: List of subregions where control plane components are
- deployed
+ description: The list of Subregions where control plane components are deployed.
default: []
version:
type: string
title: Kubernetes Version
- description: Version of Kubernetes to be deployed
+ description: The Kubernetes version to be deployed for the cluster. For more information, see [GetKubernetesVersions](#getkubernetesversions).
admin_lbu:
type: boolean
title: Admin LBU
- description: Flag to enable admin load balancer for cluster management
+ description: If true, load balancer administration is enabled for cluster management. If false, it is disabled.
default: false
admission_flags:
allOf:
- $ref: '#/components/schemas/AdmissionFlagsInput'
title: Admission Flags
- description: Configuration for Kubernetes admission controllers
+ description: The configuration for Kubernetes admission controllers.
default: {}
+ cni:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: CNI
+ description: The Container Network Interface to use in the cluster
+ default: cilium
cidr_pods:
type: string
title: Pods CIDR
- description: CIDR block for Kubernetes pods network
+ description: The CIDR block for Kubernetes pods' network.
example: 10.91.0.0/16
cidr_service:
type: string
title: Service CIDR
- description: CIDR block for Kubernetes services network
+ description: The CIDR block for the Kubernetes services' network.
example: 10.92.0.0/16
cluster_dns:
type: string
title: Cluster DNS
- description: IP address for cluster DNS service
+ description: The IP for the cluster's DNS service.
example: 10.92.0.10
tags:
- additionalProperties:
- type: string
- type: object
- nullable: true
+ anyOf:
+ - additionalProperties:
+ type: string
+ type: object
+ - type: 'null'
+ title: Tags
+ description: The key/value combinations of the tags associated with the cluster's metadata, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
+ example:
+ key: value
auto_maintenances:
allOf:
- $ref: '#/components/schemas/AutoMaintenances'
title: Auto Maintenances
- description: Use 'maintenance_window' instead
+ description: The configuration for automated maintenance windows.
deprecated: true
maintenance_window:
allOf:
- $ref: '#/components/schemas/Maintenance'
title: Maintenance Window
- description: Configuration for automated maintenance windows
+ description: The configuration for automated maintenance windows.
control_planes:
type: string
title: Control Planes
- description: Size of control plane deployment for the cluster
+ description: The size of control plane deployment for the cluster. For more information, see [About OKS > Control Planes](https://docs.outscale.com/en/userguide/About-OKS.html#_control_planes).
default: cp.3.masters.small
admin_whitelist:
items:
type: string
type: array
title: Admin Whitelist
- description: List of CIDR blocks or IP addresses allowed to access the
- Kubernetes API
+ description: The list of CIDR blocks or IPs allowed to access the cluster via the Kubernetes API.
quirks:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Quirks
+ description: The list of special configurations or behaviors for the cluster.
disable_api_termination:
type: boolean
title: Disable API Termination
- description: Flag to prevent accidental cluster deletion
+ description: If true, cluster deletion through the API is disabled. If false, it is enabled.
default: false
example: false
auth:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AuthStrategy'
- nullable: true
+ - type: 'null'
+ title: Cluster Authentication Configuration
+ description: The authentication strategy used to access the cluster.
type: object
required:
- name
@@ -2919,82 +3579,94 @@ components:
- cidr_service
- admin_whitelist
title: ClusterInput
+ description: Information about the cluster configuration.
ClusterInputTemplate:
properties:
project_id:
type: string
title: Project ID
- description: Unique identifier of the project this cluster belongs to
+ description: The ID of the project to which this cluster belongs to.
description:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Description
+ description: The description of the cluster.
+ default: ''
version:
type: string
title: Kubernetes Version
- description: Version of Kubernetes to be deployed
+ description: The Kubernetes version deployed for the cluster. For more information, see [GetKubernetesVersions](#getkubernetesversions).
admin_lbu:
type: boolean
title: Admin LBU
- description: Flag to enable admin load balancer for cluster management
+ description: If true, the admin load balancer for cluster management is enabled. If false, it is disabled.
default: false
admission_flags:
allOf:
- $ref: '#/components/schemas/AdmissionFlagsInput'
title: Admission Flags
- description: Configuration for Kubernetes admission controllers
+ description: The configuration for Kubernetes admission controllers.
default: {}
cidr_pods:
type: string
title: Pods CIDR
- description: CIDR block for Kubernetes pods network
+ description: The CIDR block of the Kubernetes pods' network.
example: 10.91.0.0/16
cidr_service:
type: string
title: Service CIDR
- description: CIDR block for Kubernetes services network
+ description: The CIDR block of the Kubernetes pods' network.
example: 10.92.0.0/16
cluster_dns:
type: string
title: Cluster DNS
- description: IP address for cluster DNS service
+ description: The IP for the cluster DNS service.
example: 10.92.0.10
tags:
additionalProperties:
type: string
type: object
title: Tags
- description: Key-value pairs for cluster metadata
+ description: The key/value combinations of the tags associated with the cluster's metadata, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
example:
key: value
auto_maintenances:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AutoMaintenances'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The configuration for automated maintenance windows.
+ deprecated: true
maintenance_window:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/Maintenance'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The configuration for automated maintenance windows.
control_planes:
type: string
title: Control Planes
- description: Size of control plane deployment for the cluster
+ description: The control plane type of the cluster.
default: cp.3.masters.small
admin_whitelist:
items:
type: string
type: array
title: Admin Whitelist
- description: List of CIDR blocks or IP addresses allowed to access the
- Kubernetes API
+ description: The list of CIDR blocks or IPs allowed to access the cluster via the Kubernetes API.
quirks:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Quirks
+ description: A list of special configurations or behaviors for the cluster.
disable_api_termination:
type: boolean
title: Disable API Termination
- description: Flag to prevent accidental cluster deletion
+ description: If true, cluster deletion through the API is disabled. If false, it is enabled.
default: false
example: false
type: object
@@ -3003,12 +3675,15 @@ components:
- version
- admin_whitelist
title: ClusterInputTemplate
+ description: Information about the default cluster template.
ClusterResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
Cluster:
$ref: '#/components/schemas/Cluster'
+ description: Information about the cluster.
type: object
required:
- ResponseContext
@@ -3018,78 +3693,110 @@ components:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
Pagination:
$ref: '#/components/schemas/Pagination'
+ description: Information used to split large lists of results into multiple responses (either cursor or offset-based).
Clusters:
items:
$ref: '#/components/schemas/Cluster'
type: array
title: Clusters
- description: List of clusters retrieved from the API
+ description: Information about the clusters.
type: object
required:
- ResponseContext
- Pagination
- Clusters
title: Cluster Response List
+ description: Information about the clusters associated with a project.
ClusterUpdate:
properties:
description:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Description
+ description: The updated description of the cluster.
admission_flags:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AdmissionFlagsInput'
- nullable: true
+ - type: 'null'
+ title: Admission Flags
+ description: The updated configuration for Kubernetes admission controllers.
tags:
- additionalProperties:
- type: string
- type: object
- nullable: true
+ anyOf:
+ - additionalProperties:
+ type: string
+ type: object
+ - type: 'null'
+ title: Tags
+ description: The updated key/value combinations of the tags associated with the cluster's metadata, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
auto_maintenances:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AutoMaintenances'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The updated configuration for automated maintenance windows.
+ deprecated: true
maintenance_window:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/Maintenance'
- nullable: true
+ - type: 'null'
+ title: Auto Maintenances
+ description: The updated configuration for automated maintenance windows.
admin_whitelist:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Admin Whitelist
+ description: The updated list of CIDR blocks or IPs allowed to access the cluster via the Kubernetes API.
quirks:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Quirks
+ description: The updated list of special configurations or behaviors for the cluster.
disable_api_termination:
- type: boolean
- nullable: true
+ anyOf:
+ - type: boolean
+ - type: 'null'
+ title: Disable API Termination
+ description: If true, cluster deletion through the API is disabled. If false, it is enabled.
version:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Kubernetes Version
+ description: The updated version of Kubernetes for the cluster. For more information, see [GetKubernetesVersions](#getkubernetesversions).
control_planes:
type: string
title: Control Planes
- description: Size of control plane deployment for the cluster
+ description: The size of the control plane deployment for the cluster.
auth:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/AuthStrategy'
- nullable: true
+ - type: 'null'
+ title: Cluster Authentication Configuration
+ description: The authentication strategy used to access the cluster.
type: object
title: ClusterUpdate
+ description: Information about the updated cluster configuration.
ControlPlanesResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
ControlPlanes:
items:
type: string
type: array
title: Control Planes
- description: List of available control plane types
+ description: The list of available control plane types.
type: object
required:
- ResponseContext
@@ -3098,43 +3805,160 @@ components:
Cursor:
properties:
next_cursor:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Next Cursor
+ description: The pagination token indicating where the next set of results should start.
type: object
title: Cursor
+ description: Information about the position in the result list for pagination.
DetailResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
detail:
type: string
title: Detail
- description: Detailed message related to the API response
+ description: A detailed message related to the API response.
type: object
required:
- ResponseContext
- detail
title: DetailResponse
+ DetailsResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
+ Details:
+ type: string
+ title: Details
+ description: Details about the response.
+ type: object
+ required:
+ - ResponseContext
+ - Details
+ title: Details Response
+ EimUser:
+ properties:
+ UserName:
+ type: string
+ title: User Name
+ description: The name of the EIM user.
+ AccessKeys:
+ items:
+ $ref: '#/components/schemas/AccessKey'
+ type: array
+ title: Access Keys
+ description: A list of access keys.
+ type: object
+ required:
+ - UserName
+ title: EIM User
+ description: The name of the EIM user.
+ EimUserResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
+ EimUser:
+ $ref: '#/components/schemas/EimUser'
+ description: The name of the EIM user.
+ type: object
+ required:
+ - ResponseContext
+ - EimUser
+ title: EIM User Response
+ EimUserType:
+ properties:
+ UserType:
+ type: string
+ title: User Type
+ description: The type of the EIM user.
+ Description:
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Description
+ description: The description of the EIM user.
+ type: object
+ required:
+ - UserType
+ - Description
+ title: EimUserType
+ description: The type of EIM user.
+ EimUserTypesResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
+ EimUserTypes:
+ items:
+ $ref: '#/components/schemas/EimUserType'
+ type: array
+ title: Eimusertypes
+ description: Information about the EIM user types.
+ type: object
+ required:
+ - ResponseContext
+ - EimUserTypes
+ title: EIM User Types Response
+ EimUsersResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
+ EimUsers:
+ items:
+ $ref: '#/components/schemas/EimUser'
+ type: array
+ title: EIM User
+ description: A list of EIM users.
+ type: object
+ required:
+ - ResponseContext
+ title: EIM Users Response
+ EnryptedResponse:
+ properties:
+ ResponseContext:
+ $ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
+ Data:
+ type: string
+ title: Enrypted data
+ description: Encrypted data in Base64 format.
+ type: object
+ required:
+ - ResponseContext
+ - Data
+ title: Enrypted Response
ErrorItem:
properties:
Type:
type: string
title: Type
+ description: The type of error.
Details:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/ValidationDetail'
type: array
+ title: Details
+ description: Details about the error.
Code:
type: string
title: Code
+ description: The error code.
type: object
required:
- Type
- Details
- Code
title: ErrorItem
+ description: Information about the error.
ErrorResponse:
properties:
Errors:
@@ -3142,8 +3966,10 @@ components:
$ref: '#/components/schemas/ErrorItem'
type: array
title: Errors
+ description: A list of errors.
ResponseContext:
$ref: '#/components/schemas/ResponseContext-Input'
+ description: Information about the context of the response.
type: object
required:
- Errors
@@ -3152,16 +3978,22 @@ components:
IPDetails:
properties:
x_real_ip:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: X-Real-IP
+ description: The IP associated with the incoming request.
type: object
title: IPDetails
+ description: Details related to the IP.
IPResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/myip__myip_schema__ResponseContext'
+ description: Information about the context of the response.
IP:
$ref: '#/components/schemas/IPDetails'
+ description: Details related to the IP.
type: object
required:
- ResponseContext
@@ -3172,17 +4004,20 @@ components:
kubeconfig:
type: string
title: Kubeconfig
- description: Kubernetes configuration file content for cluster access
+ description: The content of the kubeconfig file used to configure access to the cluster.
type: object
required:
- kubeconfig
title: KubeconfigData
+ description: Information about the kubeconfig for the cluster.
KubeconfigResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
Cluster:
$ref: '#/components/schemas/clusters__cluster_schema__RPCResponse'
+ description: The kubeconfig details associated with the cluster.
type: object
required:
- ResponseContext
@@ -3192,12 +4027,13 @@ components:
properties:
ResponseContext:
$ref: '#/components/schemas/clusters__cluster_schema__ResponseContext'
+ description: Information about the context of the response.
Versions:
items:
type: string
type: array
title: Versions
- description: List of available Kubernetes versions
+ description: A list of available Kubernetes versions.
type: object
required:
- ResponseContext
@@ -3207,16 +4043,16 @@ components:
properties:
duration_hours:
type: integer
- maximum: 23.0
- minimum: 0.0
+ maximum: 23
+ minimum: 0
title: Duration Hours
- description: Duration of the maintenance window in hours
+ description: The duration of the maintenance window, in hours.
start_hour:
type: integer
- maximum: 23.0
- minimum: 0.0
+ maximum: 23
+ minimum: 0
title: Start Hour
- description: Hour of the day when maintenance window starts (0-23)
+ description: The starting time of the maintenance window, in hours.
week_day:
type: string
enum:
@@ -3229,11 +4065,11 @@ components:
- Sun
- string
title: Week Day
- description: Day of the week for the maintenance window
+ description: The weekday on which the maintenance window begins.
tz:
type: string
title: Timezone
- description: Timezone for the maintenance window
+ description: The timezone for the maintenance window.
default: UTC
type: object
required:
@@ -3241,26 +4077,27 @@ components:
- start_hour
- week_day
title: Maintenance
+ description: Information about the maintenance window configuration.
MaintenanceWindow:
properties:
enabled:
type: boolean
title: Enabled
- description: Flag to enable or disable the maintenance window
+ description: If true, a maintenance window is enabled.
default: true
duration_hours:
type: integer
- maximum: 23.0
- minimum: 0.0
+ maximum: 23
+ minimum: 0
title: Duration Hours
- description: Duration of the maintenance window in hours
+ description: The duration of the maintenance window, in hours.
default: 0
start_hour:
type: integer
- maximum: 23.0
- minimum: 0.0
+ maximum: 23
+ minimum: 0
title: Start Hour
- description: Hour of the day when maintenance window starts (0-23)
+ description: The starting time of the maintenance window, in hours.
default: 12
week_day:
type: string
@@ -3274,27 +4111,26 @@ components:
- Sun
- string
title: Week Day
- description: Day of the week for the maintenance window
+ description: The weekday on which the maintenance window begins.
default: Tue
tz:
type: string
title: Timezone
- description: Timezone for the maintenance window
+ description: The timezone for the maintenance window.
default: UTC
type: object
title: MaintenanceWindow
+ description: Information about the maintenance window configuration.
Net:
properties:
DhcpOptionsSetId:
type: string
title: DHCP Options ID
- description: The ID of the DHCP options set (or default if you want to
- associate the default one).
+ description: The ID of the DHCP options set.
IpRange:
type: string
title: IP Range
- description: The IP range for the Net, in CIDR notation (for example,
- 10.0.0.0/16).
+ description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`)
NetId:
type: string
title: Net ID
@@ -3302,11 +4138,11 @@ components:
State:
type: string
title: State
- description: The state of the Net (pending | available | deleting).
+ description: The state of the Net (`pending` | `available` | `deleting`).
Tenancy:
type: string
title: Tenancy
- description: The VM tenancy in a Net.
+ description: The VM tenancy in the Net.
type: object
required:
- DhcpOptionsSetId
@@ -3315,26 +4151,26 @@ components:
- State
- Tenancy
title: Net
+ description: Information about the Net.
NetPeeringAcceptance:
properties:
apiVersion:
type: string
title: API Version
- description: Version of the NetPeeringAcceptance API being used
+ description: The Net peering API version in use.
kind:
type: string
title: Kind
- description: Resource type, always 'NetPeeringAcceptance' for
- netpeering acceptance resources
+ description: The resource type, always `NetPeeringAcceptance`.
metadata:
+ description: The metadata information for the Net peering.
allOf:
- $ref: '#/components/schemas/netpeerings__netpeering_schema__Metadata'
- description: Metadata information for the netpeering acceptance
spec:
allOf:
- $ref: '#/components/schemas/SpecNetPeeringAcceptance'
title: Spec
- description: Specification of the netpeering acceptance configuration
+ description: The configuration for accepting the Net peering.
type: object
required:
- apiVersion
@@ -3342,26 +4178,26 @@ components:
- metadata
- spec
title: NetPeeringAcceptance
+ description: The custom resource used to accept the Net peering.
NetPeeringRequest:
properties:
apiVersion:
type: string
title: API Version
- description: Version of the NetPeeringRequest API being used
+ description: The Net peering API version in use.
kind:
type: string
title: Kind
- description: Resource type, always 'NetPeeringRequest' for netpeering
- request resources
+ description: The resource type, always `NetPeeringRequest`.
metadata:
+ description: The metadata information for the Net peering.
allOf:
- $ref: '#/components/schemas/netpeerings__netpeering_schema__Metadata'
- description: Metadata information for the netpeering request
spec:
allOf:
- $ref: '#/components/schemas/SpecNetPeeringRequest'
title: Spec
- description: Specification of the netpeering request configuration
+ description: The configuration for the custom resource used to request a Net peering.
type: object
required:
- apiVersion
@@ -3369,16 +4205,28 @@ components:
- metadata
- spec
title: NetPeeringRequest
+ NetSpecific:
+ properties:
+ disable_lan_security_groups:
+ type: boolean
+ title: Disable LAN security groups
+ description: The value used to modify the firewall behavior within the VPC.
+ type: object
+ required:
+ - disable_lan_security_groups
+ title: NetSpecific
+ description: Information about the network-specific configuration.
NetsResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
Nets:
items:
$ref: '#/components/schemas/Net'
type: array
title: Nets
- description: Information about the described Nets
+ description: Net details associated with the project.
type: object
required:
- ResponseContext
@@ -3389,19 +4237,19 @@ components:
apiVersion:
type: string
title: API Version
- description: Version of the Nodepool API being used
+ description: The node pool API version in use.
kind:
type: string
title: Kind
- description: Resource type, always 'Nodepool' for nodepool resources
+ description: The resource type, always `Nodepool` for node pool resources.
metadata:
+ description: The metadata information for the node pool.
allOf:
- $ref: '#/components/schemas/nodepools__nodepool_schema__Metadata'
- description: Metadata information for the nodepool
spec:
+ description: The specification for the node pool configuration.
allOf:
- $ref: '#/components/schemas/Spec'
- description: Specification of the nodepool configuration
type: object
required:
- apiVersion
@@ -3409,25 +4257,29 @@ components:
- metadata
- spec
title: Nodepool
+ description: Information about the node pool.
OKSQuotas:
properties:
Projects:
type: integer
title: Projects
+ description: The maximum allowed number of projects.
ClustersPerProject:
type: integer
title: Clustersperproject
+ description: The maximum allowed number of clusters per project.
KubeVersions:
items:
type: string
type: array
title: Max Value
- description: Maximum allowed value for this quota
+ description: The list of available Kubernetes versions.
CPSubregions:
items:
type: string
type: array
title: Cpsubregions
+ description: The list of available Subregions.
type: object
required:
- Projects
@@ -3435,66 +4287,101 @@ components:
- KubeVersions
- CPSubregions
title: OKSQuotas
+ description: Information about your quotas.
Offset:
properties:
page:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Page
+ description: The page number of the current results.
limit:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Limit
+ description: The maximum number of results returned per page.
total:
- type: integer
- nullable: true
+ anyOf:
+ - type: integer
+ - type: 'null'
+ title: Total
+ description: The total number of available results.
type: object
title: Offset
+ description: Information about the current pagination state when using offset-based pagination.
OpenIdConnectConfig:
properties:
issuer-url:
type: string
title: OIDC Issuer URL
- description: The URL of the provider that allows the API server to
- discover public signing keys.
+ description: The server URL of the OIDC provider, using the HTTPS protocol (`https://`).
client-id:
type: string
title: OIDC Client ID
- description: The client id that all tokens must be issued for.
+ description: The client ID provided by the OIDC provider. This will be used by the cluster to connect to the server.
username-claim:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Username Claim
+ description: A JSON Web Token (JWT) claim provided by the OIDC provider. This will be used to retrieve the username on the Kubernetes side.
username-prefix:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Username Prefix
+ description: A prefix added to the Kubernetes username, to prevent clashing with existing names (for example, `oidc:`).
groups-claim:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Groups Claim
+ description: A JSON Web Token (JWT) claim provided by the OIDC provider. This will be used to retrieve the user's group on the Kubernetes side.
groups-prefix:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Groups Prefix
+ description: A prefix added to the Kubernetes group, to prevent clashing with existing names (for example, `oidc:`).
required-claim:
- additionalProperties:
- type: string
- type: object
- nullable: true
+ anyOf:
+ - additionalProperties:
+ anyOf:
+ - type: string
+ - type: boolean
+ - type: integer
+ - type: number
+ type: object
+ - type: 'null'
+ title: Required OIDC Claims
+ description: The key/value combination of OIDC claims that must be included in the ID token for the user to authenticate. If not specified, no claim-based restrictions are enforced.
+ example:
+ claim: value
type: object
required:
- issuer-url
- client-id
title: OpenIdConnectConfig
+ description: The configuration parameters to activate the OpenID Connect (OIDC) authentication protocol.
Pagination:
properties:
cursor:
- allOf:
+ description: Information used for cursor-based pagination.
+ anyOf:
- $ref: '#/components/schemas/Cursor'
- nullable: true
+ - type: 'null'
offset:
- allOf:
+ description: Information used for offset-based pagination.
+ anyOf:
- $ref: '#/components/schemas/Offset'
- nullable: true
+ - type: 'null'
type: object
title: Pagination
+ description: Information used to split large lists of results into multiple responses (either cursor or offset-based).
PermissionsOnResource:
properties:
GlobalPermission:
@@ -3506,66 +4393,75 @@ components:
type: string
type: array
title: Account IDs
- description: One or more account IDs that the permission is associated
- with.
+ description: One or more account IDs that the permission is associated with.
type: object
required:
- GlobalPermission
- AccountIds
title: PermissionsOnResource
+ description: Information about the permissions for a resource.
Project:
properties:
id:
type: string
title: Project ID
- description: Unique UUID of the project
+ description: The ID of the project.
name:
type: string
title: Project Name
- description: Unique project name per account
+ description: The name of the project.
description:
type: string
title: Description
- description: Optional description of the project
+ description: A description for the project.
default: ''
cidr:
type: string
title: VPC CIDR
- description: CIDR block associated with the project's VPC
+ description: The CIDR block associated with the Net of the project.
region:
type: string
title: Region
- description: Region where the project is deployed
+ description: The Region on which the project is deployed.
status:
type: string
title: Status
- description: Current status of the project
+ description: The status of the project (`pending` | `ready` | `updating` | `failed` | `deleting`).
tags:
additionalProperties:
type: string
type: object
title: Tags
- description: Key-value pairs tags
+ description: The key/value combinations of the tags associated with the resource, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
+ net_specific:
+ anyOf:
+ - $ref: '#/components/schemas/NetSpecific'
+ - type: 'null'
+ title: Net Specific
+ description: The field to configure network-specific behavior for the VPC of the project.
disable_api_termination:
type: boolean
title: Disable API Termination
- description: Flag to prevent accidental project deletion
+ description: If true, project deletion through the API is disabled. If false, it is enabled.
default: false
example: false
created_at:
type: string
format: date-time
title: Created At
- description: Timestamp when the project was created
+ description: The timestamp when the project was created.
updated_at:
type: string
format: date-time
title: Updated At
- description: Timestamp when the project was last updated
+ description: The timestamp when the project was last updated.
deleted_at:
- type: string
- format: date-time
- nullable: true
+ anyOf:
+ - type: string
+ format: date-time
+ - type: 'null'
+ title: Deleted At
+ description: The timestamp when the project was deleted (if applicable).
type: object
required:
- id
@@ -3577,6 +4473,7 @@ components:
- created_at
- updated_at
title: Project
+ description: Information about the project.
ProjectInput:
properties:
name:
@@ -3585,36 +4482,49 @@ components:
minLength: 1
pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
title: Project Name
- description: Unique name for the project, must start with a letter and
- contain only lowercase letters, numbers, or hyphens
+ description: A unique name for the project. Must start with a letter and contain only lowercase letters, numbers, or hyphens.
example: awesome-project
description:
type: string
title: Description
- description: Optional description of the project
+ description: A description for the project.
default: ''
cidr:
type: string
title: VPC CIDR
- description: CIDR block associated with the project's VPC
+ description: The CIDR block to associate with the Net of the project.
region:
type: string
title: Region
- description: Region where the project is deployed
+ description: The Region on which the project is deployed.
tags:
- additionalProperties:
- type: string
- type: object
- nullable: true
+ anyOf:
+ - additionalProperties:
+ type: string
+ type: object
+ - type: 'null'
+ title: Tags
+ description: The key/value combinations of the tags associated with the resource, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
+ example:
+ key: value
+ net_specific:
+ anyOf:
+ - $ref: '#/components/schemas/NetSpecific'
+ - type: 'null'
+ title: Net Specific
+ description: Network-specific configuration for the project.
quirks:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Quirks
+ description: A list of special configurations or behaviors for the project.
disable_api_termination:
type: boolean
title: Disable API Termination
- description: Flag to prevent accidental project deletion
+ description: If true, project deletion through the API is disabled. If false, it is enabled.
default: false
example: false
type: object
@@ -3623,12 +4533,15 @@ components:
- cidr
- region
title: ProjectInput
+ description: Information about the project configuration.
ProjectResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
Project:
$ref: '#/components/schemas/Project'
+ description: Information about the project.
type: object
required:
- ResponseContext
@@ -3638,40 +4551,58 @@ components:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
Pagination:
$ref: '#/components/schemas/Pagination'
+ description: Information used to split large lists of results into multiple responses (either cursor or offset-based).
Projects:
items:
$ref: '#/components/schemas/Project'
type: array
title: Projects
- description: List of projects retrieved from the API
+ description: The list of retrieved projects.
type: object
required:
- ResponseContext
- Pagination
- Projects
title: ProjectResponseList
+ description: Information about the retrieved projects.
ProjectUpdate:
properties:
description:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Description
+ description: The updated description for the project.
tags:
- additionalProperties:
- type: string
- type: object
- nullable: true
+ anyOf:
+ - additionalProperties:
+ type: string
+ type: object
+ - type: 'null'
+ title: Tags
+ description: The updated key/value combinations of the tags associated with the project's metadata, in the following format: `"tags":{"TAGKEY1":"TAGVALUE1","TAGKEY2":"TAGVALUE2"}`.
+ example:
+ key: value
quirks:
- items:
- type: string
- type: array
- nullable: true
+ anyOf:
+ - items:
+ type: string
+ type: array
+ - type: 'null'
+ title: Quirks
+ description: The updated list of special configurations or behaviors for the project.
disable_api_termination:
- type: boolean
- nullable: true
+ anyOf:
+ - type: boolean
+ - type: 'null'
+ title: Disable API Termination
+ description: If true, project deletion through the API is disabled. If false, it is enabled.
type: object
title: ProjectUpdate
+ description: Information about the updated project configuration.
PublicIp:
properties:
Tags:
@@ -3683,7 +4614,7 @@ components:
PublicIp:
type: string
title: Public IP
- description: The public IP.
+ description: The address of the public IP.
PublicIpId:
type: string
title: Public IP ID
@@ -3694,16 +4625,18 @@ components:
- PublicIp
- PublicIpId
title: PublicIp
+ description: Information about the public IP.
PublicIpsResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
PublicIps:
items:
$ref: '#/components/schemas/PublicIp'
type: array
title: Project Public IPs
- description: Public IP details associated with the project
+ description: The public IP details associated with the project.
type: object
required:
- ResponseContext
@@ -3714,31 +4647,31 @@ components:
ShortDescription:
type: string
title: Short Description
- description: Brief summary of the quota
+ description: A brief summary of the quota.
QuotaCollection:
type: string
title: Quota Collection
- description: Category or group to which the quota belongs
+ description: A category or group to which the quota belongs to.
AccountId:
type: string
title: Account ID
- description: Unique identifier for the account
+ description: The ID of the account.
Description:
type: string
title: Description
- description: Detailed description of the quota
+ description: A detailed description of the quota.
MaxValue:
type: integer
title: Max Value
- description: Maximum allowed value for this quota
+ description: The maximum allowed value for the quota.
UsedValue:
type: integer
title: Used Value
- description: Current usage value for this quota
+ description: The current usage value for the quota.
Name:
type: string
title: Name
- description: Quota name
+ description: The name of the quota.
type: object
required:
- ShortDescription
@@ -3749,6 +4682,7 @@ components:
- UsedValue
- Name
title: Quotas
+ description: Information about the quotas.
QuotasData:
properties:
quotas:
@@ -3756,49 +4690,52 @@ components:
$ref: '#/components/schemas/Quotas'
type: array
title: Quotas
- description: List of quota details
+ description: A list of quota details.
subregions:
items:
$ref: '#/components/schemas/Subregion'
type: array
title: Subregions
- description: List of subregion details
+ description: A list of Subregion details.
type: object
required:
- quotas
- subregions
title: QuotasData
+ description: Information about the quotas for a project.
ResourceTag:
properties:
Key:
type: string
title: Key
- description: The key of the tag, with a minimum of 1 character.
+ description: The key for the tag.
Value:
type: string
title: Value
- description: The value of the tag, between 0 and 255 characters.
+ description: The value for the tag.
type: object
required:
- Key
- Value
title: ResourceTag
+ description: Information about the tags associated with a resource.
ResponseContext-Input:
properties:
RequestId:
type: string
title: Requestid
+ description: The ID of the request.
type: object
required:
- RequestId
title: ResponseContext
+ description: Information about the context of the response.
Snapshot:
properties:
VolumeSize:
type: integer
title: Volume Size
- description: The size of the volume used to create the snapshot, in
- gibibytes (GiB).
+ description: The size of the volume used to create the snapshot, in gibibytes (GiB).
AccountId:
type: string
title: Account ID
@@ -3810,8 +4747,7 @@ components:
CreationDate:
type: string
title: Creation Date
- description: The date and time (UTC) at which the snapshot was
- created.
+ description: The date and time (UTC) at which the snapshot was created.
Progress:
type: integer
title: Progress
@@ -3823,8 +4759,7 @@ components:
State:
type: string
title: State
- description: The state of the snapshot (in-queue | pending | completed
- | error | deleting).
+ description: The state of the snapshot (`in-queue` | `pending` | `completed` | `error` | `deleting`).
Description:
type: string
title: Description
@@ -3853,16 +4788,18 @@ components:
- Tags
- PermissionsToCreateVolume
title: Snapshot
+ description: Information about the Snapshot.
SnapshotsResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
Snapshots:
items:
$ref: '#/components/schemas/Snapshot'
type: array
title: Project Snapshots
- description: Snapshot details associated with the project
+ description: Snapshot details associated with the project.
type: object
required:
- ResponseContext
@@ -3873,32 +4810,32 @@ components:
desiredNodes:
type: string
title: Desired Nodes
- description: Number of nodes desired in the nodepool
+ description: The number of desired nodes in the node pool.
nodeType:
type: string
title: Node Type
- description: Instance type for the nodes
+ description: The type of VM for the nodes.
zones:
items:
type: string
type: array
title: Zones
- description: List of availability zones where nodes should be deployed
+ description: A list of Subregions where nodes should be deployed.
volumes:
items:
$ref: '#/components/schemas/Volume'
type: array
title: Volumes
- description: List of volume configurations for the nodes
+ description: A list of volume configurations for the nodes.
upgradeStrategy:
allOf:
- $ref: '#/components/schemas/UpgradeStrategy'
title: Upgrade Strategy
- description: Configuration for managing nodepool upgrades
+ description: The configuration for managing node pool upgrades.
autoHealing:
type: boolean
title: Auto Healing
- description: Flag to enable automatic healing of failed nodes
+ description: If true, the automatic healing of failed nodes is enabled.
type: object
required:
- desiredNodes
@@ -3908,26 +4845,28 @@ components:
- upgradeStrategy
- autoHealing
title: Spec
+ description: Information about the specification for the node pool configuration.
SpecNetPeeringAcceptance:
properties:
netPeeringId:
type: string
title: NetID
- description: Net Peering ID
+ description: The ID of the Net peering to accept.
type: object
required:
- netPeeringId
title: SpecNetPeeringAcceptance
+ description: The configuration of the custom resource used to accept a Net peering.
SpecNetPeeringRequest:
properties:
accepterNetId:
type: string
title: Accepter NetID
- description: NetID (VPC ID) of the target
+ description: The ID of the Net that will accept the Net peering request.
accepterOwnerId:
type: string
title: Accepter Owner ID
- description: Owner ID (Account ID) of the target
+ description: The ID of the account that owns the accepted Net.
type: object
required:
- accepterNetId
@@ -3939,45 +4878,55 @@ components:
type: string
format: date-time
title: Created At
- description: Timestamp when the cluster was created
+ description: The timestamp when the cluster was created.
deleted_at:
- type: string
- format: date-time
- nullable: true
+ anyOf:
+ - type: string
+ format: date-time
+ - type: 'null'
+ title: Deleted At
+ description: The timestamp when the cluster was deleted (if applicable).
updated_at:
- type: string
- format: date-time
- nullable: true
+ anyOf:
+ - type: string
+ format: date-time
+ - type: 'null'
+ title: Updated At
+ description: The timestamp when the cluster was last updated.
status:
- type: string
- nullable: true
+ anyOf:
+ - type: string
+ - type: 'null'
+ title: Status
+ description: The status of the cluster.
available_upgrade:
type: string
title: Available Upgrade
- description: Available Kubernetes version for upgrade if any
+ description: Any available version of Kubernetes for upgrade (if applicable). For more information, see [GetKubernetesVersions](#getkubernetesversions).
default: ''
type: object
required:
- created_at
title: Statuses
+ description: Information about the status of the cluster.
Subregion:
properties:
State:
type: string
title: State
- description: The state of the Subregion
+ description: The state of the Subregion.
RegionName:
type: string
title: Region Name
- description: The name of the Region containing the Subregion
+ description: The name of the Region containing the Subregion.
SubregionName:
type: string
title: Subregion Name
- description: The name of the Subregion
+ description: The name of the Subregion.
LocationCode:
type: string
title: Location Code
- description: The location code (physical zone) of the Subregion
+ description: The location code (physical zone) of the Subregion.
type: object
required:
- State
@@ -3985,98 +4934,106 @@ components:
- SubregionName
- LocationCode
title: Subregion
+ description: Information about the Subregion.
TemplateResponse_ClusterInputTemplate_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
+ description: Information about the context of the response.
Template:
allOf:
- $ref: '#/components/schemas/ClusterInputTemplate'
title: Template
- description: Template resource returned by the API
+ description: The returned template resource.
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[ClusterInputTemplate]
+ description: Information about the default cluster template.
TemplateResponse_NetPeeringAcceptance_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
+ description: Information about the context of the response.
Template:
allOf:
- $ref: '#/components/schemas/NetPeeringAcceptance'
title: Template
- description: Template resource returned by the API
+ description: The returned template resource.
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[NetPeeringAcceptance]
+ description: The default Net peering acceptance template.
TemplateResponse_NetPeeringRequest_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
+ description: Information about the context of the response.
Template:
allOf:
- $ref: '#/components/schemas/NetPeeringRequest'
title: Template
- description: Template resource returned by the API
+ description: The returned template resource.
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[NetPeeringRequest]
+ description: The default Net peering request template.
TemplateResponse_Nodepool_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
+ description: Information about the context of the response.
Template:
allOf:
- $ref: '#/components/schemas/Nodepool'
title: Template
- description: Template resource returned by the API
+ description: The returned template resource.
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[Nodepool]
+ description: Information about the default node pool template.
TemplateResponse_ProjectInput_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
+ description: Information about the context of the response.
Template:
allOf:
- $ref: '#/components/schemas/ProjectInput'
title: Template
- description: Template resource returned by the API
+ description: The returned template resource.
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[ProjectInput]
+ description: Information about the default project template.
UpgradeStrategy:
properties:
maxUnavailable:
type: integer
title: Max Unavailable
- description: Maximum number of nodes that can be unavailable during an
- upgrade
+ description: The maximum number of nodes that can be unavailable during an upgrade.
maxSurge:
type: integer
title: Max Surge
- description: Maximum number of extra nodes that can be created during
- an upgrade
+ description: The maximum number of extra nodes that can be created during an upgrade.
autoUpgradeEnabled:
type: boolean
title: Auto Upgrade Enabled
- description: Flag to enable automatic upgrades for the nodepool
+ description: If true, automatic upgrades for the node pool are enabled.
autoUpgradeMaintenance:
allOf:
- $ref: '#/components/schemas/AutoUpgradeMaintenance'
title: Auto Upgrade Maintenance
- description: Configuration for the automated upgrade maintenance
- window
+ description: The configuration for the automated upgrade maintenance window.
type: object
required:
- maxUnavailable
@@ -4084,6 +5041,7 @@ components:
- autoUpgradeEnabled
- autoUpgradeMaintenance
title: UpgradeStrategy
+ description: Information for the management of node pool upgrades.
ValidationDetail:
properties:
loc:
@@ -4093,36 +5051,40 @@ components:
- type: integer
type: array
title: Loc
+ description: The location of the validation error in the request.
msg:
type: string
title: Msg
+ description: A descriptive message about the error.
type:
type: string
title: Type
+ description: The identifier for the type of validation error.
type: object
required:
- loc
- msg
- type
title: ValidationDetail
+ description: Information about the validation error.
Volume:
properties:
device:
type: string
title: Device
- description: Device name for the volume
+ description: The device name for the volume.
type:
type: string
title: Type
- description: Type of the volume (gp2, io1, standard)
+ description: The type of the volume (`gp2`, `io1`, `standard`).
size:
type: integer
title: Size
- description: Size of the volume
+ description: The size of the volume.
dir:
type: string
title: Directory
- description: Mount point directory path for the volume
+ description: The mount point directory path for the volume.
type: object
required:
- device
@@ -4130,17 +5092,18 @@ components:
- size
- dir
title: Volume
+ description: Information about the volume configuration.
clusters__cluster_schema__RPCResponse:
properties:
request_id:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
data:
allOf:
- $ref: '#/components/schemas/KubeconfigData'
title: Data
- description: Kubeconfig data for the cluster
+ description: The kubeconfig data for the cluster.
type: object
required:
- request_id
@@ -4151,50 +5114,55 @@ components:
RequestId:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
type: object
required:
- RequestId
title: ResponseContext
+ description: Information about the context of the response.
myip__myip_schema__ResponseContext:
properties:
RequestId:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
type: object
required:
- RequestId
title: ResponseContext
+ description: Information about the context of the response.
netpeerings__netpeering_schema__Metadata:
properties:
name:
type: string
title: Name
- description: Unique name identifier for the netpeering
+ description: An ID for the Net peering.
type: object
required:
- name
title: Metadata
+ description: Information about the Net peering's metadata.
nodepools__nodepool_schema__Metadata:
properties:
name:
type: string
title: Name
- description: Unique name identifier for the nodepool
+ description: An ID for the node pool.
type: object
required:
- name
title: Metadata
+ description: Information about the node pool's metadata.
projects__project_schema__QuotasResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/projects__project_schema__ResponseContext'
+ description: Information about the context of the response.
Project:
allOf:
- $ref: '#/components/schemas/projects__project_schema__RPCResponse'
title: Project Quotas
- description: Quota details associated with the project
+ description: The quota details associated with the project.
type: object
required:
- ResponseContext
@@ -4205,12 +5173,12 @@ components:
request_id:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
data:
allOf:
- $ref: '#/components/schemas/QuotasData'
title: Data
- description: Quota information related to the request
+ description: The quota information related to the request.
type: object
required:
- request_id
@@ -4221,17 +5189,20 @@ components:
RequestId:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
type: object
required:
- RequestId
title: Response Context
+ description: Information about the context of the response.
quotas__quota_schema__QuotasResponse:
properties:
ResponseContext:
$ref: '#/components/schemas/quotas__quota_schema__ResponseContext'
+ description: Information about the context of the response.
Quotas:
$ref: '#/components/schemas/OKSQuotas'
+ description: Information about your quotas.
type: object
required:
- ResponseContext
@@ -4242,51 +5213,53 @@ components:
RequestId:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
type: object
required:
- RequestId
title: Response Context
+ description: Information about the context of the response.
templates__template_schema__ResponseContext:
properties:
RequestId:
type: string
title: Request ID
- description: Unique identifier for the API request
+ description: The ID of the API request.
type: object
required:
- RequestId
title: ResponseContext
+ description: Information about the context of the response.
securitySchemes:
BasicAuth:
type: http
scheme: basic
- description: Username and Password for API authentication
+ description: A header in the form `Basic XXXX`, where `XXXX` is the Base64 encoding of the root user's login and password joined by a colon (`:`). Note that with Curl, you can use the `--user LOGIN:PASSWORD` option as a shortcut for this and Curl will format the header for you.
AccessKeyAuth:
type: apiKey
in: header
name: AccessKey
- description: AccessKey for API authentication
+ description: A header with an access key of the root user. You cannot use EIM users' access keys with OKS.
SecretKeyAuth:
type: apiKey
in: header
name: SecretKey
- description: SecretKey for API authentication
+ description: A header with the corresponding secret key of the access key.
AccessTokenAuth:
type: apiKey
in: header
name: AccessToken
- description: Access Token for API authentication
+ description: In the case of JSON Web Token (JWT) authentication, a header with an access token.
RefreshTokenAuth:
type: apiKey
in: header
name: RefreshToken
- description: Refresh Token for API authentication
+ description: In the case of JWT authentication, a header with the corresponding refresh token.
OTPCodeAuth:
type: apiKey
in: header
name: X-OTP-Code
- description: OTP token for API authentication
+ description: (optional) If multi-factor authentication (MFA) is set up on your account, a header with your OTP token.
security:
- BasicAuth: []
OTPCodeAuth: []
@@ -4296,8 +5269,5 @@ security:
- AccessTokenAuth: []
RefreshTokenAuth: []
servers:
-- url: /{api_prefix}
- variables:
- api_prefix:
- default: api/v2
- description: API prefix
+- url: https://api.eu-west-2.oks.outscale.com/api/v2
+- url: https://api.cloudgouv-eu-west-1.oks.outscale.com/api/v2
diff --git a/osc_sdk_python/resources/osc/api.yaml b/osc_sdk_python/resources/osc/api.yaml
index f396e71..c4695c4 100644
--- a/osc_sdk_python/resources/osc/api.yaml
+++ b/osc_sdk_python/resources/osc/api.yaml
@@ -1,12 +1,10 @@
----
components:
schemas:
AcceptNetPeeringRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetPeeringId:
description: The ID of the Net peering you want to accept.
@@ -18,10 +16,10 @@ components:
additionalProperties: false
properties:
NetPeering:
- "$ref": "#/components/schemas/NetPeering"
+ $ref: '#/components/schemas/NetPeering'
description: Information about the Net peering.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
AccepterNet:
@@ -32,8 +30,7 @@ components:
description: The OUTSCALE account ID of the owner of the accepter Net.
type: string
IpRange:
- description: The IP range for the accepter Net, in CIDR notation (for example,
- `10.0.0.0/16`).
+ description: The IP range for the accepter Net, in CIDR notation (for example, `10.0.0.0/16`).
type: string
NetId:
description: The ID of the accepter Net.
@@ -48,19 +45,18 @@ components:
type: string
CreationDate:
description: The date and time (UTC) at which the access key was created.
- format: datetime
+ format: date-time
type: string
ExpirationDate:
description: The date and time (UTC) at which the access key expires.
- format: datetime
+ format: date-time
type: string
LastModificationDate:
description: The date and time (UTC) at which the access key was last modified.
- format: datetime
+ format: date-time
type: string
State:
- description: The state of the access key (`ACTIVE` if the key is valid for
- API calls, or `INACTIVE` if not).
+ description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
type: string
Tag:
description: The tag added to the access key.
@@ -75,22 +71,21 @@ components:
type: string
CreationDate:
description: The date and time (UTC) at which the access key was created.
- format: datetime
+ format: date-time
type: string
ExpirationDate:
description: The date and time (UTC) at which the access key expires.
- format: datetime
+ format: date-time
type: string
LastModificationDate:
description: The date and time (UTC) at which the access key was last modified.
- format: datetime
+ format: date-time
type: string
SecretKey:
description: The secret key that enables you to send requests.
type: string
State:
- description: The state of the access key (`ACTIVE` if the key is valid for
- API calls, or `INACTIVE` if not).
+ description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
type: string
Tag:
description: A tag added to the access key.
@@ -101,21 +96,16 @@ components:
description: Information about access logs.
properties:
IsEnabled:
- description: If true, access logs are enabled for your load balancer. If
- false, they are not. If you set this to true in your request, the `OsuBucketName`
- parameter is required.
+ description: If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the `OsuBucketName` parameter is required.
type: boolean
OsuBucketName:
description: The name of the OOS bucket for the access logs.
type: string
OsuBucketPrefix:
- description: The path to the folder of the access logs in your OOS bucket
- (by default, the `root` level of your bucket).
+ description: The path to the folder of the access logs in your OOS bucket (by default, the `root` level of your bucket).
type: string
PublicationInterval:
- description: The time interval for the publication of access logs in the
- OOS bucket, in minutes. This value can be either `5` or `60` (by default,
- `60`).
+ description: The time interval for the publication of access logs in the OOS bucket, in minutes. This value can be either `5` or `60` (by default, `60`).
type: integer
type: object
Account:
@@ -126,10 +116,9 @@ components:
description: The ID of the account.
type: string
AdditionalEmails:
- description: One or more additional email addresses for the account. These
- addresses are used for notifications only.
+ description: One or more additional email addresses for the account. These addresses are used for notifications only.
items:
- pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$"
+ pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$
type: string
type: array
City:
@@ -145,8 +134,7 @@ components:
description: The ID of the customer.
type: string
Email:
- description: The main email address for the account. This address is used
- for your credentials and for notifications.
+ description: The main email address for the account. This address is used for your credentials and for notifications.
type: string
FirstName:
description: The first name of the account owner.
@@ -161,8 +149,7 @@ components:
description: The mobile phone number of the account owner.
type: string
OutscaleLoginAllowed:
- description: Whether the account is allowed to log in to Cockpit v2 using
- its Outscale credentials when identity federation is activated.
+ description: Whether the account is allowed to log in to Cockpit v2 using its Outscale credentials when identity federation is activated.
type: boolean
PhoneNumber:
description: The landline phone number of the account owner.
@@ -181,30 +168,26 @@ components:
description: The action to perform on the next boot of the VM.
properties:
SecureBoot:
- "$ref": "#/components/schemas/SecureBootAction"
- description: One action to perform on the next boot of the VM. For more
- information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions).
+ $ref: '#/components/schemas/SecureBootAction'
+ description: One action to perform on the next boot of the VM. For more information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions).
type: object
AddUserToUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserGroupName:
description: The name of the group you want to add a user to.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserName:
description: The name of the user you want to add to the group.
type: string
UserPath:
- description: The path to the user. If not specified, it is set to a slash
- (`/`).
+ description: The path to the user. If not specified, it is set to a slash (`/`).
type: string
required:
- UserGroupName
@@ -214,7 +197,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ApiAccessPolicy:
@@ -222,8 +205,7 @@ components:
description: Information about the API access policy.
properties:
MaxAccessKeyExpirationSeconds:
- description: The maximum possible lifetime for your access keys, in seconds.
- If `0`, your access keys can have unlimited lifetimes.
+ description: The maximum possible lifetime for your access keys, in seconds. If `0`, your access keys can have unlimited lifetimes.
format: int64
type: integer
RequireTrustedEnv:
@@ -240,8 +222,7 @@ components:
description: The ID of the API access rule.
type: string
CaIds:
- description: One or more IDs of Client Certificate Authorities (CAs) used
- for the API access rule.
+ description: One or more IDs of Client Certificate Authorities (CAs) used for the API access rule.
items:
type: string
type: array
@@ -254,8 +235,7 @@ components:
description: The description of the API access rule.
type: string
IpRanges:
- description: One or more IP ranges used for the API access rule, in CIDR
- notation (for example, `192.0.2.0/16`).
+ description: One or more IP ranges used for the API access rule, in CIDR notation (for example, `192.0.2.0/16`).
items:
type: string
type: array
@@ -265,12 +245,10 @@ components:
description: Information about the stickiness policy.
properties:
CookieName:
- description: The name of the application cookie used for stickiness, between
- 1 and 255 characters.
+ description: The name of the application cookie used for stickiness, between 1 and 255 characters.
type: string
PolicyName:
- description: The mnemonic name for the policy being created. The name must
- be unique within a set of policies for this load balancer.
+ description: The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
type: string
type: object
BackendVmHealth:
@@ -281,12 +259,11 @@ components:
description: The description of the state of the backend VM.
type: string
State:
- description: The state of the backend VM (`InService` \| `OutOfService`
- \| `Unknown`).
+ description: The state of the backend VM (`UP` \| `DOWN` \| `UNKNOWN`).
type: string
StateReason:
description: |-
- Information about the cause of `OutOfService` VMs.
+ Information about the cause of `DOWN` VMs.
Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`).
type: string
VmId:
@@ -298,7 +275,7 @@ components:
description: Information about the created block device mapping.
properties:
Bsu:
- "$ref": "#/components/schemas/BsuCreated"
+ $ref: '#/components/schemas/BsuCreated'
description: Information about the created BSU volume.
DeviceName:
description: The name of the device.
@@ -306,17 +283,13 @@ components:
type: object
BlockDeviceMappingImage:
additionalProperties: false
- description: One or more parameters used to automatically set up volumes when
- the VM is created.
+ description: One or more parameters used to automatically set up volumes when the VM is created.
properties:
Bsu:
- "$ref": "#/components/schemas/BsuToCreate"
+ $ref: '#/components/schemas/BsuToCreate'
description: Information about the BSU volume to create.
DeviceName:
- description: The device name for the volume. For a root device, you must
- use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
- `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
- `b` and `z`, and the second `X` is a letter between `a` and `z`).
+ description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
@@ -327,17 +300,13 @@ components:
description: Information about the block device mapping.
properties:
Bsu:
- "$ref": "#/components/schemas/BsuToCreate"
+ $ref: '#/components/schemas/BsuToCreate'
description: Information about the BSU volume to create.
DeviceName:
- description: The device name for the volume. For a root device, you must
- use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
- `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
- `b` and `z`, and the second `X` is a letter between `a` and `z`).
+ description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
NoDevice:
- description: Removes the device which is included in the block device mapping
- of the OMI.
+ description: Removes the device which is included in the block device mapping of the OMI.
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
@@ -348,17 +317,13 @@ components:
description: Information about the block device mapping.
properties:
Bsu:
- "$ref": "#/components/schemas/BsuToUpdateVm"
+ $ref: '#/components/schemas/BsuToUpdateVm'
description: Information about the BSU volume.
DeviceName:
- description: The device name for the volume. For a root device, you must
- use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
- `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
- `b` and `z`, and the second `X` is a letter between `a` and `z`).
+ description: The device name for the volume. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
NoDevice:
- description: Removes the device which is included in the block device mapping
- of the OMI.
+ description: Removes the device which is included in the block device mapping of the OMI.
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
@@ -375,13 +340,11 @@ components:
description: Information about the created BSU volume.
properties:
DeleteOnVmDeletion:
- description: If true, the volume is deleted when terminating the VM. If
- false, the volume is not deleted when terminating the VM.
+ description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
type: boolean
LinkDate:
- description: The date and time (UTC) at which the volume was attached to
- the VM, in ISO 8601 date-time format.
- format: date
+ description: The date and time (UTC) at which the volume was attached to the VM, in ISO 8601 date-time format.
+ format: date-time
type: string
State:
description: The state of the volume.
@@ -396,14 +359,10 @@ components:
properties:
DeleteOnVmDeletion:
default: true
- description: If set to true, the volume is deleted when terminating the
- VM. If false, the volume is not deleted when terminating the VM.
+ description: If set to true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
type: boolean
Iops:
- description: The number of I/O operations per second (IOPS). This parameter
- must be specified only if you create an `io1` volume. The maximum number
- of IOPS allowed for `io1` volumes is `13000` with a maximum performance
- ratio of 300 IOPS per gibibyte.
+ description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
type: integer
SnapshotId:
description: The ID of the snapshot used to create the volume.
@@ -425,8 +384,7 @@ components:
description: Information about the BSU volume.
properties:
DeleteOnVmDeletion:
- description: If set to true, the volume is deleted when terminating the
- VM. If set to false, the volume is not deleted when terminating the VM.
+ description: If set to true, the volume is deleted when terminating the VM. If set to false, the volume is not deleted when terminating the VM.
type: boolean
VolumeId:
description: The ID of the volume.
@@ -454,12 +412,12 @@ components:
CategoryDistribution:
description: The allocation of the `Value` among categories.
items:
- "$ref": "#/components/schemas/CO2CategoryDistribution"
+ $ref: '#/components/schemas/CO2CategoryDistribution'
type: array
FactorDistribution:
description: The allocation of the `Value` among factors.
items:
- "$ref": "#/components/schemas/CO2FactorDistribution"
+ $ref: '#/components/schemas/CO2FactorDistribution'
type: array
Month:
description: The month associated with the CO2 emission entry.
@@ -469,9 +427,7 @@ components:
description: The ID of the paying account related to the `AccountId` parameter.
type: string
Value:
- description: The total CO2 emissions for the `Month` and `AccountId` specified.
- This value corresponds to the sum of all entries in `CategoryDistribution`
- and `FactorDistributionEntry`.
+ description: The total CO2 emissions for the `Month` and `AccountId` specified. This value corresponds to the sum of all entries in `CategoryDistribution` and `FactorDistributionEntry`.
format: double
type: number
type: object
@@ -508,7 +464,7 @@ components:
Entries:
description: One or more catalog entries.
items:
- "$ref": "#/components/schemas/CatalogEntry"
+ $ref: '#/components/schemas/CatalogEntry'
type: array
type: object
CatalogEntry:
@@ -519,16 +475,13 @@ components:
description: The category of the catalog entry (for example, `network`).
type: string
Flags:
- description: When returned and equal to `PER_MONTH`, the price of the catalog
- entry is calculated on a monthly basis.
+ description: When returned and equal to `PER_MONTH`, the price of the catalog entry is calculated on a monthly basis.
type: string
Operation:
- description: The API call associated with the catalog entry (for example,
- `CreateVms` or `RunInstances`).
+ description: The API call associated with the catalog entry (for example, `CreateVms` or `RunInstances`).
type: string
Service:
- description: The service associated with the catalog entry (`TinaOS-FCU`,
- `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`).
+ description: The service associated with the catalog entry (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`).
type: string
SubregionName:
description: The Subregion associated with the catalog entry.
@@ -540,8 +493,7 @@ components:
description: The type of resource associated with the catalog entry.
type: string
UnitPrice:
- description: The unit price of the catalog entry in the currency of your
- account, in the ISO-4217 format (for example, `EUR`).
+ description: The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, `EUR`).
format: float
type: number
type: object
@@ -552,7 +504,7 @@ components:
Entries:
description: One or more catalog entries.
items:
- "$ref": "#/components/schemas/CatalogEntry"
+ $ref: '#/components/schemas/CatalogEntry'
type: array
FromDate:
description: The beginning of the time period (UTC).
@@ -573,8 +525,7 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Login:
description: The email address of the account.
@@ -590,7 +541,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ClientGateway:
@@ -598,34 +549,29 @@ components:
description: Information about the client gateway.
properties:
BgpAsn:
- description: The Autonomous System Number (ASN) used by the Border Gateway
- Protocol (BGP) to find the path to your client gateway through the Internet.
+ description: The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
type: integer
ClientGatewayId:
description: The ID of the client gateway.
type: string
ConnectionType:
- description: The type of communication tunnel used by the client gateway
- (always `ipsec.1`).
+ description: The type of communication tunnel used by the client gateway (always `ipsec.1`).
type: string
PublicIp:
- description: The public IPv4 address of the client gateway (must be a fixed
- address into a NATed network).
+ description: The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
type: string
State:
- description: The state of the client gateway (`pending` \| `available` \|
- `deleting` \| `deleted`).
+ description: The state of the client gateway (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
Tags:
description: One or more tags associated with the client gateway.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
ConsumptionEntry:
additionalProperties: false
- description: Information about the resources consumed during the specified time
- period.
+ description: Information about the resources consumed during the specified time period.
properties:
AccountId:
description: The ID of your OUTSCALE account.
@@ -635,27 +581,23 @@ components:
type: string
FromDate:
description: The beginning of the time period (UTC).
- format: datetime
+ format: date-time
type: string
Operation:
- description: The API call that triggered the resource consumption (for example,
- `RunInstances` or `CreateVolume`).
+ description: The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`).
type: string
PayingAccountId:
- description: The ID of the OUTSCALE account which is billed for your consumption.
- It can be different from your account in the `AccountId` parameter.
+ description: The ID of the OUTSCALE account which is billed for your consumption. It can be different from your account in the `AccountId` parameter.
type: string
Price:
- description: The total price of the consumed resource during the specified
- time period, in the currency of the Region's catalog.
+ description: The total price of the consumed resource during the specified time period, in the currency of the Region's catalog.
format: double
type: number
ResourceId:
description: The ID of the consumed resource.
type: string
Service:
- description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`,
- `TinaOS-OOS`, `TinaOS-OSU`, or `OKS`).
+ description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`, `TinaOS-OOS`, `TinaOS-OSU`, or `OKS`).
type: string
SubregionName:
description: The name of the Subregion.
@@ -665,19 +607,17 @@ components:
type: string
ToDate:
description: The end of the time period (UTC).
- format: datetime
+ format: date-time
type: string
Type:
description: The type of resource, depending on the API call.
type: string
UnitPrice:
- description: The unit price of the consumed resource in the currency of
- your account, in the ISO-4217 format (for example, `EUR`).
+ description: The unit price of the consumed resource in the currency of your account, in the ISO-4217 format (for example, `EUR`).
format: double
type: number
Value:
- description: The consumed amount for the resource. The unit depends on the
- resource type. For more information, see the `Title` element.
+ description: The consumed amount for the resource. The unit depends on the resource type. For more information, see the `Title` element.
format: double
type: number
type: object
@@ -685,44 +625,39 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ExpirationDate:
- description: The date and time, or the date, at which you want the access
- key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`,
- or `2020-06-14`). If not specified, the access key is set to not expire.
- format: datetime
- type: string
+ description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, or `2020-06-14`). If not specified, the access key is set to not expire.
+ oneOf:
+ - format: date-time
+ type: string
+ - format: date
+ type: string
Tag:
description: A tag to add to the access key.
type: string
UserName:
- description: The name of the EIM user that owns the key to be created. If
- you do not specify a user name, this action creates an access key for
- the user who sends the request (which can be the root user).
+ description: The name of the EIM user that owns the key to be created. If you do not specify a user name, this action creates an access key for the user who sends the request (which can be the root user).
type: string
type: object
CreateAccessKeyResponse:
additionalProperties: false
properties:
AccessKey:
- "$ref": "#/components/schemas/AccessKeySecretKey"
+ $ref: '#/components/schemas/AccessKeySecretKey'
description: Information about the access key.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateAccountRequest:
additionalProperties: false
properties:
AdditionalEmails:
- description: One or more additional email addresses for the account. These
- addresses are used for notifications only. If you already have a list
- of additional emails registered, you cannot add to it, only replace it.
- To remove all registered additional emails, specify an empty list.
+ description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list.
items:
- pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$"
+ pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$
type: string
type: array
City:
@@ -735,15 +670,13 @@ components:
description: The country of the account owner.
type: string
CustomerId:
- description: The ID of the customer. It must be 8 digits.
+ description: 'The ID of the customer. It must be 8 digits. With OSC CLI, you must wrap this value in two pairs of quotes to make sure it is parsed as a string: `--CustomerId ''"12345678"''`.'
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Email:
- description: The main email address for the account. This address is used
- for your credentials and notifications.
+ description: The main email address for the account. This address is used for your credentials and notifications.
type: string
FirstName:
description: The first name of the account owner.
@@ -767,7 +700,7 @@ components:
description: The value added tax (VAT) number for the account.
type: string
ZipCode:
- description: The ZIP code of the city.
+ description: 'The ZIP code of the city. With OSC CLI, you must wrap this value in two pairs of quotes to make sure it is parsed as a string: `--ZipCode ''"12345678"''`.'
type: string
required:
- City
@@ -783,10 +716,10 @@ components:
additionalProperties: false
properties:
Account:
- "$ref": "#/components/schemas/Account"
+ $ref: '#/components/schemas/Account'
description: Information about the account.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateApiAccessRuleRequest:
@@ -798,8 +731,7 @@ components:
type: string
type: array
Cns:
- description: One or more Client Certificate Common Names (CNs). If this
- parameter is specified, you must also specify the `CaIds` parameter.
+ description: One or more Client Certificate Common Names (CNs). If this parameter is specified, you must also specify the `CaIds` parameter.
items:
type: string
type: array
@@ -807,8 +739,7 @@ components:
description: A description for the API access rule.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
IpRanges:
description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
@@ -820,26 +751,23 @@ components:
additionalProperties: false
properties:
ApiAccessRule:
- "$ref": "#/components/schemas/ApiAccessRule"
+ $ref: '#/components/schemas/ApiAccessRule'
description: Information about the API access rule.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateCaRequest:
additionalProperties: false
properties:
CaPem:
- description: 'The CA in PEM format. With OSC CLI, use the following
- syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat
- FILENAME)"`.'
+ description: 'The CA in PEM format. With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat FILENAME)"`.'
type: string
Description:
description: The description of the CA.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- CaPem
@@ -848,10 +776,10 @@ components:
additionalProperties: false
properties:
Ca:
- "$ref": "#/components/schemas/Ca"
+ $ref: '#/components/schemas/Ca'
description: Information about the Client Certificate Authority (CA).
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateClientGatewayRequest:
@@ -864,12 +792,10 @@ components:
If you do not have an ASN, you can choose one between `64512` and `65534` (both included), or between `4200000000` and `4294967295` (both included).
type: integer
ConnectionType:
- description: The communication protocol used to establish tunnel with your
- client gateway (always `ipsec.1`).
+ description: The communication protocol used to establish tunnel with your client gateway (always `ipsec.1`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PublicIp:
description: The public fixed IPv4 address of your client gateway.
@@ -883,22 +809,20 @@ components:
additionalProperties: false
properties:
ClientGateway:
- "$ref": "#/components/schemas/ClientGateway"
+ $ref: '#/components/schemas/ClientGateway'
description: Information about the client gateway.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateDedicatedGroupRequest:
additionalProperties: false
properties:
CpuGeneration:
- description: The processor generation for the VMs in the dedicated group
- (for example, `4`).
+ description: The processor generation for the VMs in the dedicated group (for example, `4`).
type: integer
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Name:
description: A name for the dedicated group.
@@ -915,44 +839,33 @@ components:
additionalProperties: false
properties:
DedicatedGroup:
- "$ref": "#/components/schemas/DedicatedGroup"
+ $ref: '#/components/schemas/DedicatedGroup'
description: Information about the dedicated group.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateDhcpOptionsRequest:
additionalProperties: false
properties:
DomainName:
- description: 'Specify a domain name (for example, `MyCompany.com`). You
- can specify only one domain name. You must specify at least one of the
- following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
- or `NtpServers`.'
+ description: 'Specify a domain name (for example, `MyCompany.com`). You can specify only one domain name. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.'
type: string
DomainNameServers:
- description: 'The IPs of domain name servers. If no IPs are specified, the
- `OutscaleProvidedDNS` value is set by default. You must specify at least
- one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
- or `NtpServers`.'
+ description: 'The IPs of domain name servers. If no IPs are specified, the `OutscaleProvidedDNS` value is set by default. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.'
items:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LogServers:
- description: 'The IPs of the log servers. You must specify at least one
- of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
- or `NtpServers`.'
+ description: 'The IPs of the log servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.'
items:
type: string
type: array
NtpServers:
- description: 'The IPs of the Network Time Protocol (NTP) servers. You must
- specify at least one of the following parameters: `DomainName`, `DomainNameServers`,
- `LogServers`, or `NtpServers`.'
+ description: 'The IPs of the Network Time Protocol (NTP) servers. You must specify at least one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`, or `NtpServers`.'
items:
type: string
type: array
@@ -961,25 +874,23 @@ components:
additionalProperties: false
properties:
DhcpOptionsSet:
- "$ref": "#/components/schemas/DhcpOptionsSet"
+ $ref: '#/components/schemas/DhcpOptionsSet'
description: Information about the DHCP options set.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateDirectLinkInterfaceRequest:
additionalProperties: false
properties:
DirectLinkId:
- description: The ID of the existing DirectLink for which you want to create
- the DirectLink interface.
+ description: The ID of the existing DirectLink for which you want to create the DirectLink interface.
type: string
DirectLinkInterface:
- "$ref": "#/components/schemas/DirectLinkInterface"
+ $ref: '#/components/schemas/DirectLinkInterface'
description: Information about the DirectLink interface.
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- DirectLinkId
@@ -989,10 +900,10 @@ components:
additionalProperties: false
properties:
DirectLinkInterface:
- "$ref": "#/components/schemas/DirectLinkInterfaces"
+ $ref: '#/components/schemas/DirectLinkInterfaces'
description: Information about the DirectLink interfaces.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateDirectLinkRequest:
@@ -1005,12 +916,10 @@ components:
description: The name of the DirectLink.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Location:
- description: The code of the requested location for the DirectLink, returned
- by the [ReadLocations](#readlocations) method.
+ description: The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method.
type: string
required:
- Bandwidth
@@ -1021,10 +930,10 @@ components:
additionalProperties: false
properties:
DirectLink:
- "$ref": "#/components/schemas/DirectLink"
+ $ref: '#/components/schemas/DirectLink'
description: Information about the DirectLink.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateFlexibleGpuRequest:
@@ -1035,18 +944,13 @@ components:
description: If true, the fGPU is deleted when the VM is terminated.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Generation:
- description: The processor generation that the fGPU must be compatible with.
- If not specified, the oldest possible processor generation is selected
- (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for
- the specified model of fGPU).
+ description: The processor generation that the fGPU must be compatible with. If not specified, the oldest possible processor generation is selected (as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for the specified model of fGPU).
type: string
ModelName:
- description: The model of fGPU you want to allocate. For more information,
- see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
+ description: The model of fGPU you want to allocate. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
type: string
SubregionName:
description: The Subregion in which you want to create the fGPU.
@@ -1059,24 +963,23 @@ components:
additionalProperties: false
properties:
FlexibleGpu:
- "$ref": "#/components/schemas/FlexibleGpu"
+ $ref: '#/components/schemas/FlexibleGpu'
description: Information about the flexible GPU (fGPU).
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateImageExportTaskRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ImageId:
description: The ID of the OMI to export.
type: string
OsuExport:
- "$ref": "#/components/schemas/OsuExportToCreate"
+ $ref: '#/components/schemas/OsuExportToCreate'
description: Information about the OOS export task to create.
required:
- OsuExport
@@ -1086,41 +989,36 @@ components:
additionalProperties: false
properties:
ImageExportTask:
- "$ref": "#/components/schemas/ImageExportTask"
+ $ref: '#/components/schemas/ImageExportTask'
description: Information about the OMI export task.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateImageRequest:
additionalProperties: false
properties:
Architecture:
- description: "**(when registering from a snapshot)** The architecture of
- the OMI (`i386` or `x86_64`). By default, set to `x86_64`."
+ description: '**(when registering from a snapshot)** The architecture of the OMI (`i386` or `x86_64`). By default, set to `x86_64`.'
type: string
BlockDeviceMappings:
- description: "**(required when registering from a snapshot)** One or more
- block device mappings."
+ description: '**(required when registering from a snapshot)** One or more block device mappings.'
items:
- "$ref": "#/components/schemas/BlockDeviceMappingImage"
+ $ref: '#/components/schemas/BlockDeviceMappingImage'
type: array
BootModes:
description: The boot modes compatible with the OMI.
items:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
type: array
Description:
description: A description for the new OMI.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FileLocation:
- description: "**(required when registering from a bucket by using a manifest
- file)** The pre-signed URL of the manifest file for the OMI you want to
- register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html)."
+ description: '**(required when registering from a bucket by using a manifest file)** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).'
type: string
ImageName:
description: |-
@@ -1128,8 +1026,7 @@ components:
Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`).
type: string
NoReboot:
- description: "**(when creating from a VM)** If false, the VM shuts down
- before creating the OMI and then reboots. If true, the VM does not."
+ description: '**(when creating from a VM)** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not.'
type: boolean
ProductCodes:
description: The product codes associated with the OMI.
@@ -1137,69 +1034,59 @@ components:
type: string
type: array
RootDeviceName:
- description: "**(required when registering from a snapshot)** The name of
- the root device for the new OMI."
+ description: '**(required when registering from a snapshot)** The name of the root device for the new OMI.'
type: string
SourceImageId:
- description: "**(required when copying an OMI)** The ID of the OMI you want
- to copy."
+ description: '**(required when copying an OMI)** The ID of the OMI you want to copy.'
type: string
SourceRegionName:
- description: "**(required when copying an OMI)** The name of the source
- Region (always the same as the Region of your account)."
+ description: '**(required when copying an OMI)** The name of the source Region (always the same as the Region of your account).'
type: string
TpmMandatory:
- description: By default or if set to false, a virtual Trusted Platform Module
- (vTPM) is not mandatory on VMs created from this OMI. If true, VMs created
- from this OMI must have a vTPM enabled.
+ description: By default or if set to false, a virtual Trusted Platform Module (vTPM) is not mandatory on VMs created from this OMI. If true, VMs created from this OMI must have a vTPM enabled.
type: boolean
VmId:
- description: "**(required when creating from a VM)** The ID of the VM from
- which you want to create the OMI."
+ description: '**(required when creating from a VM)** The ID of the VM from which you want to create the OMI.'
type: string
type: object
CreateImageResponse:
additionalProperties: false
properties:
Image:
- "$ref": "#/components/schemas/Image"
+ $ref: '#/components/schemas/Image'
description: Information about the OMI.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateInternetServiceRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
CreateInternetServiceResponse:
additionalProperties: false
properties:
InternetService:
- "$ref": "#/components/schemas/InternetService"
+ $ref: '#/components/schemas/InternetService'
description: Information about the internet service.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateKeypairRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
KeypairName:
- description: A unique name for the keypair, with a maximum length of 255
- [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters).
+ description: A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters).
type: string
PublicKey:
- description: The public key to import in your account, if you are importing
- an existing keypair. This value must be Base64-encoded.
+ description: The public key to import in your account, if you are importing an existing keypair. This value must be Base64-encoded.
type: string
required:
- KeypairName
@@ -1208,24 +1095,23 @@ components:
additionalProperties: false
properties:
Keypair:
- "$ref": "#/components/schemas/KeypairCreated"
+ $ref: '#/components/schemas/KeypairCreated'
description: Information about the created keypair.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateListenerRuleRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Listener:
- "$ref": "#/components/schemas/LoadBalancerLight"
+ $ref: '#/components/schemas/LoadBalancerLight'
description: Information about the load balancer.
ListenerRule:
- "$ref": "#/components/schemas/ListenerRuleForCreation"
+ $ref: '#/components/schemas/ListenerRuleForCreation'
description: Information about the listener rule.
VmIds:
description: The IDs of the backend VMs.
@@ -1241,27 +1127,25 @@ components:
additionalProperties: false
properties:
ListenerRule:
- "$ref": "#/components/schemas/ListenerRule"
+ $ref: '#/components/schemas/ListenerRule'
description: Information about the listener rule.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateLoadBalancerListenersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Listeners:
description: One or more listeners for the load balancer.
items:
- "$ref": "#/components/schemas/ListenerForCreation"
+ $ref: '#/components/schemas/ListenerForCreation'
type: array
LoadBalancerName:
- description: The name of the load balancer for which you want to create
- listeners.
+ description: The name of the load balancer for which you want to create listeners.
type: string
required:
- Listeners
@@ -1271,41 +1155,33 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateLoadBalancerPolicyRequest:
additionalProperties: false
properties:
CookieExpirationPeriod:
- description: The lifetime of the cookie, in seconds. If not specified, the
- default value of this parameter is `1`, which means that the sticky session
- lasts for the duration of the browser session.
+ description: The lifetime of the cookie, in seconds. If not specified, the default value of this parameter is `1`, which means that the sticky session lasts for the duration of the browser session.
type: integer
CookieName:
- description: The name of the application cookie used for stickiness, between
- 1 and 255 characters. This parameter is required if you create a stickiness
- policy based on an application-generated cookie.
+ description: The name of the application cookie used for stickiness, between 1 and 255 characters. This parameter is required if you create a stickiness policy based on an application-generated cookie.
maxLength: 255
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
- description: The name of the load balancer for which you want to create
- a policy.
+ description: The name of the load balancer for which you want to create a policy.
type: string
PolicyName:
- description: The unique name of the policy, with a maximum length of 32
- alphanumeric characters and dashes (`-`).
+ description: The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (`-`).
type: string
PolicyType:
- description: 'The type of stickiness policy you want to create: `app` or
- `load_balancer`.'
+ description: 'The type of stickiness policy you want to create: `app` or `load_balancer`.'
type: string
required:
- PolicyType
@@ -1316,64 +1192,51 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateLoadBalancerRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Listeners:
description: One or more listeners to create.
items:
- "$ref": "#/components/schemas/ListenerForCreation"
+ $ref: '#/components/schemas/ListenerForCreation'
type: array
LoadBalancerName:
- description: The unique name of the load balancer, with a maximum length
- of 32 alphanumeric characters and dashes (`-`). This name must not start
- or end with a dash.
+ description: The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (`-`). This name must not start or end with a dash.
type: string
LoadBalancerType:
- description: 'The type of load balancer: `internet-facing` or `internal`.
- Use this parameter only for load balancers in a Net.'
+ description: 'The type of load balancer: `internet-facing` or `internal`. Use this parameter only for load balancers in a Net.'
type: string
PublicIp:
- description: "(internet-facing only) The public IP you want to associate
- with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE
- is associated."
+ description: (internet-facing only) The public IP you want to associate with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE is associated.
type: string
SecurityGroups:
- description: "(Net only) One or more IDs of security groups you want to
- assign to the load balancer. If not specified, the default security group
- of the Net is assigned to the load balancer."
+ description: (Net only) One or more IDs of security groups you want to assign to the load balancer. If not specified, the default security group of the Net is assigned to the load balancer.
items:
type: string
type: array
Subnets:
- description: "(Net only) The ID of the Subnet in which you want to create
- the load balancer. Regardless of this Subnet, the load balancer can distribute
- traffic to all Subnets. This parameter is required in a Net."
+ description: (Net only) The ID of the Subnet in which you want to create the load balancer. Regardless of this Subnet, the load balancer can distribute traffic to all Subnets. This parameter is required in a Net.
items:
type: string
type: array
SubregionNames:
- description: "(public Cloud only) The Subregion in which you want to create
- the load balancer. Regardless of this Subregion, the load balancer can
- distribute traffic to all Subregions. This parameter is required in the
- public Cloud."
+ description: (public Cloud only) The Subregion in which you want to create the load balancer. Regardless of this Subregion, the load balancer can distribute traffic to all Subregions. This parameter is required in the public Cloud.
items:
type: string
type: array
Tags:
description: One or more tags assigned to the load balancer.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
required:
- Listeners
@@ -1383,18 +1246,17 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateLoadBalancerTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerNames:
description: One or more load balancer names.
@@ -1404,7 +1266,7 @@ components:
Tags:
description: One or more tags to add to the specified load balancers.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
required:
- LoadBalancerNames
@@ -1414,18 +1276,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateNatServiceRequest:
additionalProperties: false
properties:
ClientToken:
- description: A unique identifier which enables you to manage the idempotency.
+ description: 'A unique identifier which enables you to manage the idempotency. With OSC CLI, if you want to specify a number for this value, you must wrap it in two pairs of quotes to make sure the value is parsed as a string: `--ClientToken ''"12345678"''`.'
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PublicIpId:
description: |-
@@ -1443,18 +1304,17 @@ components:
additionalProperties: false
properties:
NatService:
- "$ref": "#/components/schemas/NatService"
+ $ref: '#/components/schemas/NatService'
description: Information about the NAT service.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateNetAccessPointRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net.
@@ -1475,10 +1335,10 @@ components:
additionalProperties: false
properties:
NetAccessPoint:
- "$ref": "#/components/schemas/NetAccessPoint"
+ $ref: '#/components/schemas/NetAccessPoint'
description: Information about the Net access point.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateNetPeeringRequest:
@@ -1486,17 +1346,16 @@ components:
properties:
AccepterNetId:
description: |-
- The ID of the Net you want to connect with.
+ The ID of the Net you want to connect with.
If the Net does not belong to you, you must also specify the `AccepterOwnerId` parameter with the OUTSCALE account ID owning the Net you want to connect with.
type: string
AccepterOwnerId:
description: |-
- The OUTSCALE account ID of the owner of the Net you want to connect with. By default, the account ID of the owner of the Net from which the peering request is sent.
- This parameter is required if the Net you want to connect with does not belong to you.
+ The OUTSCALE account ID of the owner of the Net you want to connect with. By default, the account ID of the owner of the Net from which the peering request is sent.
+ This parameter is required if the Net you want to connect with does not belong to you. With OSC CLI, you must wrap the value in two pairs of quotes to make sure it is parsed as a string: `--AccepterOwnerId '"12345678"'`.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
SourceNetId:
description: The ID of the Net you send the peering request from.
@@ -1509,18 +1368,17 @@ components:
additionalProperties: false
properties:
NetPeering:
- "$ref": "#/components/schemas/NetPeering"
+ $ref: '#/components/schemas/NetPeering'
description: Information about the Net peering.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateNetRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
IpRange:
description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`).
@@ -1539,10 +1397,10 @@ components:
additionalProperties: false
properties:
Net:
- "$ref": "#/components/schemas/Net"
+ $ref: '#/components/schemas/Net'
description: Information about the Net.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateNicRequest:
@@ -1552,15 +1410,12 @@ components:
description: A description for the NIC.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PrivateIps:
- description: Information about the private IP or IPs of the NIC. If you
- do not specify a primary private IP, one is still created, with an IP
- randomly selected within the IP range of the Subnet.
+ description: Information about the private IP or IPs of the NIC. If you do not specify a primary private IP, one is still created, with an IP randomly selected within the IP range of the Subnet.
items:
- "$ref": "#/components/schemas/PrivateIpLight"
+ $ref: '#/components/schemas/PrivateIpLight'
type: array
SecurityGroupIds:
description: One or more IDs of security groups for the NIC.
@@ -1577,10 +1432,10 @@ components:
additionalProperties: false
properties:
Nic:
- "$ref": "#/components/schemas/Nic"
+ $ref: '#/components/schemas/Nic'
description: Information about the NIC.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreatePolicyRequest:
@@ -1590,14 +1445,10 @@ components:
description: A description for the policy.
type: string
Document:
- description: The policy document, corresponding to a JSON string that contains
- the policy. This policy document can contain a maximum of 5120 non-whitespace
- characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Path:
description: The path of the policy.
@@ -1613,29 +1464,24 @@ components:
additionalProperties: false
properties:
Policy:
- "$ref": "#/components/schemas/Policy"
+ $ref: '#/components/schemas/Policy'
description: Information about the policy.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreatePolicyVersionRequest:
additionalProperties: false
properties:
Document:
- description: The policy document, corresponding to a JSON string that contains
- the policy. This policy document can contain a maximum of 5120 non-whitespace
- characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. This policy document can contain a maximum of 5120 non-whitespace characters. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
SetAsDefault:
- description: If set to true, the new policy version is set as the default
- version and becomes the operative one.
+ description: If set to true, the new policy version is set as the default version and becomes the operative one.
type: boolean
required:
- Document
@@ -1645,10 +1491,10 @@ components:
additionalProperties: false
properties:
PolicyVersion:
- "$ref": "#/components/schemas/PolicyVersion"
+ $ref: '#/components/schemas/PolicyVersion'
description: Information about the policy version.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateProductTypeRequest:
@@ -1658,8 +1504,7 @@ components:
description: The description of the product type.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Vendor:
description: The vendor of the product type.
@@ -1671,44 +1516,40 @@ components:
additionalProperties: false
properties:
ProductType:
- "$ref": "#/components/schemas/ProductType"
+ $ref: '#/components/schemas/ProductType'
description: Information about the product type.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreatePublicIpRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
CreatePublicIpResponse:
additionalProperties: false
properties:
PublicIp:
- "$ref": "#/components/schemas/PublicIp"
+ $ref: '#/components/schemas/PublicIp'
description: Information about the public IP.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateRouteRequest:
additionalProperties: false
properties:
DestinationIpRange:
- description: The IP range used for the destination match, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
GatewayId:
- description: The ID of an internet service or virtual gateway attached to
- your Net.
+ description: The ID of an internet service or virtual gateway attached to your Net.
type: string
NatServiceId:
description: The ID of a NAT service.
@@ -1733,18 +1574,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTable:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
description: Information about the route table.
type: object
CreateRouteTableRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net for which you want to create a route table.
@@ -1756,10 +1596,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTable:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
description: Information about the route table.
type: object
CreateSecurityGroupRequest:
@@ -1771,8 +1611,7 @@ components:
This description can contain between 1 and 255 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, accented letters, spaces, and `_.-:/()#,@[]+=&;{}!$*`.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net for the security group.
@@ -1791,64 +1630,46 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SecurityGroup:
- "$ref": "#/components/schemas/SecurityGroup"
+ $ref: '#/components/schemas/SecurityGroup'
description: Information about the security group.
type: object
CreateSecurityGroupRuleRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Flow:
- description: 'The direction of the flow: `Inbound` or `Outbound`. You can
- specify `Outbound` for Nets only.'
+ description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.'
type: string
FromPortRange:
- description: The beginning of the port range for the TCP and UDP protocols,
- or an ICMP type number. If you specify this parameter, you cannot specify
- the `Rules` parameter and its subparameters.
+ description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters.
type: integer
IpProtocol:
- description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all
- protocols). By default, `-1`. In a Net, this can also be an IP protocol
- number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
- If you specify this parameter, you cannot specify the `Rules` parameter
- and its subparameters.
+ description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters.
type: string
IpRange:
- description: The IP range for the security group rule, in CIDR notation
- (for example, `10.0.0.0/16`). If you specify this parameter, you cannot
- specify the `Rules` parameter and its subparameters.
+ description: The IP range for the security group rule, in CIDR notation (for example, `10.0.0.0/16`). If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters.
type: string
Rules:
- description: 'Information about the security group rule to create. If you
- specify this parent parameter and its subparameters, you cannot specify
- the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`,
- and `ToPortRange`.'
+ description: 'Information about the security group rule to create. If you specify this parent parameter and its subparameters, you cannot specify the following parent parameters: `FromPortRange`, `IpProtocol`, `IpRange`, and `ToPortRange`.'
items:
- "$ref": "#/components/schemas/SecurityGroupRule"
+ $ref: '#/components/schemas/SecurityGroupRule'
type: array
SecurityGroupAccountIdToLink:
- description: The OUTSCALE account ID that owns the source or destination
- security group specified in the `SecurityGroupNameToLink` parameter.
+ description: 'The OUTSCALE account ID that owns the source or destination security group specified in the `SecurityGroupNameToLink` parameter. With OSC CLI, you must wrap the value in two pairs of quotes to make sure it is parsed as a string: `--SecurityGroupAccountIdToLink ''"12345678"''`.'
type: string
SecurityGroupId:
- description: The ID of the security group for which you want to create a
- rule.
+ description: The ID of the security group for which you want to create a rule.
type: string
SecurityGroupNameToLink:
- description: The ID of a source or destination security group that you want
- to link to the security group of the rule.
+ description: The ID of a source or destination security group that you want to link to the security group of the rule.
type: string
ToPortRange:
- description: The end of the port range for the TCP and UDP protocols, or
- an ICMP code number. If you specify this parameter, you cannot specify
- the `Rules` parameter and its subparameters.
+ description: The end of the port range for the TCP and UDP protocols, or an ICMP code number. If you specify this parameter, you cannot specify the `Rules` parameter and its subparameters.
type: integer
required:
- SecurityGroupId
@@ -1858,42 +1679,32 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SecurityGroup:
- "$ref": "#/components/schemas/SecurityGroup"
+ $ref: '#/components/schemas/SecurityGroup'
description: Information about the security group.
type: object
CreateServerCertificateRequest:
additionalProperties: false
properties:
Body:
- description: 'The PEM-encoded X509 certificate. With OSC CLI, use the
- following syntax to make sure your certificate file is correctly parsed:
- `--Body="$(cat FILENAME)"`.'
+ description: 'The PEM-encoded X509 certificate. With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: `--Body="$(cat FILENAME)"`.'
type: string
Chain:
- description: 'The PEM-encoded intermediate certification authorities. With OSC CLI, use the following syntax to make sure your certificate
- chain file is correctly parsed: `--Chain="$(cat FILENAME)"`.'
+ description: 'The PEM-encoded intermediate certification authorities. With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: `--Chain="$(cat FILENAME)"`.'
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Name:
- description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric
- characters, pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at
- signs (`@`), minuses (`-`), or underscores (`_`).'
+ description: 'A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at signs (`@`), minuses (`-`), or underscores (`_`).'
type: string
Path:
- description: The path to the server certificate, set to a slash (`/`) if
- not specified.
+ description: The path to the server certificate, set to a slash (`/`) if not specified.
type: string
PrivateKey:
- description: 'The PEM-encoded private key matching the certificate. With
- OSC CLI, use the following syntax to make sure your key file is correctly
- parsed: `--PrivateKey="$(cat FILENAME)"`.'
+ description: 'The PEM-encoded private key matching the certificate. With OSC CLI, use the following syntax to make sure your key file is correctly parsed: `--PrivateKey="$(cat FILENAME)"`.'
type: string
required:
- Body
@@ -1904,21 +1715,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
ServerCertificate:
- "$ref": "#/components/schemas/ServerCertificate"
+ $ref: '#/components/schemas/ServerCertificate'
description: Information about the server certificate.
type: object
CreateSnapshotExportTaskRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
OsuExport:
- "$ref": "#/components/schemas/OsuExportToCreate"
+ $ref: '#/components/schemas/OsuExportToCreate'
description: Information about the OOS export task to create.
SnapshotId:
description: The ID of the snapshot to export.
@@ -1931,65 +1741,56 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SnapshotExportTask:
- "$ref": "#/components/schemas/SnapshotExportTask"
+ $ref: '#/components/schemas/SnapshotExportTask'
description: Information about the snapshot export task.
type: object
CreateSnapshotRequest:
additionalProperties: false
properties:
ClientToken:
- description: A unique identifier which enables you to manage the idempotency.
+ description: 'A unique identifier which enables you to manage the idempotency. With OSC CLI, if you want to specify a number for this value, you must wrap it in two pairs of quotes to make sure the value is parsed as a string: `--ClientToken ''"12345678"''`.'
type: string
Description:
description: A description for the snapshot.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FileLocation:
- description: "**(when importing from a bucket)** The pre-signed URL of the
- snapshot you want to import. For more information, see [Creating a Pre-signed
- URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html)."
+ description: '**(when importing from a bucket)** The pre-signed URL of the snapshot you want to import. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).'
type: string
SnapshotSize:
- description: "**(when importing from a bucket)** The size of the snapshot
- you want to create in your account, in bytes. This size must be greater
- than or equal to the size of the original, uncompressed snapshot."
+ description: '**(when importing from a bucket)** The size of the snapshot you want to create in your account, in bytes. This size must be greater than or equal to the size of the original, uncompressed snapshot.'
format: int64
type: integer
SourceRegionName:
- description: "**(when copying a snapshot)** The name of the source Region,
- which must be the same as the Region of your account."
+ description: '**(when copying a snapshot)** The name of the source Region, which must be the same as the Region of your account.'
type: string
SourceSnapshotId:
- description: "**(when copying a snapshot)** The ID of the snapshot you want
- to copy."
+ description: '**(when copying a snapshot)** The ID of the snapshot you want to copy.'
type: string
VolumeId:
- description: "**(when creating from a volume)** The ID of the volume you
- want to create a snapshot of."
+ description: '**(when creating from a volume)** The ID of the volume you want to create a snapshot of.'
type: string
type: object
CreateSnapshotResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Snapshot:
- "$ref": "#/components/schemas/Snapshot"
+ $ref: '#/components/schemas/Snapshot'
description: Information about the snapshot.
type: object
CreateSubnetRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
IpRange:
description: |-
@@ -2010,18 +1811,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Subnet:
- "$ref": "#/components/schemas/Subnet"
+ $ref: '#/components/schemas/Subnet'
description: Information about the Subnet.
type: object
CreateTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ResourceIds:
description: One or more resource IDs.
@@ -2031,7 +1831,7 @@ components:
Tags:
description: One or more tags to add to the specified resources.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
required:
- ResourceIds
@@ -2041,19 +1841,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
CreateUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Path:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserGroupName:
description: The name of the group.
@@ -2065,32 +1863,26 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserGroup:
- "$ref": "#/components/schemas/UserGroup"
+ $ref: '#/components/schemas/UserGroup'
description: Information about the user group.
type: object
CreateUserRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Path:
- description: The path to the EIM user you want to create (by default, `/`).
- This path name must begin and end with a slash (`/`), and contain between
- 1 and 512 alphanumeric characters and/or slashes (`/`), or underscores
- (`_`).
+ description: The path to the EIM user you want to create (by default, `/`). This path name must begin and end with a slash (`/`), and contain between 1 and 512 alphanumeric characters and/or slashes (`/`), or underscores (`_`).
type: string
UserEmail:
description: The email address of the EIM user.
type: string
UserName:
- description: The name of the EIM user. This user name must contain between
- 1 and 64 alphanumeric characters and/or pluses (`+`), equals (`=`), commas
- (`,`), periods (`.`), at signs (`@`), dashes (`-`), or underscores (`_`).
+ description: The name of the EIM user. This user name must contain between 1 and 64 alphanumeric characters and/or pluses (`+`), equals (`=`), commas (`,`), periods (`.`), at signs (`@`), dashes (`-`), or underscores (`_`).
type: string
required:
- UserName
@@ -2099,22 +1891,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
User:
- "$ref": "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
description: Information about the EIM user.
type: object
CreateVirtualGatewayRequest:
additionalProperties: false
properties:
ConnectionType:
- description: The type of VPN connection supported by the virtual gateway
- (always `ipsec.1`).
+ description: The type of VPN connection supported by the virtual gateway (always `ipsec.1`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- ConnectionType
@@ -2123,10 +1913,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VirtualGateway:
- "$ref": "#/components/schemas/VirtualGateway"
+ $ref: '#/components/schemas/VirtualGateway'
description: Information about the virtual gateway.
type: object
CreateVmGroupRequest:
@@ -2136,16 +1926,11 @@ components:
description: A description for the VM group.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PositioningStrategy:
default: no-strategy
- description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`,
- our orchestrator determines the most adequate position for your VMs. If
- set to `attract`, your VMs are deployed on the same hypervisor, which
- improves network performance. If set to `repulse`, your VMs are deployed
- on a different hypervisor, which improves fault tolerance.
+ description: The positioning strategy of VMs on hypervisors. If set to `no-strategy`, our orchestrator determines the most adequate position for your VMs. If set to `attract`, your VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, your VMs are deployed on a different hypervisor, which improves fault tolerance.
enum:
- attract
- no-strategy
@@ -2162,7 +1947,7 @@ components:
Tags:
description: One or more tags to add to the VM group.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmCount:
description: The number of VMs deployed in the VM group.
@@ -2184,10 +1969,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmGroup:
- "$ref": "#/components/schemas/VmGroup"
+ $ref: '#/components/schemas/VmGroup'
description: Information about the VM group.
type: object
CreateVmTemplateRequest:
@@ -2211,12 +1996,10 @@ components:
description: A description for the VM template.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ImageId:
- description: The ID of the OMI to use for each VM. You can find a list of
- OMIs by calling the [ReadImages](#readimages) method.
+ description: The ID of the OMI to use for each VM. You can find a list of OMIs by calling the [ReadImages](#readimages) method.
type: string
KeypairName:
description: The name of the keypair to use for each VM.
@@ -2227,7 +2010,7 @@ components:
Tags:
description: One or more tags to add to the VM template.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmTemplateName:
description: The name of the VM template.
@@ -2243,92 +2026,76 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmTemplate:
- "$ref": "#/components/schemas/VmTemplate"
+ $ref: '#/components/schemas/VmTemplate'
description: Information about the VM template.
type: object
CreateVmsRequest:
additionalProperties: false
properties:
ActionsOnNextBoot:
- "$ref": "#/components/schemas/ActionsOnNextBoot"
+ $ref: '#/components/schemas/ActionsOnNextBoot'
description: The action to perform on the next boot of the VM.
BlockDeviceMappings:
description: One or more block device mappings.
items:
- "$ref": "#/components/schemas/BlockDeviceMappingVmCreation"
+ $ref: '#/components/schemas/BlockDeviceMappingVmCreation'
type: array
BootMode:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
description: The boot mode of the VM.
BootOnCreation:
default: true
- description: If true, the VM is started on creation. If false, the VM is
- stopped on creation.
+ description: If true, the VM is started on creation. If false, the VM is stopped on creation.
type: boolean
BsuOptimized:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: boolean
ClientToken:
- description: A unique identifier which enables you to manage the idempotency.
+ description: 'A unique identifier which enables you to manage the idempotency. With OSC CLI, if you want to specify a number for this value, you must wrap it in two pairs of quotes to make sure the value is parsed as a string: `--ClientToken ''"12345678"''`.'
type: string
DeletionProtection:
- description: If true, you cannot delete the VM unless you change this parameter
- back to false.
+ description: If true, you cannot delete the VM unless you change this parameter back to false.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ImageId:
- description: The ID of the OMI used to create the VM. You can find the list
- of OMIs by calling the [ReadImages](#readimages) method.
+ description: The ID of the OMI used to create the VM. You can find the list of OMIs by calling the [ReadImages](#readimages) method.
type: string
KeypairName:
description: The name of the keypair.
type: string
MaxVmsCount:
- description: The maximum number of VMs you want to create. If all the VMs
- cannot be created, the largest possible number of VMs above MinVmsCount
- is created.
+ description: The maximum number of VMs you want to create. If all the VMs cannot be created, the largest possible number of VMs above MinVmsCount is created.
type: integer
MinVmsCount:
- description: The minimum number of VMs you want to create. If this number
- of VMs cannot be created, no VMs are created.
+ description: The minimum number of VMs you want to create. If this number of VMs cannot be created, no VMs are created.
type: integer
NestedVirtualization:
default: false
- description: "(dedicated tenancy only) If true, nested virtualization is
- enabled. If false, it is disabled."
+ description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled.
type: boolean
Nics:
- description: One or more NICs. If you specify this parameter, you must define
- one NIC as the primary network interface of the VM with `0` as its device
- number.
+ description: One or more NICs. If you specify this parameter, you must define one NIC as the primary network interface of the VM with `0` as its device number.
items:
- "$ref": "#/components/schemas/NicForVmCreation"
+ $ref: '#/components/schemas/NicForVmCreation'
type: array
Performance:
default: high
- description: The performance of the VM. This parameter is ignored if you
- specify a performance flag directly in the `VmType` parameter.
+ description: The performance of the VM. This parameter is ignored if you specify a performance flag directly in the `VmType` parameter.
enum:
- medium
- high
- highest
type: string
Placement:
- "$ref": "#/components/schemas/Placement"
+ $ref: '#/components/schemas/Placement'
description: Information about the placement of the VM.
PrivateIps:
- description: One or more private IPs of the VM. These IPs must be within
- the IP range of the Subnet that you specify with the `SubnetId` parameter.
- However, they cannot be one of the first four IPs (ending in `.0`, `.1`,
- `.2`, `.3`) or the last IP (ending in `.255`) of the Subnet, as these
- are reserved by 3DS OUTSCALE. For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
+ description: One or more private IPs of the VM. These IPs must be within the IP range of the Subnet that you specify with the `SubnetId` parameter. However, they cannot be one of the first four IPs (ending in `.0`, `.1`, `.2`, `.3`) or the last IP (ending in `.255`) of the Subnet, as these are reserved by 3DS OUTSCALE. For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
items:
type: string
type: array
@@ -2342,30 +2109,21 @@ components:
items:
type: string
type: array
+ ShutdownBehaviorConfiguration:
+ $ref: '#/components/schemas/ShutdownBehaviorConfiguration'
+ description: Information about the actions performed by the orchestrator when the VM shuts down.
SubnetId:
description: The ID of the Subnet in which you want to create the VM.
type: string
TpmEnabled:
- description: If true, a virtual Trusted Platform Module (vTPM) is enabled
- on the VM. If false, it is not. The default behavior for this parameter
- varies depending on the source OMI of the VM. If the `TpmMandatory`
- parameter of the source OMI is true, a vTPM has to be attached to the
- VM and it will be created by default. Setting `TpmEnabled` to false will
- cause the creation request to fail. If the `TpmMandatory` parameter
- of the source OMI is false, only setting `TpmEnabled` to true will create
- and attach a vTPM to the VM.
+ description: If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM. If false, it is not. The default behavior for this parameter varies depending on the source OMI of the VM. If the `TpmMandatory` parameter of the source OMI is true, a vTPM has to be attached to the VM and it will be created by default. Setting `TpmEnabled` to false will cause the creation request to fail. If the `TpmMandatory` parameter of the source OMI is false, only setting `TpmEnabled` to true will create and attach a vTPM to the VM.
type: boolean
UserData:
- description: Data or script used to add a specific configuration to the
- VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). For
- more information about user data, see [Configuring a VM with User Data
- and OUTSCALE Tags](https://docs.outscale.com/en/userguide/Configuring-a-VM-with-User-Data-and-OUTSCALE-Tags.html).
+ description: Data or script used to add a specific configuration to the VM. It must be Base64-encoded and is limited to 500 kibibytes (KiB). For more information about user data, see [Configuring a VM with User Data and OUTSCALE Tags](https://docs.outscale.com/en/userguide/Configuring-a-VM-with-User-Data-and-OUTSCALE-Tags.html).
type: string
VmInitiatedShutdownBehavior:
- default: stop
- description: The VM behavior when you stop it. If set to `stop`, the VM
- stops. If set to `restart`, the VM stops then automatically restarts.
- If set to `terminate`, the VM stops and is terminated.
+ deprecated: true
+ description: The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated.
type: string
VmType:
description: |-
@@ -2379,34 +2137,28 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vms:
description: Information about one or more created VMs.
items:
- "$ref": "#/components/schemas/Vm"
+ $ref: '#/components/schemas/Vm'
type: array
type: object
CreateVolumeRequest:
additionalProperties: false
properties:
ClientToken:
- description: A unique identifier which enables you to manage the idempotency.
+ description: 'A unique identifier which enables you to manage the idempotency. With OSC CLI, if you want to specify a number for this value, you must wrap it in two pairs of quotes to make sure the value is parsed as a string: `--ClientToken ''"12345678"''`.'
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Iops:
- description: The number of I/O operations per second (IOPS). This parameter
- must be specified only if you create an `io1` volume. The maximum number
- of IOPS allowed for `io1` volumes is `13000` with a maximum performance
- ratio of 300 IOPS per gibibyte.
+ description: The number of I/O operations per second (IOPS). This parameter must be specified only if you create an `io1` volume. The maximum number of IOPS allowed for `io1` volumes is `13000` with a maximum performance ratio of 300 IOPS per gibibyte.
type: integer
Size:
- description: The size of the volume, in gibibytes (GiB). The maximum allowed
- size for a volume is 14901 GiB. This parameter is required if the volume
- is not created from a snapshot (`SnapshotId` unspecified).
+ description: The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (`SnapshotId` unspecified).
type: integer
SnapshotId:
description: The ID of the snapshot from which you want to create the volume.
@@ -2426,10 +2178,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Volume:
- "$ref": "#/components/schemas/Volume"
+ $ref: '#/components/schemas/Volume'
description: Information about the volume.
type: object
CreateVpnConnectionRequest:
@@ -2442,15 +2194,10 @@ components:
description: The type of VPN connection (always `ipsec.1`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
StaticRoutesOnly:
- description: By default or if false, the VPN connection uses dynamic routing
- with Border Gateway Protocol (BGP). If true, routing is controlled using
- static routes. For more information about how to create and delete static
- routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and
- [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
+ description: By default or if false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
type: boolean
VirtualGatewayId:
description: The ID of the virtual gateway.
@@ -2464,22 +2211,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VpnConnection:
- "$ref": "#/components/schemas/VpnConnection"
+ $ref: '#/components/schemas/VpnConnection'
description: Information about a VPN connection.
type: object
CreateVpnConnectionRouteRequest:
additionalProperties: false
properties:
DestinationIpRange:
- description: The network prefix of the route, in CIDR notation (for example,
- `10.12.0.0/16`).
+ description: The network prefix of the route, in CIDR notation (for example, `10.12.0.0/16`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VpnConnectionId:
description: The ID of the target VPN connection of the static route.
@@ -2492,7 +2237,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DedicatedGroup:
@@ -2532,13 +2277,10 @@ components:
description: The ID of the access key you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserName:
- description: The name of the EIM user the access key you want to delete
- is associated with. By default, the user who sends the request (which
- can be the root user).
+ description: The name of the EIM user the access key you want to delete is associated with. By default, the user who sends the request (which can be the root user).
type: string
required:
- AccessKeyId
@@ -2547,7 +2289,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteApiAccessRuleRequest:
@@ -2557,8 +2299,7 @@ components:
description: The ID of the API access rule you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- ApiAccessRuleId
@@ -2567,7 +2308,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteCaRequest:
@@ -2577,8 +2318,7 @@ components:
description: The ID of the CA you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- CaId
@@ -2587,7 +2327,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteClientGatewayRequest:
@@ -2597,8 +2337,7 @@ components:
description: The ID of the client gateway you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- ClientGatewayId
@@ -2607,7 +2346,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteDedicatedGroupRequest:
@@ -2617,12 +2356,10 @@ components:
description: The ID of the dedicated group you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Force:
- description: If true, forces the deletion of the dedicated group and all
- its dependencies.
+ description: If true, forces the deletion of the dedicated group and all its dependencies.
type: boolean
required:
- DedicatedGroupId
@@ -2631,7 +2368,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteDhcpOptionsRequest:
@@ -2641,8 +2378,7 @@ components:
description: The ID of the DHCP options set you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- DhcpOptionsSetId
@@ -2651,7 +2387,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteDirectLinkInterfaceRequest:
@@ -2661,8 +2397,7 @@ components:
description: The ID of the DirectLink interface you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- DirectLinkInterfaceId
@@ -2671,7 +2406,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteDirectLinkRequest:
@@ -2681,8 +2416,7 @@ components:
description: The ID of the DirectLink you want to delete.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- DirectLinkId
@@ -2691,15 +2425,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteExportTaskRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ExportTaskId:
description: The ID of the export task to delete.
@@ -2711,15 +2444,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteFlexibleGpuRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FlexibleGpuId:
description: The ID of the fGPU you want to delete.
@@ -2731,15 +2463,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteImageRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ImageId:
description: The ID of the OMI you want to delete.
@@ -2751,15 +2482,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteInternetServiceRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
InternetServiceId:
description: The ID of the internet service you want to delete.
@@ -2771,15 +2501,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteKeypairRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
KeypairId:
description: The ID of the keypair you want to delete.
@@ -2792,15 +2521,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteListenerRuleRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ListenerRuleName:
description: The name of the rule you want to delete.
@@ -2812,19 +2540,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteLoadBalancerListenersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
- description: The name of the load balancer for which you want to delete
- listeners.
+ description: The name of the load balancer for which you want to delete listeners.
type: string
LoadBalancerPorts:
description: One or more port numbers of the listeners you want to delete.
@@ -2839,22 +2565,20 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteLoadBalancerPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
- description: The name of the load balancer for which you want to delete
- a policy.
+ description: The name of the load balancer for which you want to delete a policy.
type: string
PolicyName:
description: The name of the policy you want to delete.
@@ -2867,18 +2591,17 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteLoadBalancerRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer you want to delete.
@@ -2890,18 +2613,17 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteLoadBalancerTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerNames:
description: One or more load balancer names.
@@ -2911,7 +2633,7 @@ components:
Tags:
description: One or more tags to delete from the load balancers.
items:
- "$ref": "#/components/schemas/ResourceLoadBalancerTag"
+ $ref: '#/components/schemas/ResourceLoadBalancerTag'
type: array
required:
- LoadBalancerNames
@@ -2921,15 +2643,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteNatServiceRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NatServiceId:
description: The ID of the NAT service you want to delete.
@@ -2941,15 +2662,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteNetAccessPointRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetAccessPointId:
description: The ID of the Net access point.
@@ -2961,15 +2681,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteNetPeeringRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetPeeringId:
description: The ID of the Net peering you want to delete.
@@ -2981,15 +2700,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteNetRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net you want to delete.
@@ -3001,15 +2719,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteNicRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NicId:
description: The ID of the NIC you want to delete.
@@ -3021,20 +2738,18 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeletePolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy you want to
- delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy you want to delete. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
required:
- PolicyOrn
@@ -3043,16 +2758,15 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeletePolicyVersionRequest:
additionalProperties: false
properties:
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
VersionId:
description: The ID of the version of the policy you want to delete.
@@ -3065,19 +2779,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteProductTypeRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Force:
- description: If true, forces the deletion of the product type associated
- with one or more OMIs.
+ description: If true, forces the deletion of the product type associated with one or more OMIs.
type: boolean
ProductTypeId:
description: The ID of the product type you want to delete.
@@ -3089,29 +2801,27 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeletePublicIpRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PublicIp:
description: The public IP. In the public Cloud, this parameter is required.
type: string
PublicIpId:
- description: The ID representing the association of the public IP with the
- VM or the NIC. In a Net, this parameter is required.
+ description: The ID representing the association of the public IP with the VM or the NIC. In a Net, this parameter is required.
type: string
type: object
DeletePublicIpResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteRouteRequest:
@@ -3121,8 +2831,7 @@ components:
description: The exact IP range for the route.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
RouteTableId:
description: The ID of the route table from which you want to delete a route.
@@ -3135,18 +2844,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTable:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
description: Information about the route table.
type: object
DeleteRouteTableRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
RouteTableId:
description: The ID of the route table you want to delete.
@@ -3158,15 +2866,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteSecurityGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
SecurityGroupId:
description: The ID of the security group you want to delete.
@@ -3179,52 +2886,43 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteSecurityGroupRuleRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Flow:
- description: 'The direction of the flow: `Inbound` or `Outbound`. You can
- specify `Outbound` for Nets only.'
+ description: 'The direction of the flow: `Inbound` or `Outbound`. You can specify `Outbound` for Nets only.'
type: string
FromPortRange:
- description: The beginning of the port range for the TCP and UDP protocols,
- or an ICMP type number.
+ description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
type: integer
IpProtocol:
- description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all
- protocols). By default, `-1`. In a Net, this can also be an IP protocol
- number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
+ description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
type: string
IpRange:
- description: The IP range for the security group rule, in CIDR notation
- (for example, `10.0.0.0/16`).
+ description: The IP range for the security group rule, in CIDR notation (for example, `10.0.0.0/16`).
type: string
Rules:
description: One or more rules you want to delete from the security group.
items:
- "$ref": "#/components/schemas/SecurityGroupRule"
+ $ref: '#/components/schemas/SecurityGroupRule'
type: array
SecurityGroupAccountIdToUnlink:
- description: The OUTSCALE account ID of the owner of the security group
- you want to delete a rule from.
+ description: The OUTSCALE account ID of the owner of the security group you want to delete a rule from.
type: string
SecurityGroupId:
description: The ID of the security group you want to delete a rule from.
type: string
SecurityGroupNameToUnlink:
- description: The ID of the source security group. If you are in the Public
- Cloud, you can also specify the name of the source security group.
+ description: The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group.
type: string
ToPortRange:
- description: The end of the port range for the TCP and UDP protocols, or
- an ICMP code number.
+ description: The end of the port range for the TCP and UDP protocols, or an ICMP code number.
type: integer
required:
- SecurityGroupId
@@ -3234,18 +2932,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SecurityGroup:
- "$ref": "#/components/schemas/SecurityGroup"
+ $ref: '#/components/schemas/SecurityGroup'
description: Information about the security group.
type: object
DeleteServerCertificateRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Name:
description: The name of the server certificate you want to delete.
@@ -3257,15 +2954,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteSnapshotRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
SnapshotId:
description: The ID of the snapshot you want to delete.
@@ -3277,15 +2973,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteSubnetRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
SubnetId:
description: The ID of the Subnet you want to delete.
@@ -3297,15 +2992,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ResourceIds:
description: One or more resource IDs.
@@ -3313,10 +3007,9 @@ components:
type: string
type: array
Tags:
- description: One or more tags to delete (if you set a tag value, only the
- tags matching exactly this value are deleted).
+ description: One or more tags to delete (if you set a tag value, only the tags matching exactly this value are deleted).
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
required:
- ResourceIds
@@ -3326,15 +3019,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteUserGroupPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyName:
description: The name of the policy document you want to delete.
@@ -3343,8 +3035,7 @@ components:
description: The name of the group.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
required:
- UserGroupName
@@ -3354,23 +3045,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Force:
- description: If true, forces the deletion of the user group even if it is
- not empty.
+ description: If true, forces the deletion of the user group even if it is not empty.
type: boolean
Path:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserGroupName:
description: The name of the group you want to delete.
@@ -3382,19 +3070,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteUserPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyName:
- description: The name of the policy document you want to delete (between
- 1 and 128 characters).
+ description: The name of the policy document you want to delete (between 1 and 128 characters).
type: string
UserName:
description: The name of the user you want to delete the policy from.
@@ -3407,15 +3093,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteUserRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserName:
description: The name of the EIM user you want to delete.
@@ -3427,15 +3112,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVirtualGatewayRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VirtualGatewayId:
description: The ID of the virtual gateway you want to delete.
@@ -3447,15 +3131,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVmGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmGroupId:
description: The ID of the VM group you want to delete.
@@ -3467,15 +3150,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVmTemplateRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmTemplateId:
description: The ID of the VM template you want to delete.
@@ -3487,15 +3169,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVmsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmIds:
description: One or more IDs of VMs.
@@ -3509,20 +3190,19 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vms:
description: Information about one or more terminated VMs.
items:
- "$ref": "#/components/schemas/VmState"
+ $ref: '#/components/schemas/VmState'
type: array
type: object
DeleteVolumeRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VolumeId:
description: The ID of the volume you want to delete.
@@ -3534,15 +3214,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVpnConnectionRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VpnConnectionId:
description: The ID of the VPN connection you want to delete.
@@ -3554,23 +3233,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeleteVpnConnectionRouteRequest:
additionalProperties: false
properties:
DestinationIpRange:
- description: The network prefix of the route to delete, in CIDR notation
- (for example, `10.12.0.0/16`).
+ description: The network prefix of the route to delete, in CIDR notation (for example, `10.12.0.0/16`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VpnConnectionId:
- description: The ID of the target VPN connection of the static route to
- delete.
+ description: The ID of the target VPN connection of the static route to delete.
type: string
required:
- DestinationIpRange
@@ -3580,7 +3256,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DeregisterVmsInLoadBalancerRequest:
@@ -3592,8 +3268,7 @@ components:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer.
@@ -3606,7 +3281,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DhcpOptionsSet:
@@ -3614,8 +3289,7 @@ components:
description: Information about the DHCP options set.
properties:
Default:
- description: If true, the DHCP options set is a default one. If false, it
- is not.
+ description: If true, the DHCP options set is a default one. If false, it is not.
type: boolean
DhcpOptionsSetId:
description: The ID of the DHCP options set.
@@ -3641,7 +3315,7 @@ components:
Tags:
description: One or more tags associated with the DHCP options set.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
DirectLink:
@@ -3702,8 +3376,7 @@ components:
description: The ID of the target virtual gateway.
type: string
Vlan:
- description: The VLAN number associated with the DirectLink interface. This
- number must be unique and be between `2` and `4094`.
+ description: The VLAN number associated with the DirectLink interface. This number must be unique and be between `2` and `4094`.
type: integer
required:
- BgpAsn
@@ -3719,8 +3392,7 @@ components:
description: The OUTSCALE account ID of the owner of the DirectLink interface.
type: string
BgpAsn:
- description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number)
- on the customer's side of the DirectLink interface.
+ description: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer's side of the DirectLink interface.
type: integer
BgpKey:
description: The BGP authentication key.
@@ -3744,15 +3416,13 @@ components:
description: The datacenter where the DirectLink interface is located.
type: string
Mtu:
- description: The maximum transmission unit (MTU) of the DirectLink interface,
- in bytes.
+ description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes.
type: integer
OutscalePrivateIp:
description: The IP on the OUTSCALE side of the DirectLink interface.
type: string
State:
- description: The state of the DirectLink interface (`pending` \| `available`
- \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`).
+ description: The state of the DirectLink interface (`pending` \| `available` \| `deleting` \| `deleted` \| `confirming` \| `rejected` \| `expired`).
type: string
VirtualGatewayId:
description: The ID of the target virtual gateway.
@@ -3765,27 +3435,24 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
DisableOutscaleLoginForUsersResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DisableOutscaleLoginPerUsersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserNames:
- description: The usernames of the EIM users you want to disable the Outscale
- login for.
+ description: The usernames of the EIM users you want to disable the Outscale login for.
items:
type: string
type: array
@@ -3796,49 +3463,45 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
DisableOutscaleLoginRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
DisableOutscaleLoginResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
EnableOutscaleLoginForUsersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
EnableOutscaleLoginForUsersResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
EnableOutscaleLoginPerUsersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserNames:
- description: The usernames of the EIM users you want to enable the Outscale
- login for.
+ description: The usernames of the EIM users you want to enable the Outscale login for.
items:
type: string
type: array
@@ -3849,22 +3512,21 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
EnableOutscaleLoginRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
EnableOutscaleLoginResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ErrorResponse:
@@ -3873,10 +3535,10 @@ components:
Errors:
description: One or more errors.
items:
- "$ref": "#/components/schemas/Errors"
+ $ref: '#/components/schemas/Errors'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
Errors:
@@ -3884,9 +3546,7 @@ components:
description: Information about the errors.
properties:
Code:
- description: The code of the error (for example, `4078`). You can search
- for this returned code in the [errors page](api-errors.html) to find more
- details about the error.
+ description: The code of the error (for example, `4078`). You can search for this returned code in the [errors page](api-errors.html) to find more details about the error.
type: string
Details:
description: A description providing more details about the error.
@@ -3950,8 +3610,7 @@ components:
type: string
type: array
QueryApiNames:
- description: The names of the APIs of the logged calls (always `oapi` for
- the OUTSCALE API).
+ description: The names of the APIs of the logged calls (always `oapi` for the OUTSCALE API).
items:
type: string
type: array
@@ -3961,19 +3620,19 @@ components:
type: string
type: array
QueryDateAfter:
- description: The date and time, or the date, after which you want to retrieve
- logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`
- or `2020-06-14`). By default, this date is set to 48 hours before the
- `QueryDateBefore` parameter value.
- format: date
- type: string
+ description: The date and time, or the date, after which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). By default, this date is set to 48 hours before the `QueryDateBefore` parameter value.
+ oneOf:
+ - format: date-time
+ type: string
+ - format: date
+ type: string
QueryDateBefore:
- description: The date and time, or the date, before which you want to retrieve
- logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z`
- or `2020-06-14`). By default, this date is set to now, or 48 hours after
- the `QueryDateAfter` parameter value.
- format: date
- type: string
+ description: The date and time, or the date, before which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` or `2020-06-14`). By default, this date is set to now, or 48 hours after the `QueryDateAfter` parameter value.
+ oneOf:
+ - format: date-time
+ type: string
+ - format: date
+ type: string
QueryIpAddresses:
description: The IPs used for the logged calls.
items:
@@ -4020,19 +3679,14 @@ components:
description: One or more filters.
properties:
CurrentCatalogOnly:
- description: By default or if set to true, only returns the current catalog.
- If false, returns the current catalog and past catalogs.
+ description: By default or if set to true, only returns the current catalog. If false, returns the current catalog and past catalogs.
type: boolean
FromDate:
- description: The beginning of the time period, in ISO 8601 date format (for
- example, `2020-06-14`). This date cannot be older than 3 years. You must
- specify the parameters `FromDate` and `ToDate` together.
+ description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). This date cannot be older than 3 years. You must specify the parameters `FromDate` and `ToDate` together.
format: date
type: string
ToDate:
- description: The end of the time period, in ISO 8601 date format (for example,
- `2020-06-30`). You must specify the parameters `FromDate` and `ToDate`
- together.
+ description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). You must specify the parameters `FromDate` and `ToDate` together.
format: date
type: string
type: object
@@ -4041,8 +3695,7 @@ components:
description: One or more filters.
properties:
BgpAsns:
- description: The Border Gateway Protocol (BGP) Autonomous System Numbers
- (ASNs) of the connections.
+ description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
items:
type: integer
type: array
@@ -4052,8 +3705,7 @@ components:
type: string
type: array
ConnectionTypes:
- description: The types of communication tunnels used by the client gateways
- (always `ipsec.1`).
+ description: The types of communication tunnels used by the client gateways (always `ipsec.1`).
items:
type: string
type: array
@@ -4063,8 +3715,7 @@ components:
type: string
type: array
States:
- description: The states of the client gateways (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The states of the client gateways (`pending` \| `available` \| `deleting` \| `deleted`).
items:
type: string
type: array
@@ -4079,8 +3730,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4090,8 +3740,7 @@ components:
description: One or more filters.
properties:
CpuGenerations:
- description: The processor generation for the VMs in the dedicated group
- (for example, `4`).
+ description: The processor generation for the VMs in the dedicated group (for example, `4`).
items:
type: integer
type: array
@@ -4106,8 +3755,7 @@ components:
type: string
type: array
SubregionNames:
- description: The names of the Subregions in which the dedicated groups are
- located.
+ description: The names of the Subregions in which the dedicated groups are located.
items:
type: string
type: array
@@ -4117,8 +3765,7 @@ components:
description: One or more filters.
properties:
Default:
- description: If true, lists all default DHCP options set. If false, lists
- all non-default DHCP options set.
+ description: If true, lists all default DHCP options set. If false, lists all non-default DHCP options set.
type: boolean
DhcpOptionsSetIds:
description: The IDs of the DHCP options sets.
@@ -4126,8 +3773,7 @@ components:
type: string
type: array
DomainNameServers:
- description: The IPs of the domain name servers used for the DHCP options
- sets.
+ description: The IPs of the domain name servers used for the DHCP options sets.
items:
type: string
type: array
@@ -4142,8 +3788,7 @@ components:
type: string
type: array
NtpServers:
- description: The IPs of the Network Time Protocol (NTP) servers used for
- the DHCP options sets.
+ description: The IPs of the Network Time Protocol (NTP) servers used for the DHCP options sets.
items:
type: string
type: array
@@ -4158,8 +3803,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4194,8 +3838,7 @@ components:
description: One or more filters.
properties:
DeleteOnVmDeletion:
- description: Indicates whether the fGPU is deleted when terminating the
- VM.
+ description: Indicates whether the fGPU is deleted when terminating the VM.
type: boolean
FlexibleGpuIds:
description: One or more IDs of fGPUs.
@@ -4208,14 +3851,12 @@ components:
type: string
type: array
ModelNames:
- description: One or more models of fGPUs. For more information, see [About
- Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
+ description: One or more models of fGPUs. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
items:
type: string
type: array
States:
- description: The states of the fGPUs (`allocated` \| `attaching` \| `attached`
- \| `detaching`).
+ description: The states of the fGPUs (`allocated` \| `attaching` \| `attached` \| `detaching`).
items:
type: string
type: array
@@ -4227,7 +3868,7 @@ components:
Tags:
description: One or more tags associated with the fGPUs.
items:
- "$ref": "#/components/schemas/Tag"
+ $ref: '#/components/schemas/Tag'
type: array
VmIds:
description: One or more IDs of VMs.
@@ -4245,8 +3886,7 @@ components:
type: string
type: array
AccountIds:
- description: The OUTSCALE account IDs of the owners of the OMIs. By default,
- all the OMIs for which you have launch permissions are described.
+ description: The OUTSCALE account IDs of the owners of the OMIs. By default, all the OMIs for which you have launch permissions are described.
items:
type: string
type: array
@@ -4256,8 +3896,7 @@ components:
type: string
type: array
BlockDeviceMappingDeleteOnVmDeletion:
- description: Whether the volumes are deleted or not when terminating the
- VM.
+ description: Whether the volumes are deleted or not when terminating the VM.
type: boolean
BlockDeviceMappingDeviceNames:
description: The device names for the volumes.
@@ -4282,7 +3921,7 @@ components:
BootModes:
description: The boot modes compatible with the OMIs.
items:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
type: array
Descriptions:
description: The descriptions of the OMIs, provided when they were created.
@@ -4310,14 +3949,12 @@ components:
type: string
type: array
PermissionsToLaunchAccountIds:
- description: The OUTSCALE account IDs which have launch permissions for
- the OMIs.
+ description: The OUTSCALE account IDs which have launch permissions for the OMIs.
items:
type: string
type: array
PermissionsToLaunchGlobalPermission:
- description: If true, lists all public OMIs. If false, lists all private
- OMIs.
+ description: If true, lists all public OMIs. If false, lists all private OMIs.
type: boolean
ProductCodeNames:
description: The names of the product codes associated with the OMI.
@@ -4358,14 +3995,12 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
TpmMandatory:
- description: Whether a virtual Trusted Platform Module (vTPM) is mandatory
- for VMs created from this OMI (true) or not (false).
+ description: Whether a virtual Trusted Platform Module (vTPM) is mandatory for VMs created from this OMI (true) or not (false).
type: boolean
VirtualizationTypes:
description: The virtualization types (always `hvm`).
@@ -4388,9 +4023,7 @@ components:
type: string
type: array
LinkStates:
- description: The current states of the attachments between the internet
- services and the Nets (only `available`, if the internet gateway is attached
- to a Net).
+ description: The current states of the attachments between the internet services and the Nets (only `available`, if the internet gateway is attached to a Net).
items:
type: string
type: array
@@ -4405,8 +4038,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4431,8 +4063,7 @@ components:
type: string
type: array
KeypairTypes:
- description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`,
- `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
+ description: The types of the keypairs (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
items:
type: string
type: array
@@ -4447,8 +4078,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- keypairs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the keypairs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4473,8 +4103,7 @@ components:
type: string
type: array
States:
- description: The states of the load balancer (`provisioning` \| `starting`
- \| `reloading` \| `active` \| `reconfiguring` \| `deleting` \| `deleted`).
+ description: The states of the load balancer (`provisioning` \| `starting` \| `reloading` \| `active` \| `reconfiguring` \| `deleting` \| `deleted`).
items:
type: string
type: array
@@ -4499,8 +4128,7 @@ components:
type: string
type: array
States:
- description: The states of the NAT services (`pending` \| `available` \|
- `deleting` \| `deleted`).
+ description: The states of the NAT services (`pending` \| `available` \| `deleting` \| `deleted`).
items:
type: string
type: array
@@ -4520,8 +4148,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4536,8 +4163,7 @@ components:
type: string
type: array
IpRanges:
- description: The IP ranges for the Nets, in CIDR notation (for example,
- `10.0.0.0/16`).
+ description: The IP ranges for the Nets, in CIDR notation (for example, `10.0.0.0/16`).
items:
type: string
type: array
@@ -4565,8 +4191,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4591,8 +4216,7 @@ components:
type: string
type: array
States:
- description: The states of the Net access points (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The states of the Net access points (`pending` \| `available` \| `deleting` \| `deleted`).
items:
type: string
type: array
@@ -4607,8 +4231,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4623,8 +4246,7 @@ components:
type: string
type: array
AccepterNetIpRanges:
- description: The IP ranges of the peer Nets, in CIDR notation (for example,
- `10.0.0.0/24`).
+ description: The IP ranges of the peer Nets, in CIDR notation (for example, `10.0.0.0/24`).
items:
type: string
type: array
@@ -4634,8 +4256,7 @@ components:
type: string
type: array
ExpirationDates:
- description: The dates and times at which the Net peerings expire, in ISO
- 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`).
+ description: The dates and times at which the Net peerings expire, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`).
items:
format: date-time
type: string
@@ -4666,8 +4287,7 @@ components:
type: string
type: array
StateNames:
- description: The states of the Net peerings (`pending-acceptance` \| `active`
- \| `rejected` \| `failed` \| `expired` \| `deleted`).
+ description: The states of the Net peerings (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
items:
type: string
type: array
@@ -4682,8 +4302,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the Net peerings, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4698,12 +4317,10 @@ components:
type: string
type: array
IsSourceDestCheck:
- description: Whether the source/destination checking is enabled (true) or
- disabled (false).
+ description: Whether the source/destination checking is enabled (true) or disabled (false).
type: boolean
LinkNicDeleteOnVmDeletion:
- description: Whether the NICs are deleted when the VMs they are attached
- to are terminated.
+ description: Whether the NICs are deleted when the VMs they are attached to are terminated.
type: boolean
LinkNicDeviceNumbers:
description: The device numbers the NICs are attached to.
@@ -4721,8 +4338,7 @@ components:
type: string
type: array
LinkNicVmAccountIds:
- description: The OUTSCALE account IDs of the owners of the VMs the NICs
- are attached to.
+ description: The OUTSCALE account IDs of the owners of the VMs the NICs are attached to.
items:
type: string
type: array
@@ -4732,14 +4348,12 @@ components:
type: string
type: array
LinkPublicIpAccountIds:
- description: The OUTSCALE account IDs of the owners of the public IPs associated
- with the NICs.
+ description: The OUTSCALE account IDs of the owners of the public IPs associated with the NICs.
items:
type: string
type: array
LinkPublicIpLinkPublicIpIds:
- description: The association IDs returned when the public IPs were associated
- with the NICs.
+ description: The association IDs returned when the public IPs were associated with the NICs.
items:
type: string
type: array
@@ -4749,8 +4363,7 @@ components:
type: string
type: array
LinkPublicIpPublicIpIds:
- description: The allocation IDs returned when the public IPs were allocated
- to their accounts.
+ description: The allocation IDs returned when the public IPs were allocated to their accounts.
items:
type: string
type: array
@@ -4780,8 +4393,7 @@ components:
type: string
type: array
PrivateIpsLinkPublicIpAccountIds:
- description: The OUTSCALE account IDs of the owner of the public IPs associated
- with the private IPs.
+ description: The OUTSCALE account IDs of the owner of the public IPs associated with the private IPs.
items:
type: string
type: array
@@ -4791,8 +4403,7 @@ components:
type: string
type: array
PrivateIpsPrimaryIp:
- description: Whether the private IP is the primary IP associated with the
- NIC.
+ description: Whether the private IP is the primary IP associated with the NIC.
type: boolean
PrivateIpsPrivateIps:
description: The private IPs of the NICs.
@@ -4835,8 +4446,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the NICs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4856,8 +4466,7 @@ components:
description: One or more filters.
properties:
LinkPublicIpIds:
- description: The IDs representing the associations of public IPs with VMs
- or NICs.
+ description: The IDs representing the associations of public IPs with VMs or NICs.
items:
type: string
type: array
@@ -4872,8 +4481,7 @@ components:
type: string
type: array
Placements:
- description: Whether the public IPs are for use in the public Cloud or in
- a Net.
+ description: Whether the public IPs are for use in the public Cloud or in a Net.
items:
type: string
type: array
@@ -4903,8 +4511,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the public IPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -4929,8 +4536,7 @@ components:
type: string
type: array
QuotaTypes:
- description: The resource IDs if these are resource-specific quotas, `global`
- if they are not.
+ description: The resource IDs if these are resource-specific quotas, `global` if they are not.
items:
type: string
type: array
@@ -4980,8 +4586,7 @@ components:
type: string
type: array
LinkRouteTableLinkRouteTableIds:
- description: The IDs of the associations between the route tables and the
- Subnets.
+ description: The IDs of the associations between the route tables and the Subnets.
items:
type: string
type: array
@@ -5054,8 +4659,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5075,20 +4679,17 @@ components:
type: string
type: array
InboundRuleFromPortRanges:
- description: The beginnings of the port ranges for the TCP and UDP protocols,
- or the ICMP type numbers.
+ description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers.
items:
type: integer
type: array
InboundRuleIpRanges:
- description: The IP ranges that have been granted permissions, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`).
items:
type: string
type: array
InboundRuleProtocols:
- description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`,
- or a protocol number, or `-1` for all protocols).
+ description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols).
items:
type: string
type: array
@@ -5103,14 +4704,12 @@ components:
type: string
type: array
InboundRuleToPortRanges:
- description: The ends of the port ranges for the TCP and UDP protocols,
- or the ICMP code numbers.
+ description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers.
items:
type: integer
type: array
NetIds:
- description: The IDs of the Nets specified when the security groups were
- created.
+ description: The IDs of the Nets specified when the security groups were created.
items:
type: string
type: array
@@ -5120,20 +4719,17 @@ components:
type: string
type: array
OutboundRuleFromPortRanges:
- description: The beginnings of the port ranges for the TCP and UDP protocols,
- or the ICMP type numbers.
+ description: The beginnings of the port ranges for the TCP and UDP protocols, or the ICMP type numbers.
items:
type: integer
type: array
OutboundRuleIpRanges:
- description: The IP ranges that have been granted permissions, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP ranges that have been granted permissions, in CIDR notation (for example, `10.0.0.0/24`).
items:
type: string
type: array
OutboundRuleProtocols:
- description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`,
- or a protocol number, or `-1` for all protocols).
+ description: The IP protocols for the permissions (`tcp` \| `udp` \| `icmp`, or a protocol number, or `-1` for all protocols).
items:
type: string
type: array
@@ -5148,8 +4744,7 @@ components:
type: string
type: array
OutboundRuleToPortRanges:
- description: The ends of the port ranges for the TCP and UDP protocols,
- or the ICMP code numbers.
+ description: The ends of the port ranges for the TCP and UDP protocols, or the ICMP code numbers.
items:
type: integer
type: array
@@ -5174,8 +4769,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5230,8 +4824,7 @@ components:
type: string
type: array
FromCreationDate:
- description: The beginning of the time period, in ISO 8601 date-time format
- (for example, `2020-06-14T00:00:00.000Z`).
+ description: The beginning of the time period, in ISO 8601 date-time format (for example, `2020-06-14T00:00:00.000Z`).
format: date-time
type: string
PermissionsToCreateVolumeAccountIds:
@@ -5240,8 +4833,7 @@ components:
type: string
type: array
PermissionsToCreateVolumeGlobalPermission:
- description: If true, lists all public volumes. If false, lists all private
- volumes.
+ description: If true, lists all public volumes. If false, lists all private volumes.
type: boolean
Progresses:
description: The progresses of the snapshots, as a percentage.
@@ -5254,8 +4846,7 @@ components:
type: string
type: array
States:
- description: The states of the snapshots (`in-queue` \| `pending` \| `completed`
- \| `error` \| `deleting`).
+ description: The states of the snapshots (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`).
items:
type: string
type: array
@@ -5270,14 +4861,12 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
ToCreationDate:
- description: The end of the time period, in ISO 8601 date-time format (for
- example, `2020-06-30T00:00:00.000Z`).
+ description: The end of the time period, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
format: date-time
type: string
VolumeIds:
@@ -5286,8 +4875,7 @@ components:
type: string
type: array
VolumeSizes:
- description: The sizes of the volumes used to create the snapshots, in gibibytes
- (GiB).
+ description: The sizes of the volumes used to create the snapshots, in gibibytes (GiB).
items:
type: integer
type: array
@@ -5317,8 +4905,7 @@ components:
type: integer
type: array
IpRanges:
- description: The IP ranges in the Subnets, in CIDR notation (for example,
- `10.0.0.0/16`).
+ description: The IP ranges in the Subnets, in CIDR notation (for example, `10.0.0.0/16`).
items:
type: string
type: array
@@ -5353,8 +4940,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the Subnets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5384,9 +4970,7 @@ components:
description: One or more filters.
properties:
Keys:
- description: The keys of the tags that are assigned to the resources. You
- can use this filter alongside the `Values` filter. In that case, you filter
- the resources corresponding to each tag, regardless of the other filter.
+ description: The keys of the tags that are assigned to the resources. You can use this filter alongside the `Values` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter.
items:
type: string
type: array
@@ -5396,19 +4980,12 @@ components:
type: string
type: array
ResourceTypes:
- description: The resource type (`customer-gateway` \| `dhcpoptions` \| `flexible-gpu`
- \| `image` \| `instance` \| `keypair` \| `natgateway` \| `network-interface`
- \| `public-ip` \| `route-table` \| `security-group` \| `snapshot` \| `subnet`
- \| `task` \| `virtual-private-gateway` \| `volume` \| `vpc` \| `vpc-endpoint`
- \| `vpc-peering-connection`\| `vpn-connection`).
+ description: The resource type (`customer-gateway` \| `dhcpoptions` \| `flexible-gpu` \| `image` \| `instance` \| `keypair` \| `natgateway` \| `network-interface` \| `public-ip` \| `route-table` \| `security-group` \| `snapshot` \| `subnet` \| `task` \| `virtual-private-gateway` \| `volume` \| `vpc` \| `vpc-endpoint` \| `vpc-peering-connection`\| `vpn-connection`).
items:
type: string
type: array
Values:
- description: The values of the tags that are assigned to the resources.
- You can use this filter alongside the `TagKeys` filter. In that case,
- you filter the resources corresponding to each tag, regardless of the
- other filter.
+ description: The values of the tags that are assigned to the resources. You can use this filter alongside the `TagKeys` filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter.
items:
type: string
type: array
@@ -5418,8 +4995,7 @@ components:
description: One or more filters.
properties:
PathPrefix:
- description: The path prefix of the groups. If not specified, it is set
- to a slash (`/`).
+ description: The path prefix of the groups. If not specified, it is set to a slash (`/`).
type: string
UserGroupIds:
description: The IDs of the user groups.
@@ -5452,14 +5028,12 @@ components:
type: string
type: array
LinkStates:
- description: The current states of the attachments between the virtual gateways
- and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`).
+ description: The current states of the attachments between the virtual gateways and the Nets (`attaching` \| `attached` \| `detaching` \| `detached`).
items:
type: string
type: array
States:
- description: The states of the virtual gateways (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The states of the virtual gateways (`pending` \| `available` \| `deleting` \| `deleted`).
items:
type: string
type: array
@@ -5474,8 +5048,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5498,21 +5071,21 @@ components:
description: Whether the BSU volumes are deleted when terminating the VMs.
type: boolean
BlockDeviceMappingDeviceNames:
- description: The device names for the BSU volumes (in the format `/dev/sdX`,
- `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`).
+ description: The device names for the BSU volumes (in the format `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX`).
items:
type: string
type: array
BlockDeviceMappingLinkDates:
- description: The link dates for the BSU volumes mapped to the VMs (for example,
- `2016-01-23T18:45:30.000Z`).
+ description: The link dates for the BSU volumes mapped to the VMs (for example, `2016-01-23T18:45:30.000Z`).
items:
- format: date
- type: string
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
type: array
BlockDeviceMappingStates:
- description: The states for the BSU volumes (`attaching` \| `attached` \|
- `detaching` \| `detached`).
+ description: The states for the BSU volumes (`attaching` \| `attached` \| `detaching` \| `detached`).
items:
type: string
type: array
@@ -5524,7 +5097,7 @@ components:
BootModes:
description: The boot modes of the VMs.
items:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
type: array
ClientTokens:
description: The idempotency tokens provided when launching the VMs.
@@ -5534,8 +5107,11 @@ components:
CreationDates:
description: The dates when the VMs were launched.
items:
- format: date
- type: string
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
type: array
ImageIds:
description: The IDs of the OMIs used to launch the VMs.
@@ -5543,8 +5119,7 @@ components:
type: string
type: array
IsSourceDestChecked:
- description: Whether the source/destination checking is enabled (true) or
- disabled (false).
+ description: Whether the source/destination checking is enabled (true) or disabled (false).
type: boolean
KeypairNames:
description: The names of the keypairs used when launching the VMs.
@@ -5552,8 +5127,7 @@ components:
type: string
type: array
LaunchNumbers:
- description: The numbers for the VMs when launching a group of several VMs
- (for example, `0`, `1`, `2`, and so on).
+ description: The numbers for the VMs when launching a group of several VMs (for example, `0`, `1`, `2`, and so on).
items:
type: integer
type: array
@@ -5578,12 +5152,10 @@ components:
type: string
type: array
NicIsSourceDestChecked:
- description: Whether the source/destination checking is enabled (true) or
- disabled (false).
+ description: Whether the source/destination checking is enabled (true) or disabled (false).
type: boolean
NicLinkNicDeleteOnVmDeletion:
- description: Whether the NICs are deleted when the VMs they are attached
- to are deleted.
+ description: Whether the NICs are deleted when the VMs they are attached to are deleted.
type: boolean
NicLinkNicDeviceNumbers:
description: The device numbers the NICs are attached to.
@@ -5591,11 +5163,13 @@ components:
type: integer
type: array
NicLinkNicLinkNicDates:
- description: The dates and times (UTC) when the NICs were attached to the
- VMs.
+ description: The dates and times (UTC) when the NICs were attached to the VMs.
items:
- format: date
- type: string
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
type: array
NicLinkNicLinkNicIds:
description: The IDs of the NIC attachments.
@@ -5608,8 +5182,7 @@ components:
type: string
type: array
NicLinkNicVmAccountIds:
- description: The OUTSCALE account IDs of the owners of the VMs the NICs
- are attached to.
+ description: The OUTSCALE account IDs of the owners of the VMs the NICs are attached to.
items:
type: string
type: array
@@ -5619,20 +5192,17 @@ components:
type: string
type: array
NicLinkPublicIpAccountIds:
- description: The OUTSCALE account IDs of the owners of the public IPs associated
- with the NICs.
+ description: The OUTSCALE account IDs of the owners of the public IPs associated with the NICs.
items:
type: string
type: array
NicLinkPublicIpLinkPublicIpIds:
- description: The association IDs returned when the public IPs were associated
- with the NICs.
+ description: The association IDs returned when the public IPs were associated with the NICs.
items:
type: string
type: array
NicLinkPublicIpPublicIpIds:
- description: The allocation IDs returned when the public IPs were allocated
- to their accounts.
+ description: The allocation IDs returned when the public IPs were allocated to their accounts.
items:
type: string
type: array
@@ -5657,8 +5227,7 @@ components:
type: string
type: array
NicPrivateIpsLinkPublicIpAccountIds:
- description: The OUTSCALE account IDs of the owner of the public IPs associated
- with the private IPs.
+ description: The OUTSCALE account IDs of the owner of the public IPs associated with the private IPs.
items:
type: string
type: array
@@ -5668,8 +5237,7 @@ components:
type: string
type: array
NicPrivateIpsPrimaryIp:
- description: Whether the private IPs are the primary IPs associated with
- the NICs.
+ description: Whether the private IPs are the primary IPs associated with the NICs.
type: boolean
NicPrivateIpsPrivateIps:
description: The private IPs of the NICs.
@@ -5702,8 +5270,7 @@ components:
type: string
type: array
Platforms:
- description: The platforms. Use windows if you have Windows VMs. Otherwise,
- leave this filter blank.
+ description: The platforms. Use windows if you have Windows VMs. Otherwise, leave this filter blank.
items:
type: string
type: array
@@ -5713,8 +5280,7 @@ components:
type: string
type: array
ProductCodes:
- description: The product codes associated with the OMI used to create the
- VMs.
+ description: The product codes associated with the OMI used to create the VMs.
items:
type: string
type: array
@@ -5724,9 +5290,7 @@ components:
type: string
type: array
ReservationIds:
- description: The IDs of the reservation of the VMs, created every time you
- launch VMs. These reservation IDs can be associated with several VMs when
- you launch a group of VMs using the same launch request.
+ description: The IDs of the reservation of the VMs, created every time you launch VMs. These reservation IDs can be associated with several VMs when you launch a group of VMs using the same launch request.
items:
type: string
type: array
@@ -5741,14 +5305,12 @@ components:
type: string
type: array
SecurityGroupIds:
- description: The IDs of the security groups for the VMs (only in the public
- Cloud).
+ description: The IDs of the security groups for the VMs (only in the public Cloud).
items:
type: string
type: array
SecurityGroupNames:
- description: The names of the security groups for the VMs (only in the public
- Cloud).
+ description: The names of the security groups for the VMs (only in the public Cloud).
items:
type: string
type: array
@@ -5763,8 +5325,7 @@ components:
type: string
type: array
StateReasons:
- description: The reasons explaining the current states of the VMs. This
- filter is like the `StateReasonCodes` one.
+ description: The reasons explaining the current states of the VMs. This filter is like the `StateReasonCodes` one.
items:
type: string
type: array
@@ -5789,8 +5350,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5800,8 +5360,7 @@ components:
type: string
type: array
TpmEnabled:
- description: Whether a virtual Trusted Platform Module (vTPM) is enabled
- (true) or disabled (false) on the VM.
+ description: Whether a virtual Trusted Platform Module (vTPM) is enabled (true) or disabled (false) on the VM.
type: boolean
VmIds:
description: One or more IDs of VMs.
@@ -5819,21 +5378,17 @@ components:
type: string
type: array
VmStateCodes:
- description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending),
- `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping),
- and `80` (stopped).'
+ description: 'The state codes of the VMs: `-1` (quarantine), `0` (pending), `16` (running), `32` (shutting-down), `48` (terminated), `64` (stopping), and `80` (stopped).'
items:
type: integer
type: array
VmStateNames:
- description: The state names of the VMs (`pending` \| `running` \| `stopping`
- \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+ description: The state names of the VMs (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
items:
type: string
type: array
VmTypes:
- description: The VM types (for example, t2.micro). For more information,
- see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
+ description: The VM types (for example, t2.micro). For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
items:
type: string
type: array
@@ -5868,8 +5423,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5944,8 +5498,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the VM templates, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -5965,8 +5518,7 @@ components:
description: One or more filters.
properties:
BsuOptimized:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: boolean
EphemeralsTypes:
description: The types of ephemeral storage disk.
@@ -6027,14 +5579,20 @@ components:
MaintenanceEventsNotAfter:
description: The latest date and time (UTC) the event can end.
items:
- format: date
- type: string
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
type: array
MaintenanceEventsNotBefore:
description: The earliest date and time (UTC) the event can start.
items:
- format: date
- type: string
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
type: array
SubregionNames:
description: The names of the Subregions of the VMs.
@@ -6047,8 +5605,36 @@ components:
type: string
type: array
VmStates:
- description: The states of the VMs (`pending` \| `running` \| `stopping`
- \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+ description: The states of the VMs (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+ items:
+ type: string
+ type: array
+ type: object
+ FiltersVmsStopHistory:
+ additionalProperties: false
+ description: One or more filters.
+ properties:
+ StateReasons:
+ description: The reason explaining why the VM stopped. You can filter by reason code or reason prefix (for example, `Client.ApiGracefulShutdown` or `Client.*`). For the list of reason codes, see [Creating VMs > VM State Reference](https://docs.outscale.com/en/userguide/Creating-VMs).
+ items:
+ type: string
+ type: array
+ StopDateAfter:
+ description: The date and time (UTC), or the date, after which you want to retrieve VM stops, in ISO 8601 format (for example, `2026-06-14T00:00:00.000Z` or `2026-06-14`).
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
+ StopDateBefore:
+ description: The date and time (UTC), or the date, before which you want to retrieve VM stops, in ISO 8601 format (for example, `2026-06-14T00:00:00.000Z` or `2026-06-14`).
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
+ VmIds:
+ description: The IDs of the stopped VM(s).
items:
type: string
type: array
@@ -6063,15 +5649,13 @@ components:
type: string
type: array
CreationDates:
- description: The dates and times at which the volumes were created, in ISO
- 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were created, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date-time
type: string
type: array
LinkVolumeDeleteOnVmDeletion:
- description: Whether the volumes are deleted or not when terminating the
- VMs.
+ description: Whether the volumes are deleted or not when terminating the VMs.
type: boolean
LinkVolumeDeviceNames:
description: The VM device names.
@@ -6079,15 +5663,13 @@ components:
type: string
type: array
LinkVolumeLinkDates:
- description: The dates and times at which the volumes were attached, in
- ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
+ description: The dates and times at which the volumes were attached, in ISO 8601 date-time format (for example, `2020-06-30T00:00:00.000Z`).
items:
format: date-time
type: string
type: array
LinkVolumeLinkStates:
- description: The attachment states of the volumes (`attaching` \| `detaching`
- \| `attached` \| `detached`).
+ description: The attachment states of the volumes (`attaching` \| `detaching` \| `attached` \| `detached`).
items:
type: string
type: array
@@ -6117,8 +5699,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -6133,8 +5714,7 @@ components:
type: integer
type: array
VolumeStates:
- description: The states of the volumes (`creating` \| `available` \| `in-use`
- \| `deleting` \| `error`).
+ description: The states of the volumes (`creating` \| `available` \| `in-use` \| `deleting` \| `error`).
items:
type: string
type: array
@@ -6149,8 +5729,7 @@ components:
description: One or more filters.
properties:
BgpAsns:
- description: The Border Gateway Protocol (BGP) Autonomous System Numbers
- (ASNs) of the connections.
+ description: The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
items:
type: integer
type: array
@@ -6170,16 +5749,12 @@ components:
type: string
type: array
States:
- description: The states of the VPN connections (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The states of the VPN connections (`pending` \| `available` \| `deleting` \| `deleted`).
items:
type: string
type: array
StaticRoutesOnly:
- description: If false, the VPN connection uses dynamic routing with Border
- Gateway Protocol (BGP). If true, routing is controlled using static routes.
- For more information about how to create and delete static routes, see
- [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
+ description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
type: boolean
TagKeys:
description: The keys of the tags associated with the VPN connections.
@@ -6192,8 +5767,7 @@ components:
type: string
type: array
Tags:
- description: 'The key/value combination of the tags associated with the
- VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
+ description: 'The key/value combination of the tags associated with the VPN connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.'
items:
type: string
type: array
@@ -6222,12 +5796,10 @@ components:
description: The compatible processor generation.
type: string
ModelName:
- description: The model of fGPU. For more information, see [About Flexible
- GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
+ description: The model of fGPU. For more information, see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
type: string
State:
- description: The state of the fGPU (`allocated` \| `attaching` \| `attached`
- \| `detaching`).
+ description: The state of the fGPU (`allocated` \| `attaching` \| `attached` \| `detaching`).
type: string
SubregionName:
description: The Subregion where the fGPU is located.
@@ -6235,7 +5807,7 @@ components:
Tags:
description: One or more tags associated with the fGPU.
items:
- "$ref": "#/components/schemas/Tag"
+ $ref: '#/components/schemas/Tag'
type: array
VmId:
description: The ID of the VM the fGPU is attached to, if any.
@@ -6243,8 +5815,7 @@ components:
type: object
FlexibleGpuCatalog:
additionalProperties: false
- description: Information about the flexible GPU (fGPU) that is available in
- the public catalog.
+ description: Information about the flexible GPU (fGPU) that is available in the public catalog.
properties:
Generations:
description: The processor generations that the fGPUs are compatible with.
@@ -6252,12 +5823,10 @@ components:
type: string
type: array
MaxCpu:
- description: The maximum number of VM vCores that the fGPU is compatible
- with.
+ description: The maximum number of VM vCores that the fGPU is compatible with.
type: integer
MaxRam:
- description: The maximum amount of VM memory that the fGPU is compatible
- with.
+ description: The maximum amount of VM memory that the fGPU is compatible with.
type: integer
ModelName:
description: The model of fGPU.
@@ -6271,31 +5840,25 @@ components:
description: Information about the health check configuration.
properties:
CheckInterval:
- description: The number of seconds between two requests (between `5` and
- `600` both included).
+ description: The number of seconds between two requests (between `5` and `600` both included).
type: integer
HealthyThreshold:
- description: The number of consecutive successful requests before considering
- the VM as healthy (between `2` and `10` both included).
+ description: The number of consecutive successful requests before considering the VM as healthy (between `2` and `10` both included).
type: integer
Path:
- description: If you use the HTTP or HTTPS protocols, the request URL path.
- Always starts with a slash (`/`).
+ description: If you use the HTTP or HTTPS protocols, the request URL path. Always starts with a slash (`/`).
type: string
Port:
description: The port number (between `1` and `65535`, both included).
type: integer
Protocol:
- description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP`
- \| `SSL`).
+ description: The protocol for the URL of the VM (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
type: string
Timeout:
- description: The maximum waiting time for a response before considering
- the VM as unhealthy, in seconds (between `2` and `60` both included).
+ description: The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between `2` and `60` both included).
type: integer
UnhealthyThreshold:
- description: The number of consecutive failed requests before considering
- the VM as unhealthy (between `2` and `10` both included).
+ description: The number of consecutive failed requests before considering the VM as unhealthy (between `2` and `10` both included).
type: integer
required:
- CheckInterval
@@ -6321,16 +5884,16 @@ components:
BlockDeviceMappings:
description: One or more block device mappings.
items:
- "$ref": "#/components/schemas/BlockDeviceMappingImage"
+ $ref: '#/components/schemas/BlockDeviceMappingImage'
type: array
BootModes:
description: The boot modes compatible with the OMI.
items:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
type: array
CreationDate:
description: The date and time (UTC) at which the OMI was created.
- format: date
+ format: date-time
type: string
Description:
description: The description of the OMI.
@@ -6348,7 +5911,7 @@ components:
description: The type of the OMI.
type: string
PermissionsToLaunch:
- "$ref": "#/components/schemas/PermissionsOnResource"
+ $ref: '#/components/schemas/PermissionsOnResource'
description: Permissions for the resource.
ProductCodes:
description: The product codes associated with the OMI.
@@ -6368,16 +5931,15 @@ components:
description: The state of the OMI (`pending` \| `available` \| `failed`).
type: string
StateComment:
- "$ref": "#/components/schemas/StateComment"
+ $ref: '#/components/schemas/StateComment'
description: Information about the change of state.
Tags:
description: One or more tags associated with the OMI.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TpmMandatory:
- description: If true, a virtual Trusted Platform Module (vTPM) is mandatory
- for VMs created from this OMI. If false, a vTPM is not mandatory.
+ description: If true, a virtual Trusted Platform Module (vTPM) is mandatory for VMs created from this OMI. If false, a vTPM is not mandatory.
type: boolean
type: object
ImageExportTask:
@@ -6391,19 +5953,18 @@ components:
description: The ID of the OMI to be exported.
type: string
OsuExport:
- "$ref": "#/components/schemas/OsuExportImageExportTask"
+ $ref: '#/components/schemas/OsuExportImageExportTask'
description: Information about the OMI export task.
Progress:
description: The progress of the OMI export task, as a percentage.
type: integer
State:
- description: The state of the OMI export task (`pending/queued` \| `pending`
- \| `completed` \| `failed` \| `cancelled`).
+ description: The state of the OMI export task (`pending/queued` \| `pending` \| `completed` \| `failed` \| `cancelled`).
type: string
Tags:
description: One or more tags associated with the image export task.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TaskId:
description: The ID of the OMI export task.
@@ -6414,9 +5975,7 @@ components:
description: Information about an inline policy.
properties:
Body:
- description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
Name:
description: The name of the policy.
@@ -6433,13 +5992,12 @@ components:
description: The ID of the Net attached to the internet service.
type: string
State:
- description: The state of the attachment of the internet service to the
- Net (always `available`).
+ description: The state of the attachment of the internet service to the Net (always `available`).
type: string
Tags:
description: One or more tags associated with the internet service.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
Keypair:
@@ -6447,8 +6005,7 @@ components:
description: Information about the keypair.
properties:
KeypairFingerprint:
- description: The MD5 public key fingerprint as specified in section 4 of
- RFC 4716.
+ description: The MD5 public key fingerprint as specified in section 4 of RFC 4716.
type: string
KeypairId:
description: The ID of the keypair.
@@ -6457,13 +6014,12 @@ components:
description: The name of the keypair.
type: string
KeypairType:
- description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`,
- `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
+ description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
type: string
Tags:
description: One or more tags associated with the keypair.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
KeypairCreated:
@@ -6471,8 +6027,7 @@ components:
description: Information about the created keypair.
properties:
KeypairFingerprint:
- description: The MD5 public key fingerprint, as specified in section 4 of
- RFC 4716.
+ description: The MD5 public key fingerprint, as specified in section 4 of RFC 4716.
type: string
KeypairId:
description: The ID of the keypair.
@@ -6481,26 +6036,22 @@ components:
description: The name of the keypair.
type: string
KeypairType:
- description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`,
- `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
+ description: The type of the keypair (`ssh-rsa`, `ssh-ed25519`, `ecdsa-sha2-nistp256`, `ecdsa-sha2-nistp384`, or `ecdsa-sha2-nistp521`).
type: string
PrivateKey:
- description: The private key, returned only if you are creating a keypair
- (not if you are importing). When you save this private key in a .rsa file,
- make sure you replace the `\n` escape sequences with real line breaks.
+ description: The private key, returned only if you are creating a keypair (not if you are importing). When you save this private key in a .rsa file, make sure you replace the `\n` escape sequences with real line breaks.
type: string
Tags:
description: One or more tags associated with the keypair.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
LinkFlexibleGpuRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FlexibleGpuId:
description: The ID of the fGPU you want to attach.
@@ -6516,22 +6067,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkInternetServiceRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
InternetServiceId:
description: The ID of the internet service you want to attach.
type: string
NetId:
- description: The ID of the Net to which you want to attach the internet
- service.
+ description: The ID of the Net to which you want to attach the internet service.
type: string
required:
- InternetServiceId
@@ -6541,7 +6090,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkLoadBalancerBackendMachinesRequest:
@@ -6558,8 +6107,7 @@ components:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer.
@@ -6571,19 +6119,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkManagedPolicyToUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
UserGroupName:
description: The name of the group you want to link the policy to.
@@ -6596,7 +6142,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkNic:
@@ -6607,15 +6153,13 @@ components:
description: If true, the NIC is deleted when the VM is terminated.
type: boolean
DeviceNumber:
- description: The device index for the NIC attachment (between `1` and `7`,
- both included).
+ description: The device index for the NIC attachment (between `0` and `7`, both included).
type: integer
LinkNicId:
description: The ID of the NIC to attach.
type: string
State:
- description: The state of the attachment (`attaching` \| `attached` \| `detaching`
- \| `detached`).
+ description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
type: string
VmAccountId:
description: The OUTSCALE account ID of the owner of the VM.
@@ -6632,27 +6176,23 @@ components:
description: If true, the NIC is deleted when the VM is terminated.
type: boolean
DeviceNumber:
- description: The device index for the NIC attachment (between `1` and `7`,
- both included).
+ description: The device index for the NIC attachment (between `0` and `7`, both included).
type: integer
LinkNicId:
description: The ID of the NIC to attach.
type: string
State:
- description: The state of the attachment (`attaching` \| `attached` \| `detaching`
- \| `detached`).
+ description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
type: string
type: object
LinkNicRequest:
additionalProperties: false
properties:
DeviceNumber:
- description: The index of the VM device for the NIC attachment (between
- `1` and `7`, both included).
+ description: The index of the VM device for the NIC attachment (between `1` and `7`, both included).
type: integer
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NicId:
description: The ID of the NIC you want to attach.
@@ -6672,17 +6212,15 @@ components:
description: The ID of the NIC attachment.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkNicToUpdate:
additionalProperties: false
- description: Information about the NIC attachment. If you are modifying the
- `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment.
+ description: Information about the NIC attachment. If you are modifying the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment.
properties:
DeleteOnVmDeletion:
- description: If true, the NIC is deleted when the VM is terminated. If false,
- the NIC is detached from the VM.
+ description: If true, the NIC is deleted when the VM is terminated. If false, the NIC is detached from the VM.
type: boolean
LinkNicId:
description: The ID of the NIC attachment.
@@ -6692,17 +6230,14 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
UserName:
- description: The name of the user you want to link the policy to (between
- 1 and 64 characters).
+ description: The name of the user you want to link the policy to (between 1 and 64 characters).
type: string
required:
- PolicyOrn
@@ -6712,29 +6247,23 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkPrivateIpsRequest:
additionalProperties: false
properties:
AllowRelink:
- description: If true, allows an IP that is already assigned to another NIC
- in the same Subnet to be assigned to the NIC you specified.
+ description: If true, allows an IP that is already assigned to another NIC in the same Subnet to be assigned to the NIC you specified.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NicId:
description: The ID of the NIC.
type: string
PrivateIps:
- description: The secondary private IP or IPs you want to assign to the NIC
- within the IP range of the Subnet. They cannot be one of the first four
- IPs (ending in `.0`, `.1`, `.2`, `.3`) or the last IP (ending in `.255`)
- of the Subnet, as these are reserved by 3DS OUTSCALE. For more information,
- see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
+ description: The secondary private IP or IPs you want to assign to the NIC within the IP range of the Subnet. They cannot be one of the first four IPs (ending in `.0`, `.1`, `.2`, `.3`) or the last IP (ending in `.255`) of the Subnet, as these are reserved by 3DS OUTSCALE. For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
items:
type: string
type: array
@@ -6748,7 +6277,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkPublicIp:
@@ -6756,8 +6285,7 @@ components:
description: Information about the public IP association.
properties:
LinkPublicIpId:
- description: "(Required in a Net) The ID representing the association of
- the public IP with the VM or the NIC."
+ description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC.
type: string
PublicDnsName:
description: The name of the public DNS.
@@ -6790,33 +6318,22 @@ components:
additionalProperties: false
properties:
AllowRelink:
- description: If true, allows the public IP to be associated with the VM
- or NIC that you specify even if it is already associated with another
- VM or NIC. If false, prevents the public IP from being associated with
- the VM or NIC that you specify if it is already associated with another
- VM or NIC. (By default, true in the public Cloud, false in a Net.)
+ description: If true, allows the public IP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC. If false, prevents the public IP from being associated with the VM or NIC that you specify if it is already associated with another VM or NIC. (By default, true in the public Cloud, false in a Net.)
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NicId:
- description: "(Net only) The ID of the NIC. This parameter is required if
- the VM has more than one NIC attached. Otherwise, you need to specify
- the `VmId` parameter instead. You cannot specify both parameters at the
- same time."
+ description: (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the `VmId` parameter instead. You cannot specify both parameters at the same time.
type: string
PrivateIp:
- description: "(Net only) The primary or secondary private IP of the specified
- NIC. By default, the primary private IP."
+ description: (Net only) The primary or secondary private IP of the specified NIC. By default, the primary private IP.
type: string
PublicIp:
- description: The public IP. This parameter is required unless you use the
- `PublicIpId` parameter.
+ description: The public IP. This parameter is required unless you use the `PublicIpId` parameter.
type: string
PublicIpId:
- description: The allocation ID of the public IP. This parameter is required
- unless you use the `PublicIp` parameter.
+ description: The allocation ID of the public IP. This parameter is required unless you use the `PublicIp` parameter.
type: string
VmId:
description: |-
@@ -6829,11 +6346,10 @@ components:
additionalProperties: false
properties:
LinkPublicIpId:
- description: "(Net only) The ID representing the association of the public
- IP with the VM or the NIC."
+ description: (Net only) The ID representing the association of the public IP with the VM or the NIC.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkRouteTable:
@@ -6841,30 +6357,26 @@ components:
description: One or more associations between the route table and the Subnets.
properties:
LinkRouteTableId:
- description: The ID of the association between the route table and the Net
- or Subnet.
+ description: The ID of the association between the route table and the Net or Subnet.
type: string
Main:
description: If true, the route table is the main one.
type: boolean
NetId:
- description: The ID of the Net, if the route table is not explicitly linked
- to a Subnet.
+ description: The ID of the Net, if the route table is not explicitly linked to a Subnet.
type: string
RouteTableId:
description: The ID of the route table.
type: string
SubnetId:
- description: The ID of the Subnet, if the route table is explicitly linked
- to a Subnet.
+ description: The ID of the Subnet, if the route table is explicitly linked to a Subnet.
type: string
type: object
LinkRouteTableRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
RouteTableId:
description: The ID of the route table.
@@ -6883,15 +6395,14 @@ components:
description: The ID of the association between the route table and the Subnet.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkVirtualGatewayRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net to which you want to attach the virtual gateway.
@@ -6907,24 +6418,20 @@ components:
additionalProperties: false
properties:
NetToVirtualGatewayLink:
- "$ref": "#/components/schemas/NetToVirtualGatewayLink"
+ $ref: '#/components/schemas/NetToVirtualGatewayLink'
description: Information about the attachment.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkVolumeRequest:
additionalProperties: false
properties:
DeviceName:
- description: The name of the device. For a root device, you must use `/dev/sda1`.
- For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`,
- or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`,
- and the second `X` is a letter between `a` and `z`).
+ description: The name of the device. For a root device, you must use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`, `/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between `b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmId:
description: The ID of the VM you want to attach the volume to.
@@ -6941,7 +6448,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
LinkedPolicy:
@@ -6953,13 +6460,11 @@ components:
format: date-time
type: string
LastModificationDate:
- description: The date and time (UTC) at which the linked policy was last
- modified.
+ description: The date and time (UTC) at which the linked policy was last modified.
format: date-time
type: string
Orn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
PolicyId:
description: The ID of the policy.
@@ -6973,15 +6478,13 @@ components:
description: Information about volume attachment.
properties:
DeleteOnVmDeletion:
- description: If true, the volume is deleted when terminating the VM. If
- false, the volume is not deleted when terminating the VM.
+ description: If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM.
type: boolean
DeviceName:
description: The name of the device.
type: string
State:
- description: The state of the attachment of the volume (`attaching` \| `detaching`
- \| `attached` \| `detached`).
+ description: The state of the attachment of the volume (`attaching` \| `detaching` \| `attached` \| `detached`).
type: string
VmId:
description: The ID of the VM.
@@ -6995,30 +6498,24 @@ components:
description: Information about the listener.
properties:
BackendPort:
- description: The port on which the backend VM is listening (between `1`
- and `65535`, both included).
+ description: The port on which the backend VM is listening (between `1` and `65535`, both included).
type: integer
BackendProtocol:
- description: The protocol for routing traffic to backend VMs (`HTTP` \|
- `HTTPS` \| `TCP` \| `SSL`).
+ description: The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
type: string
LoadBalancerPort:
- description: The port on which the load balancer is listening (between `1`
- and `65535`, both included).
+ description: The port on which the load balancer is listening (between `1` and `65535`, both included).
type: integer
LoadBalancerProtocol:
description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
type: string
PolicyNames:
- description: The names of the policies. If there are no policies enabled,
- the list is empty.
+ description: The names of the policies. If there are no policies enabled, the list is empty.
items:
type: string
type: array
ServerCertificateId:
- description: The OUTSCALE Resource Name (ORN) of the server certificate.
- For more information, see [Resource Identifiers > OUTSCALE Resource Names
- (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
+ description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
type: string
type: object
ListenerForCreation:
@@ -7026,16 +6523,13 @@ components:
description: Information about the listener to create.
properties:
BackendPort:
- description: The port on which the backend VM is listening (between `1`
- and `65535`, both included).
+ description: The port on which the backend VM is listening (between `1` and `65535`, both included).
type: integer
BackendProtocol:
- description: The protocol for routing traffic to backend VMs (`HTTP` \|
- `HTTPS` \| `TCP` \| `SSL`).
+ description: The protocol for routing traffic to backend VMs (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
type: string
LoadBalancerPort:
- description: The port on which the load balancer is listening (between `1`
- and `65535`, both included).
+ description: The port on which the load balancer is listening (between `1` and `65535`, both included).
type: integer
LoadBalancerProtocol:
description: The routing protocol (`HTTP` \| `HTTPS` \| `TCP` \| `SSL`).
@@ -7058,9 +6552,7 @@ components:
description: The type of action for the rule (always `forward`).
type: string
HostNamePattern:
- description: A host-name pattern for the rule, with a maximum length of
- 128 characters. This host-name pattern supports maximum three wildcards,
- and must not contain any special characters except `-.?`.
+ description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`.
type: string
ListenerId:
description: The ID of the listener.
@@ -7072,14 +6564,10 @@ components:
description: A human-readable name for the listener rule.
type: string
PathPattern:
- description: A path pattern for the rule, with a maximum length of 128 characters.
- This path pattern supports maximum three wildcards, and must not contain
- any special characters except `_-.$/~"'@:+?`.
+ description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`.
type: string
Priority:
- description: The priority level of the listener rule, between `1` and `19999`
- both included. Each rule must have a unique priority level. Otherwise,
- an error is returned.
+ description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned.
type: integer
VmIds:
description: The IDs of the backend VMs.
@@ -7095,22 +6583,16 @@ components:
description: The type of action for the rule (always `forward`).
type: string
HostNamePattern:
- description: A host-name pattern for the rule, with a maximum length of
- 128 characters. This host-name pattern supports maximum three wildcards,
- and must not contain any special characters except `-.?`.
+ description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`.
type: string
ListenerRuleName:
description: A human-readable name for the listener rule.
type: string
PathPattern:
- description: A path pattern for the rule, with a maximum length of 128 characters.
- This path pattern supports maximum three wildcards, and must not contain
- any special characters except `_-.$/~"'@:+?`.
+ description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`.
type: string
Priority:
- description: The priority level of the listener rule, between `1` and `19999`
- both included. Each rule must have a unique priority level. Otherwise,
- an error is returned.
+ description: The priority level of the listener rule, between `1` and `19999` both included. Each rule must have a unique priority level. Otherwise, an error is returned.
type: integer
required:
- ListenerRuleName
@@ -7121,12 +6603,12 @@ components:
description: Information about the load balancer.
properties:
AccessLog:
- "$ref": "#/components/schemas/AccessLog"
+ $ref: '#/components/schemas/AccessLog'
description: Information about access logs.
ApplicationStickyCookiePolicies:
description: The stickiness policies defined for the load balancer.
items:
- "$ref": "#/components/schemas/ApplicationStickyCookiePolicy"
+ $ref: '#/components/schemas/ApplicationStickyCookiePolicy'
type: array
BackendIps:
description: One or more public IPs of backend VMs.
@@ -7142,12 +6624,12 @@ components:
description: The DNS name of the load balancer.
type: string
HealthCheck:
- "$ref": "#/components/schemas/HealthCheck"
+ $ref: '#/components/schemas/HealthCheck'
description: Information about the health check configuration.
Listeners:
description: The listeners for the load balancer.
items:
- "$ref": "#/components/schemas/Listener"
+ $ref: '#/components/schemas/Listener'
type: array
LoadBalancerName:
description: The name of the load balancer.
@@ -7155,7 +6637,7 @@ components:
LoadBalancerStickyCookiePolicies:
description: The policies defined for the load balancer.
items:
- "$ref": "#/components/schemas/LoadBalancerStickyCookiePolicy"
+ $ref: '#/components/schemas/LoadBalancerStickyCookiePolicy'
type: array
LoadBalancerType:
description: |-
@@ -7166,27 +6648,29 @@ components:
NetId:
description: The ID of the Net for the load balancer.
type: string
+ PrivateIp:
+ description: The primary private IP of the load balancer.
+ nullable: true
+ type: string
PublicIp:
- description: "(internet-facing only) The public IP associated with the load
- balancer."
+ description: (internet-facing only) The public IP associated with the load balancer.
+ nullable: true
type: string
SecuredCookies:
description: Whether secure cookies are enabled for the load balancer.
type: boolean
SecurityGroups:
- description: One or more IDs of security groups for the load balancers.
- Valid only for load balancers in a Net.
+ description: One or more IDs of security groups for the load balancers. Valid only for load balancers in a Net.
items:
type: string
type: array
SourceSecurityGroup:
- "$ref": "#/components/schemas/SourceSecurityGroup"
+ $ref: '#/components/schemas/SourceSecurityGroup'
description: |-
Information about the source security group of the load balancer, which you can use as part of your inbound rules for your registered VMs.
To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.
State:
- description: The state of the load balancer (`provisioning` \| `starting`
- \| `reloading` \| `active` \| `reconfiguring` \| `deleting` \| `deleted`).
+ description: The state of the load balancer (`provisioning` \| `starting` \| `reloading` \| `active` \| `reconfiguring` \| `deleting` \| `deleted`).
type: string
Subnets:
description: The ID of the Subnet in which the load balancer was created.
@@ -7201,7 +6685,7 @@ components:
Tags:
description: One or more tags associated with the load balancer.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
LoadBalancerLight:
@@ -7212,8 +6696,7 @@ components:
description: The name of the load balancer to which the listener is attached.
type: string
LoadBalancerPort:
- description: The port of load balancer on which the load balancer is listening
- (between `1` and `65535` both included).
+ description: The port of load balancer on which the load balancer is listening (between `1` and `65535` both included).
type: integer
required:
- LoadBalancerName
@@ -7251,12 +6734,10 @@ components:
description: Information about the DirectLink location.
properties:
Code:
- description: The location code, to be set as the `Location` parameter of
- the *CreateDirectLink* method when creating a DirectLink.
+ description: The location code, to be set as the `Location` parameter of the *CreateDirectLink* method when creating a DirectLink.
type: string
Name:
- description: The name and description of the location, corresponding to
- a datacenter.
+ description: The name and description of the location, corresponding to a datacenter.
type: string
type: object
Log:
@@ -7273,8 +6754,7 @@ components:
description: The access key used for the logged call.
type: string
QueryApiName:
- description: The name of the API used by the logged call (always `oapi`
- for the OUTSCALE API).
+ description: The name of the API used by the logged call (always `oapi` for the OUTSCALE API).
type: string
QueryApiVersion:
description: The version of the API used by the logged call.
@@ -7284,14 +6764,13 @@ components:
type: string
QueryDate:
description: The date and time (UTC) of the logged call.
- format: date
+ format: date-time
type: string
QueryHeaderRaw:
description: The raw header of the HTTP request of the logged call.
type: string
QueryHeaderSize:
- description: The size of the raw header of the HTTP request of the logged
- call, in bytes.
+ description: The size of the raw header of the HTTP request of the logged call, in bytes.
type: integer
QueryIpAddress:
description: The IP used for the logged call.
@@ -7300,8 +6779,7 @@ components:
description: The raw payload of the HTTP request of the logged call.
type: string
QueryPayloadSize:
- description: The size of the raw payload of the HTTP request of the logged
- call, in bytes.
+ description: The size of the raw payload of the HTTP request of the logged call, in bytes.
type: integer
QueryUserAgent:
description: The user agent of the HTTP request of the logged call.
@@ -7346,8 +6824,7 @@ components:
description: The name of the entity.
type: string
Orn:
- description: The OUTSCALE Resource Name (ORN) of the entity. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The OUTSCALE Resource Name (ORN) of the entity. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
type: object
NatService:
@@ -7364,14 +6841,12 @@ components:
description: The ID of the Net in which the NAT service is.
type: string
PublicIps:
- description: Information about the public IP or IPs associated with the
- NAT service.
+ description: Information about the public IP or IPs associated with the NAT service.
items:
- "$ref": "#/components/schemas/PublicIpLight"
+ $ref: '#/components/schemas/PublicIpLight'
type: array
State:
- description: The state of the NAT service (`pending` \| `available` \| `deleting`
- \| `deleted`).
+ description: The state of the NAT service (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
SubnetId:
description: The ID of the Subnet in which the NAT service is.
@@ -7379,7 +6854,7 @@ components:
Tags:
description: One or more tags associated with the NAT service.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
Net:
@@ -7387,8 +6862,7 @@ components:
description: Information about the Net.
properties:
DhcpOptionsSetId:
- description: The ID of the DHCP options set (or `default` if you want to
- associate the default one).
+ description: The ID of the DHCP options set (or `default` if you want to associate the default one).
type: string
IpRange:
description: The IP range for the Net, in CIDR notation (for example, `10.0.0.0/16`).
@@ -7402,7 +6876,7 @@ components:
Tags:
description: One or more tags associated with the Net.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
Tenancy:
description: The VM tenancy in a Net.
@@ -7424,17 +6898,15 @@ components:
type: string
type: array
ServiceName:
- description: The name of the service with which the Net access point is
- associated.
+ description: The name of the service with which the Net access point is associated.
type: string
State:
- description: The state of the Net access point (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The state of the Net access point (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
Tags:
description: One or more tags associated with the Net access point.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
NetPeering:
@@ -7442,7 +6914,7 @@ components:
description: Information about the Net peering.
properties:
AccepterNet:
- "$ref": "#/components/schemas/AccepterNet"
+ $ref: '#/components/schemas/AccepterNet'
description: Information about the accepter Net.
ExpirationDate:
description: The date and time (UTC) at which the Net peerings expire.
@@ -7453,15 +6925,15 @@ components:
description: The ID of the Net peering.
type: string
SourceNet:
- "$ref": "#/components/schemas/SourceNet"
+ $ref: '#/components/schemas/SourceNet'
description: Information about the source Net.
State:
- "$ref": "#/components/schemas/NetPeeringState"
+ $ref: '#/components/schemas/NetPeeringState'
description: Information about the state of the Net peering.
Tags:
description: One or more tags associated with the Net peering.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
NetPeeringState:
@@ -7472,8 +6944,7 @@ components:
description: Additional information about the state of the Net peering.
type: string
Name:
- description: The state of the Net peering (`pending-acceptance` \| `active`
- \| `rejected` \| `failed` \| `expired` \| `deleted`).
+ description: The state of the Net peering (`pending-acceptance` \| `active` \| `rejected` \| `failed` \| `expired` \| `deleted`).
type: string
type: object
NetToVirtualGatewayLink:
@@ -7484,8 +6955,7 @@ components:
description: The ID of the Net to which the virtual gateway is attached.
type: string
State:
- description: The state of the attachment (`attaching` \| `attached` \| `detaching`
- \| `detached`).
+ description: The state of the attachment (`attaching` \| `attached` \| `detaching` \| `detached`).
type: string
type: object
Nic:
@@ -7499,14 +6969,13 @@ components:
description: The description of the NIC.
type: string
IsSourceDestChecked:
- description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled."
+ description: (Net only) If true, the source/destination check is enabled. If false, it is disabled.
type: boolean
LinkNic:
- "$ref": "#/components/schemas/LinkNic"
+ $ref: '#/components/schemas/LinkNic'
description: Information about the NIC attachment.
LinkPublicIp:
- "$ref": "#/components/schemas/LinkPublicIp"
+ $ref: '#/components/schemas/LinkPublicIp'
description: Information about the public IP association.
MacAddress:
description: The Media Access Control (MAC) address of the NIC.
@@ -7523,16 +6992,15 @@ components:
PrivateIps:
description: The private IPs of the NIC.
items:
- "$ref": "#/components/schemas/PrivateIp"
+ $ref: '#/components/schemas/PrivateIp'
type: array
SecurityGroups:
description: One or more IDs of security groups for the NIC.
items:
- "$ref": "#/components/schemas/SecurityGroupLight"
+ $ref: '#/components/schemas/SecurityGroupLight'
type: array
State:
- description: The state of the NIC (`available` \| `attaching` \| `in-use`
- \| `detaching`).
+ description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`).
type: string
SubnetId:
description: The ID of the Subnet.
@@ -7543,54 +7011,40 @@ components:
Tags:
description: One or more tags associated with the NIC.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
NicForVmCreation:
additionalProperties: false
- description: Information about the network interface card (NIC) when creating
- a virtual machine (VM).
+ description: Information about the network interface card (NIC) when creating a virtual machine (VM).
properties:
DeleteOnVmDeletion:
- description: If true, the NIC is deleted when the VM is terminated. You
- can specify this parameter only for a new NIC. To modify this value for
- an existing NIC, see [UpdateNic](#updatenic).
+ description: If true, the NIC is deleted when the VM is terminated. You can specify this parameter only for a new NIC. To modify this value for an existing NIC, see [UpdateNic](#updatenic).
type: boolean
Description:
- description: The description of the NIC, if you are creating a NIC when
- creating the VM.
+ description: The description of the NIC, if you are creating a NIC when creating the VM.
type: string
DeviceNumber:
- description: The index of the VM device for the NIC attachment (between
- `0` and `7`, both included). This parameter is required if you create
- a NIC when creating the VM.
+ description: The index of the VM device for the NIC attachment (between `0` and `7`, both included). This parameter is required if you create a NIC when creating the VM.
type: integer
NicId:
- description: The ID of the NIC, if you are attaching an existing NIC when
- creating a VM.
+ description: The ID of the NIC, if you are attaching an existing NIC when creating a VM.
type: string
PrivateIps:
- description: One or more private IPs to assign to the NIC, if you create
- a NIC when creating a VM. Only one private IP can be the primary private
- IP.
+ description: One or more private IPs to assign to the NIC, if you create a NIC when creating a VM. Only one private IP can be the primary private IP.
items:
- "$ref": "#/components/schemas/PrivateIpLight"
+ $ref: '#/components/schemas/PrivateIpLight'
type: array
SecondaryPrivateIpCount:
- description: The number of secondary private IPs, if you create a NIC when
- creating a VM. This parameter cannot be specified if you specified more
- than one private IP in the `PrivateIps` parameter.
+ description: The number of secondary private IPs, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP in the `PrivateIps` parameter.
type: integer
SecurityGroupIds:
- description: One or more IDs of security groups for the NIC, if you create
- a NIC when creating a VM.
+ description: One or more IDs of security groups for the NIC, if you create a NIC when creating a VM.
items:
type: string
type: array
SubnetId:
- description: The ID of the Subnet for the NIC, if you create a NIC when
- creating a VM. This parameter is required if you create a NIC when creating
- the VM.
+ description: The ID of the Subnet for the NIC, if you create a NIC when creating a VM. This parameter is required if you create a NIC when creating the VM.
type: string
type: object
NicLight:
@@ -7604,14 +7058,13 @@ components:
description: The description of the NIC.
type: string
IsSourceDestChecked:
- description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled."
+ description: (Net only) If true, the source/destination check is enabled. If false, it is disabled.
type: boolean
LinkNic:
- "$ref": "#/components/schemas/LinkNicLight"
+ $ref: '#/components/schemas/LinkNicLight'
description: Information about the network interface card (NIC).
LinkPublicIp:
- "$ref": "#/components/schemas/LinkPublicIpLightForVm"
+ $ref: '#/components/schemas/LinkPublicIpLightForVm'
description: Information about the public IP associated with the NIC.
MacAddress:
description: The Media Access Control (MAC) address of the NIC.
@@ -7628,16 +7081,15 @@ components:
PrivateIps:
description: The private IP or IPs of the NIC.
items:
- "$ref": "#/components/schemas/PrivateIpLightForVm"
+ $ref: '#/components/schemas/PrivateIpLightForVm'
type: array
SecurityGroups:
description: One or more IDs of security groups for the NIC.
items:
- "$ref": "#/components/schemas/SecurityGroupLight"
+ $ref: '#/components/schemas/SecurityGroupLight'
type: array
State:
- description: The state of the NIC (`available` \| `attaching` \| `in-use`
- \| `detaching`).
+ description: The state of the NIC (`available` \| `attaching` \| `in-use` \| `detaching`).
type: string
SubnetId:
description: The ID of the Subnet for the NIC.
@@ -7648,12 +7100,10 @@ components:
description: Information about the OOS API key.
properties:
ApiKeyId:
- description: The API key of the OOS account that enables you to access the
- bucket.
+ description: The API key of the OOS account that enables you to access the bucket.
type: string
SecretKey:
- description: The secret key of the OOS account that enables you to access
- the bucket.
+ description: The secret key of the OOS account that enables you to access the bucket.
type: string
type: object
OsuExportImageExportTask:
@@ -7670,8 +7120,7 @@ components:
description: The URL of the manifest file.
type: string
OsuPrefix:
- description: The prefix for the key of the OOS object corresponding to the
- image.
+ description: The prefix for the key of the OOS object corresponding to the image.
type: string
required:
- DiskImageFormat
@@ -7688,8 +7137,7 @@ components:
description: The name of the OOS bucket the snapshot is exported to.
type: string
OsuPrefix:
- description: The prefix for the key of the OOS object corresponding to the
- snapshot.
+ description: The prefix for the key of the OOS object corresponding to the snapshot.
type: string
required:
- DiskImageFormat
@@ -7703,7 +7151,7 @@ components:
description: The format of the export disk (`qcow2` \| `raw`).
type: string
OsuApiKey:
- "$ref": "#/components/schemas/OsuApiKey"
+ $ref: '#/components/schemas/OsuApiKey'
description: Information about the OOS API key.
OsuBucket:
description: The name of the OOS bucket where you want to export the object.
@@ -7723,8 +7171,7 @@ components:
description: Permissions for the resource.
properties:
AccountIds:
- description: One or more OUTSCALE account IDs that the permission is associated
- with.
+ description: One or more OUTSCALE account IDs that the permission is associated with.
items:
type: string
type: array
@@ -7742,60 +7189,50 @@ components:
Specify either the `Additions` or the `Removals` parameter.
properties:
Additions:
- "$ref": "#/components/schemas/PermissionsOnResource"
+ $ref: '#/components/schemas/PermissionsOnResource'
description: Permissions for the resource.
Removals:
- "$ref": "#/components/schemas/PermissionsOnResource"
+ $ref: '#/components/schemas/PermissionsOnResource'
description: Permissions for the resource.
type: object
Phase1Options:
additionalProperties: false
- description: This parameter is not available. It is present in our API for the
- sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
properties:
DpdTimeoutAction:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: string
DpdTimeoutSeconds:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: integer
IkeVersions:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: string
type: array
Phase1DhGroupNumbers:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: integer
type: array
Phase1EncryptionAlgorithms:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: string
type: array
Phase1IntegrityAlgorithms:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: string
type: array
Phase1LifetimeSeconds:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: integer
ReplayWindowSize:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: integer
StartupAction:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: string
type: object
Phase2Options:
@@ -7803,31 +7240,25 @@ components:
description: Information about Phase 2 of the Internet Key Exchange (IKE) negotiation.
properties:
Phase2DhGroupNumbers:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: integer
type: array
Phase2EncryptionAlgorithms:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: string
type: array
Phase2IntegrityAlgorithms:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
items:
type: string
type: array
Phase2LifetimeSeconds:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: integer
PreSharedKey:
- description: The pre-shared key to establish the initial authentication
- between the client gateway and the virtual gateway. This key can contain
- any character except line breaks and double quotes (").
+ description: The pre-shared key to establish the initial authentication between the client gateway and the virtual gateway. This key can contain any character except line breaks and double quotes (").
type: string
type: object
Placement:
@@ -7838,8 +7269,7 @@ components:
description: The name of the Subregion.
type: string
Tenancy:
- description: The tenancy of the VM (`default`, `dedicated`, or a dedicated
- group ID).
+ description: The tenancy of the VM (`default`, `dedicated`, or a dedicated group ID).
type: string
type: object
Policy:
@@ -7854,16 +7284,14 @@ components:
description: A friendly name for the policy (between 0 and 1000 characters).
type: string
IsLinkable:
- description: Indicates whether the policy can be linked to a group or an
- EIM user.
+ description: Indicates whether the policy can be linked to a group or an EIM user.
type: boolean
LastModificationDate:
description: The date and time (UTC) at which the policy was last modified.
format: date-time
type: string
Orn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
Path:
description: The path to the policy.
@@ -7888,16 +7316,15 @@ components:
Accounts:
description: The accounts linked to the specified policy.
items:
- "$ref": "#/components/schemas/MinimalPolicy"
+ $ref: '#/components/schemas/MinimalPolicy'
type: array
Groups:
description: The groups linked to the specified policy.
items:
- "$ref": "#/components/schemas/MinimalPolicy"
+ $ref: '#/components/schemas/MinimalPolicy'
type: array
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
ItemsCount:
description: The number of entities the specified policy is linked to.
@@ -7906,13 +7333,12 @@ components:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
Users:
description: The users linked to the specified policy.
items:
- "$ref": "#/components/schemas/MinimalPolicy"
+ $ref: '#/components/schemas/MinimalPolicy'
type: array
type: object
PolicyVersion:
@@ -7920,9 +7346,7 @@ components:
description: Information about the policy version.
properties:
Body:
- description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
CreationDate:
description: The date and time (UTC) at which the version was created.
@@ -7943,7 +7367,7 @@ components:
description: If true, the IP is the primary private IP of the NIC.
type: boolean
LinkPublicIp:
- "$ref": "#/components/schemas/LinkPublicIp"
+ $ref: '#/components/schemas/LinkPublicIp'
description: Information about the public IP association.
PrivateDnsName:
description: The name of the private DNS.
@@ -7960,11 +7384,7 @@ components:
description: If true, the IP is the primary private IP of the NIC.
type: boolean
PrivateIp:
- description: A private IP for the NIC. This IP must be within the IP range
- of the Subnet that you specify with the `SubnetId` parameter. However,
- it cannot be one of the first four IPs (ending in `.0`, `.1`, `.2`, `.3`)
- or the last IP (ending in `.255`) of the Subnet, as these are reserved
- by 3DS OUTSCALE. For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
+ description: A private IP for the NIC. This IP must be within the IP range of the Subnet that you specify with the `SubnetId` parameter. However, it cannot be one of the first four IPs (ending in `.0`, `.1`, `.2`, `.3`) or the last IP (ending in `.255`) of the Subnet, as these are reserved by 3DS OUTSCALE. For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).
type: string
type: object
PrivateIpLightForVm:
@@ -7975,7 +7395,7 @@ components:
description: If true, the IP is the primary private IP of the NIC.
type: boolean
LinkPublicIp:
- "$ref": "#/components/schemas/LinkPublicIpLightForVm"
+ $ref: '#/components/schemas/LinkPublicIpLightForVm'
description: Information about the public IP associated with the NIC.
PrivateDnsName:
description: The name of the private DNS.
@@ -8003,17 +7423,29 @@ components:
description: Information about the public IP.
properties:
LinkPublicIpId:
- description: "(Required in a Net) The ID representing the association of
- the public IP with the VM or the NIC."
+ description: (Required in a Net) The ID representing the association of the public IP with the VM or the NIC.
type: string
+ NatServiceId:
+ description: The ID of the NAT service associated with the public IP (if any).
+ nullable: true
+ type: string
+ NetAccessPointIds:
+ description: The IDs of the Net access points associated with the public IP (if any).
+ items:
+ type: string
+ nullable: true
+ type: array
NicAccountId:
description: The OUTSCALE account ID of the owner of the NIC.
+ nullable: true
type: string
NicId:
description: The ID of the NIC the public IP is associated with (if any).
+ nullable: true
type: string
PrivateIp:
- description: The private IP associated with the public IP.
+ description: The private IP associated with the NIC or load balancer.
+ nullable: true
type: string
PublicIp:
description: The public IP.
@@ -8024,10 +7456,11 @@ components:
Tags:
description: One or more tags associated with the public IP.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmId:
description: The ID of the VM the public IP is associated with (if any).
+ nullable: true
type: string
type: object
PublicIpLight:
@@ -8038,21 +7471,17 @@ components:
description: The public IP associated with the NAT service.
type: string
PublicIpId:
- description: The allocation ID of the public IP associated with the NAT
- service.
+ description: The allocation ID of the public IP associated with the NAT service.
type: string
type: object
PutUserGroupPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyDocument:
- description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyName:
description: The name of the policy.
@@ -8061,8 +7490,7 @@ components:
description: The name of the group.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
required:
- PolicyName
@@ -8073,20 +7501,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
PutUserPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyDocument:
- description: The policy document, corresponding to a JSON string that contains
- the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html)
- and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
+ description: The policy document, corresponding to a JSON string that contains the policy. For more information, see [EIM Reference Information](https://docs.outscale.com/en/userguide/EIM-Reference-Information.html) and [EIM Policy Generator](https://docs.outscale.com/en/userguide/EIM-Policy-Generator.html).
type: string
PolicyName:
description: The name of the policy (between 1 and 128 characters).
@@ -8103,7 +7528,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
Quota:
@@ -8117,8 +7542,7 @@ components:
description: The description of the quota.
type: string
MaxValue:
- description: The maximum value of the quota for the account (if there is
- no limit, `0`).
+ description: The maximum value of the quota for the account (if there is no limit, `0`).
type: integer
Name:
description: The unique name of the quota.
@@ -8138,31 +7562,28 @@ components:
description: One or more quotas.
properties:
QuotaType:
- description: The resource ID if it is a resource-specific quota, `global`
- if it is not.
+ description: The resource ID if it is a resource-specific quota, `global` if it is not.
type: string
Quotas:
description: One or more quotas associated with the account.
items:
- "$ref": "#/components/schemas/Quota"
+ $ref: '#/components/schemas/Quota'
type: array
type: object
ReadAccessKeysRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersAccessKeys"
+ $ref: '#/components/schemas/FiltersAccessKeys'
description: One or more filters.
Tag:
description: The tag added to the access key.
type: string
UserName:
- description: The name of the EIM user. By default, the user who sends the
- request (which can be the root user).
+ description: The name of the EIM user. By default, the user who sends the request (which can be the root user).
type: string
type: object
ReadAccessKeysResponse:
@@ -8171,18 +7592,17 @@ components:
AccessKeys:
description: A list of access keys.
items:
- "$ref": "#/components/schemas/AccessKey"
+ $ref: '#/components/schemas/AccessKey'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadAccountsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadAccountsResponse:
@@ -8191,18 +7611,17 @@ components:
Accounts:
description: The list of the accounts.
items:
- "$ref": "#/components/schemas/Account"
+ $ref: '#/components/schemas/Account'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadAdminPasswordRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmId:
description: The ID of the VM.
@@ -8214,11 +7633,10 @@ components:
additionalProperties: false
properties:
AdminPassword:
- description: The password of the VM. After the first boot, returns an empty
- string.
+ description: The password of the VM. After the first boot, returns an empty string.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmId:
description: The ID of the VM.
@@ -8228,29 +7646,27 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadApiAccessPolicyResponse:
additionalProperties: false
properties:
ApiAccessPolicy:
- "$ref": "#/components/schemas/ApiAccessPolicy"
+ $ref: '#/components/schemas/ApiAccessPolicy'
description: Information about the API access policy.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadApiAccessRulesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersApiAccessRule"
+ $ref: '#/components/schemas/FiltersApiAccessRule'
description: One or more filters.
type: object
ReadApiAccessRulesResponse:
@@ -8259,33 +7675,30 @@ components:
ApiAccessRules:
description: A list of API access rules.
items:
- "$ref": "#/components/schemas/ApiAccessRule"
+ $ref: '#/components/schemas/ApiAccessRule'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadApiLogsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersApiLog"
+ $ref: '#/components/schemas/FiltersApiLog'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
type: string
ResultsPerPage:
default: 100
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
With:
- "$ref": "#/components/schemas/With"
+ $ref: '#/components/schemas/With'
description: The information to display in each returned log.
type: object
ReadApiLogsResponse:
@@ -8294,40 +7707,36 @@ components:
Logs:
description: Information about one or more logs.
items:
- "$ref": "#/components/schemas/Log"
+ $ref: '#/components/schemas/Log'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadCO2EmissionAccountRequest:
additionalProperties: false
properties:
FromMonth:
- description: The beginning of the time period, in ISO 8601 date format (for
- example, `2020-06-01`). This value must correspond to the first day of
- the month and is included in the time period.
- format: date
- type: string
+ description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-01`). This value must correspond to the first day of the month and is included in the time period.
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
Overall:
default: false
- description: If false, returns only the CO2 emission of the specific account
- that sends the request. If true, returns either the overall CO2 emission
- of your paying account and all linked accounts (if the account that sends
- this request is a paying account) or returns nothing (if the account that
- sends this request is a linked account).
+ description: If false, returns only the CO2 emission of the specific account that sends the request. If true, returns either the overall CO2 emission of your paying account and all linked accounts (if the account that sends this request is a paying account) or returns nothing (if the account that sends this request is a linked account).
type: boolean
ToMonth:
- description: The end of the time period, in ISO 8601 date format (for example,
- `2020-06-14`). This value must correspond to the first day of the month
- and is excluded from the time period. It must be set to a later date than
- `FromMonth`.
- format: date
- type: string
+ description: The end of the time period, in ISO 8601 date format (for example, `2020-06-14`). This value must correspond to the first day of the month and is excluded from the time period. It must be set to a later date than `FromMonth`.
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
required:
- FromMonth
- ToMonth
@@ -8338,14 +7747,13 @@ components:
CO2EmissionEntries:
description: The CO2 emission by month and account, for the specified request.
items:
- "$ref": "#/components/schemas/CO2EmissionEntry"
+ $ref: '#/components/schemas/CO2EmissionEntry'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Unit:
- description: The unit of all the `Value` fields of the response, expressed
- in kgCOâ‚‚e.
+ description: The unit of all the `Value` fields of the response, expressed in kgCOâ‚‚e.
type: string
Value:
description: The total CO2 emission for the specified request.
@@ -8356,11 +7764,10 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersCa"
+ $ref: '#/components/schemas/FiltersCa'
description: One or more filters.
type: object
ReadCasResponse:
@@ -8369,39 +7776,37 @@ components:
Cas:
description: Information about one or more CAs.
items:
- "$ref": "#/components/schemas/Ca"
+ $ref: '#/components/schemas/Ca'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadCatalogRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadCatalogResponse:
additionalProperties: false
properties:
Catalog:
- "$ref": "#/components/schemas/Catalog"
+ $ref: '#/components/schemas/Catalog'
description: Information about our catalog of prices.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadCatalogsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersCatalogs"
+ $ref: '#/components/schemas/FiltersCatalogs'
description: One or more filters.
type: object
ReadCatalogsResponse:
@@ -8410,30 +7815,27 @@ components:
Catalogs:
description: Information about one or more catalogs.
items:
- "$ref": "#/components/schemas/Catalogs"
+ $ref: '#/components/schemas/Catalogs'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadClientGatewaysRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersClientGateway"
+ $ref: '#/components/schemas/FiltersClientGateway'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadClientGatewaysResponse:
@@ -8442,23 +7844,21 @@ components:
ClientGateways:
description: Information about one or more client gateways.
items:
- "$ref": "#/components/schemas/ClientGateway"
+ $ref: '#/components/schemas/ClientGateway'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadConsoleOutputRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmId:
description: The ID of the VM.
@@ -8470,11 +7870,10 @@ components:
additionalProperties: false
properties:
ConsoleOutput:
- description: The Base64-encoded output of the console. If a command line
- tool is used, the output is decoded by the tool.
+ description: The Base64-encoded output of the console. If a command line tool is used, the output is decoded by the tool.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmId:
description: The ID of the VM.
@@ -8484,42 +7883,33 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FromDate:
- description: The beginning of the time period, in ISO 8601 date format (for
- example, `2020-06-14`). The date-time format is also accepted, but only
- with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`).
- This value is included in the time period.
- format: datetime
- type: string
+ description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`). This value is included in the time period.
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
Overall:
default: false
- description: If false, returns only the consumption of the specific account
- that sends this request. If true, returns either the overall consumption
- of your paying account and all linked accounts (if the account that sends
- this request is a paying account) or returns nothing (if the account that
- sends this request is a linked account).
+ description: If false, returns only the consumption of the specific account that sends this request. If true, returns either the overall consumption of your paying account and all linked accounts (if the account that sends this request is a paying account) or returns nothing (if the account that sends this request is a linked account).
type: boolean
ShowPrice:
- description: If true, the response also includes the unit price of the consumed
- resource (`UnitPrice`) and the total price of the consumed resource during
- the specified time period (`Price`), in the currency of the Region's catalog.
+ description: If true, the response also includes the unit price of the consumed resource (`UnitPrice`) and the total price of the consumed resource during the specified time period (`Price`), in the currency of the Region's catalog.
type: boolean
ShowResourceDetails:
default: false
- description: By default or if false, returns the consumption aggregated
- by resource type. If true, the response returns the consumption per `ResourceId`.
+ description: By default or if false, returns the consumption aggregated by resource type. If true, the response returns the consumption per `ResourceId`.
type: boolean
ToDate:
- description: The end of the time period, in ISO 8601 date format (for example,
- `2020-06-30`). The date-time format is also accepted, but only with a
- time set to midnight (for example, `2020-06-30T00:00:00.000Z`). This value
- is excluded from the time period, and must be set to a later date than
- `FromDate`.
- format: datetime
- type: string
+ description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-30T00:00:00.000Z`). This value is excluded from the time period, and must be set to a later date than `FromDate`.
+ oneOf:
+ - format: date
+ type: string
+ - format: date-time
+ type: string
required:
- FromDate
- ToDate
@@ -8528,38 +7918,33 @@ components:
additionalProperties: false
properties:
ConsumptionEntries:
- description: Information about the resources consumed during the specified
- time period.
+ description: Information about the resources consumed during the specified time period.
items:
- "$ref": "#/components/schemas/ConsumptionEntry"
+ $ref: '#/components/schemas/ConsumptionEntry'
type: array
Currency:
- description: The currency of your account for the `UnitPrice` and `Price`
- parameters, in the ISO-4217 format (for example, `EUR`).
+ description: The currency of your account for the `UnitPrice` and `Price` parameters, in the ISO-4217 format (for example, `EUR`).
nullable: true
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadDedicatedGroupsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersDedicatedGroup"
+ $ref: '#/components/schemas/FiltersDedicatedGroup'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadDedicatedGroupsResponse:
@@ -8568,35 +7953,31 @@ components:
DedicatedGroups:
description: Information about one or more dedicated groups.
items:
- "$ref": "#/components/schemas/DedicatedGroup"
+ $ref: '#/components/schemas/DedicatedGroup'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadDhcpOptionsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersDhcpOptions"
+ $ref: '#/components/schemas/FiltersDhcpOptions'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadDhcpOptionsResponse:
@@ -8605,35 +7986,31 @@ components:
DhcpOptionsSets:
description: Information about one or more DHCP options sets.
items:
- "$ref": "#/components/schemas/DhcpOptionsSet"
+ $ref: '#/components/schemas/DhcpOptionsSet'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadDirectLinkInterfacesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersDirectLinkInterface"
+ $ref: '#/components/schemas/FiltersDirectLinkInterface'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadDirectLinkInterfacesResponse:
@@ -8642,35 +8019,31 @@ components:
DirectLinkInterfaces:
description: Information about one or more DirectLink interfaces.
items:
- "$ref": "#/components/schemas/DirectLinkInterfaces"
+ $ref: '#/components/schemas/DirectLinkInterfaces'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadDirectLinksRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersDirectLink"
+ $ref: '#/components/schemas/FiltersDirectLink'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadDirectLinksResponse:
@@ -8679,23 +8052,21 @@ components:
DirectLinks:
description: Information about one or more DirectLinks.
items:
- "$ref": "#/components/schemas/DirectLink"
+ $ref: '#/components/schemas/DirectLink'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadEntitiesLinkedToPolicyRequest:
additionalProperties: false
properties:
EntitiesType:
- description: The type of entity linked to the policy you want to get information
- about.
+ description: The type of entity linked to the policy you want to get information about.
items:
enum:
- ACCOUNT
@@ -8707,13 +8078,11 @@ components:
description: The item starting the list of entities requested.
type: integer
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, 100).
+ description: The maximum number of items that can be returned in a single response (by default, 100).
type: integer
required:
- PolicyOrn
@@ -8722,42 +8091,39 @@ components:
additionalProperties: false
properties:
PolicyEntities:
- "$ref": "#/components/schemas/PolicyEntities"
+ $ref: '#/components/schemas/PolicyEntities'
description: Information about the policy entities.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadFlexibleGpuCatalogRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadFlexibleGpuCatalogResponse:
additionalProperties: false
properties:
FlexibleGpuCatalog:
- description: Information about one or more fGPUs available in the public
- catalog.
+ description: Information about one or more fGPUs available in the public catalog.
items:
- "$ref": "#/components/schemas/FlexibleGpuCatalog"
+ $ref: '#/components/schemas/FlexibleGpuCatalog'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadFlexibleGpusRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersFlexibleGpu"
+ $ref: '#/components/schemas/FiltersFlexibleGpu'
description: One or more filters.
type: object
ReadFlexibleGpusResponse:
@@ -8766,30 +8132,27 @@ components:
FlexibleGpus:
description: Information about one or more fGPUs.
items:
- "$ref": "#/components/schemas/FlexibleGpu"
+ $ref: '#/components/schemas/FlexibleGpu'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadImageExportTasksRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersReadImageExportTask"
+ $ref: '#/components/schemas/FiltersReadImageExportTask'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadImageExportTasksResponse:
@@ -8798,35 +8161,31 @@ components:
ImageExportTasks:
description: Information about one or more image export tasks.
items:
- "$ref": "#/components/schemas/ImageExportTask"
+ $ref: '#/components/schemas/ImageExportTask'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadImagesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersImage"
+ $ref: '#/components/schemas/FiltersImage'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadImagesResponse:
@@ -8835,35 +8194,31 @@ components:
Images:
description: Information about one or more OMIs.
items:
- "$ref": "#/components/schemas/Image"
+ $ref: '#/components/schemas/Image'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadInternetServicesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersInternetService"
+ $ref: '#/components/schemas/FiltersInternetService'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadInternetServicesResponse:
@@ -8872,35 +8227,31 @@ components:
InternetServices:
description: Information about one or more internet services.
items:
- "$ref": "#/components/schemas/InternetService"
+ $ref: '#/components/schemas/InternetService'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadKeypairsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersKeypair"
+ $ref: '#/components/schemas/FiltersKeypair'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included). By default, `100`.
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.
type: integer
type: object
ReadKeypairsResponse:
@@ -8909,15 +8260,14 @@ components:
Keypairs:
description: Information about one or more keypairs.
items:
- "$ref": "#/components/schemas/Keypair"
+ $ref: '#/components/schemas/Keypair'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadLinkedPoliciesFilters:
@@ -8925,26 +8275,23 @@ components:
description: One or more filters.
properties:
PathPrefix:
- description: The path prefix of the policies. If not specified, it is set
- to a slash (`/`).
+ description: The path prefix of the policies. If not specified, it is set to a slash (`/`).
type: string
type: object
ReadLinkedPoliciesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/ReadLinkedPoliciesFilters"
+ $ref: '#/components/schemas/ReadLinkedPoliciesFilters'
description: One or more filters.
FirstItem:
description: The item starting the list of policies requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
UserName:
description: The name of the user the policies are linked to.
@@ -8956,34 +8303,31 @@ components:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
Policies:
description: One or more policies linked to the specified user.
items:
- "$ref": "#/components/schemas/LinkedPolicy"
+ $ref: '#/components/schemas/LinkedPolicy'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadListenerRulesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersListenerRule"
+ $ref: '#/components/schemas/FiltersListenerRule'
description: One or more filters.
type: object
ReadListenerRulesResponse:
@@ -8992,18 +8336,17 @@ components:
ListenerRules:
description: The list of the rules to describe.
items:
- "$ref": "#/components/schemas/ListenerRule"
+ $ref: '#/components/schemas/ListenerRule'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadLoadBalancerTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerNames:
description: One or more load balancer names.
@@ -9017,23 +8360,22 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Tags:
description: Information about one or more load balancer tags.
items:
- "$ref": "#/components/schemas/LoadBalancerTag"
+ $ref: '#/components/schemas/LoadBalancerTag'
type: array
type: object
ReadLoadBalancersRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersLoadBalancer"
+ $ref: '#/components/schemas/FiltersLoadBalancer'
description: One or more filters.
type: object
ReadLoadBalancersResponse:
@@ -9042,27 +8384,24 @@ components:
LoadBalancers:
description: Information about one or more load balancers.
items:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadLocationsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadLocationsResponse:
@@ -9071,33 +8410,30 @@ components:
Locations:
description: Information about one or more locations.
items:
- "$ref": "#/components/schemas/Location"
+ $ref: '#/components/schemas/Location'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadManagedPoliciesLinkedToUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersUserGroup"
+ $ref: '#/components/schemas/FiltersUserGroup'
description: One or more filters.
FirstItem:
description: The item starting the list of policies requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
UserGroupName:
description: The name of the group.
@@ -9109,43 +8445,38 @@ components:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
Policies:
description: A list of policies.
items:
- "$ref": "#/components/schemas/LinkedPolicy"
+ $ref: '#/components/schemas/LinkedPolicy'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadNatServicesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersNatService"
+ $ref: '#/components/schemas/FiltersNatService'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNatServicesResponse:
@@ -9154,72 +8485,64 @@ components:
NatServices:
description: Information about one or more NAT services.
items:
- "$ref": "#/components/schemas/NatService"
+ $ref: '#/components/schemas/NatService'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadNetAccessPointServicesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersService"
+ $ref: '#/components/schemas/FiltersService'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNetAccessPointServicesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Services:
description: The names of the services you can use for Net access points.
items:
- "$ref": "#/components/schemas/Service"
+ $ref: '#/components/schemas/Service'
type: array
type: object
ReadNetAccessPointsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersNetAccessPoint"
+ $ref: '#/components/schemas/FiltersNetAccessPoint'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNetAccessPointsResponse:
@@ -9228,35 +8551,31 @@ components:
NetAccessPoints:
description: One or more Net access points.
items:
- "$ref": "#/components/schemas/NetAccessPoint"
+ $ref: '#/components/schemas/NetAccessPoint'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadNetPeeringsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersNetPeering"
+ $ref: '#/components/schemas/FiltersNetPeering'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNetPeeringsResponse:
@@ -9265,35 +8584,31 @@ components:
NetPeerings:
description: Information about one or more Net peerings.
items:
- "$ref": "#/components/schemas/NetPeering"
+ $ref: '#/components/schemas/NetPeering'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadNetsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersNet"
+ $ref: '#/components/schemas/FiltersNet'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNetsResponse:
@@ -9302,52 +8617,47 @@ components:
Nets:
description: Information about the described Nets.
items:
- "$ref": "#/components/schemas/Net"
+ $ref: '#/components/schemas/Net'
type: array
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadNicsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersNic"
+ $ref: '#/components/schemas/FiltersNic'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadNicsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
Nics:
description: Information about one or more NICs.
items:
- "$ref": "#/components/schemas/Nic"
+ $ref: '#/components/schemas/Nic'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPoliciesFilters:
@@ -9358,13 +8668,10 @@ components:
description: If set to true, lists only the policies attached to a user.
type: boolean
PathPrefix:
- description: The path prefix you can use to filter the results. If not specified,
- it is set to a slash (`/`).
+ description: The path prefix you can use to filter the results. If not specified, it is set to a slash (`/`).
type: string
Scope:
- description: The scope of the policies. A policy can either be created by
- Outscale (`OWS`), and therefore applies to all accounts, or be created
- by its users (`LOCAL`).
+ description: The scope of the policies. A policy can either be created by Outscale (`OWS`), and therefore applies to all accounts, or be created by its users (`LOCAL`).
enum:
- LOCAL
- OWS
@@ -9374,50 +8681,45 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/ReadPoliciesFilters"
+ $ref: '#/components/schemas/ReadPoliciesFilters'
description: One or more filters.
FirstItem:
description: The item starting the list of policies requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
type: object
ReadPoliciesResponse:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
Policies:
description: Information about one or more policies.
items:
- "$ref": "#/components/schemas/Policy"
+ $ref: '#/components/schemas/Policy'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPolicyRequest:
additionalProperties: false
properties:
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
required:
- PolicyOrn
@@ -9426,19 +8728,18 @@ components:
additionalProperties: false
properties:
Policy:
- "$ref": "#/components/schemas/Policy"
+ $ref: '#/components/schemas/Policy'
description: Information about the policy.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPolicyVersionRequest:
additionalProperties: false
properties:
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
VersionId:
description: The ID of the policy version.
@@ -9451,10 +8752,10 @@ components:
additionalProperties: false
properties:
PolicyVersion:
- "$ref": "#/components/schemas/PolicyVersion"
+ $ref: '#/components/schemas/PolicyVersion'
description: Information about the policy version.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPolicyVersionsRequest:
@@ -9464,13 +8765,11 @@ components:
description: The item starting the list of policies requested.
type: integer
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
required:
- PolicyOrn
@@ -9479,8 +8778,7 @@ components:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
@@ -9488,182 +8786,163 @@ components:
PolicyVersions:
description: A list of all the versions of the policy.
items:
- "$ref": "#/components/schemas/PolicyVersion"
+ $ref: '#/components/schemas/PolicyVersion'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadProductTypesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersProductType"
+ $ref: '#/components/schemas/FiltersProductType'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadProductTypesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ProductTypes:
description: Information about one or more product types.
items:
- "$ref": "#/components/schemas/ProductType"
+ $ref: '#/components/schemas/ProductType'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPublicCatalogRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadPublicCatalogResponse:
additionalProperties: false
properties:
Catalog:
- "$ref": "#/components/schemas/Catalog"
+ $ref: '#/components/schemas/Catalog'
description: Information about our catalog of prices.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPublicIpRangesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadPublicIpRangesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
PublicIps:
- description: The list of public IPv4 addresses used in the Region, in CIDR
- notation.
+ description: The list of public IPv4 addresses used in the Region, in CIDR notation.
items:
type: string
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadPublicIpsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersPublicIp"
+ $ref: '#/components/schemas/FiltersPublicIp'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadPublicIpsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
PublicIps:
description: Information about one or more public IPs.
items:
- "$ref": "#/components/schemas/PublicIp"
+ $ref: '#/components/schemas/PublicIp'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadQuotasRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersQuota"
+ $ref: '#/components/schemas/FiltersQuota'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadQuotasResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
QuotaTypes:
description: Information about one or more quotas.
items:
- "$ref": "#/components/schemas/QuotaTypes"
+ $ref: '#/components/schemas/QuotaTypes'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadRegionsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
type: object
ReadRegionsResponse:
@@ -9672,308 +8951,276 @@ components:
Regions:
description: Information about one or more Regions.
items:
- "$ref": "#/components/schemas/Region"
+ $ref: '#/components/schemas/Region'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadRouteTablesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersRouteTable"
+ $ref: '#/components/schemas/FiltersRouteTable'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadRouteTablesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTables:
description: Information about one or more route tables.
items:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
type: array
type: object
ReadSecurityGroupsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersSecurityGroup"
+ $ref: '#/components/schemas/FiltersSecurityGroup'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadSecurityGroupsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SecurityGroups:
description: Information about one or more security groups.
items:
- "$ref": "#/components/schemas/SecurityGroup"
+ $ref: '#/components/schemas/SecurityGroup'
type: array
type: object
ReadServerCertificatesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersServerCertificate"
+ $ref: '#/components/schemas/FiltersServerCertificate'
description: One or more filters.
type: object
ReadServerCertificatesResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
ServerCertificates:
description: Information about one or more server certificates.
items:
- "$ref": "#/components/schemas/ServerCertificate"
+ $ref: '#/components/schemas/ServerCertificate'
type: array
type: object
ReadSnapshotExportTasksRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersSnapshotExportTask"
+ $ref: '#/components/schemas/FiltersSnapshotExportTask'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadSnapshotExportTasksResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
SnapshotExportTasks:
description: Information about one or more snapshot export tasks.
items:
- "$ref": "#/components/schemas/SnapshotExportTask"
+ $ref: '#/components/schemas/SnapshotExportTask'
type: array
type: object
ReadSnapshotsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersSnapshot"
+ $ref: '#/components/schemas/FiltersSnapshot'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadSnapshotsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Snapshots:
description: Information about one or more snapshots and their permissions.
items:
- "$ref": "#/components/schemas/Snapshot"
+ $ref: '#/components/schemas/Snapshot'
type: array
type: object
ReadSubnetsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersSubnet"
+ $ref: '#/components/schemas/FiltersSubnet'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadSubnetsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Subnets:
description: Information about one or more Subnets.
items:
- "$ref": "#/components/schemas/Subnet"
+ $ref: '#/components/schemas/Subnet'
type: array
type: object
ReadSubregionsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersSubregion"
+ $ref: '#/components/schemas/FiltersSubregion'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadSubregionsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Subregions:
description: Information about one or more Subregions.
items:
- "$ref": "#/components/schemas/Subregion"
+ $ref: '#/components/schemas/Subregion'
type: array
type: object
ReadTagsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersTag"
+ $ref: '#/components/schemas/FiltersTag'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadTagsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Tags:
description: Information about one or more tags.
items:
- "$ref": "#/components/schemas/Tag"
+ $ref: '#/components/schemas/Tag'
type: array
type: object
ReadUnitPriceRequest:
additionalProperties: false
properties:
Operation:
- description: The operation associated with the catalog entry (for example,
- `RunInstances-OD` or `CreateVolume`).
+ description: The operation associated with the catalog entry (for example, `RunInstances-OD` or `CreateVolume`).
type: string
Service:
- description: The service associated with the catalog entry (for example,
- `TinaOS-FCU` or `TinaOS-OOS`).
+ description: The service associated with the catalog entry (for example, `TinaOS-FCU` or `TinaOS-OOS`).
type: string
Type:
- description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1`
- or `BoxUsage:tinav6.c6r16p3`).
+ description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` or `BoxUsage:tinav6.c6r16p3`).
type: string
required:
- Operation
@@ -9984,32 +9231,29 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UnitPriceEntry:
- "$ref": "#/components/schemas/UnitPriceEntry"
+ $ref: '#/components/schemas/UnitPriceEntry'
description: Information about the unit price entry.
type: object
ReadUserGroupPoliciesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FirstItem:
description: The item starting the list of policies requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
UserGroupName:
description: The name of the group.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
required:
- UserGroupName
@@ -10018,31 +9262,28 @@ components:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
Policies:
description: A list of policies.
items:
- "$ref": "#/components/schemas/InlinePolicy"
+ $ref: '#/components/schemas/InlinePolicy'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadUserGroupPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyName:
description: The name of the policy.
@@ -10051,8 +9292,7 @@ components:
description: The name of the group.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
required:
- PolicyName
@@ -10062,22 +9302,20 @@ components:
additionalProperties: false
properties:
Policy:
- "$ref": "#/components/schemas/InlinePolicy"
+ $ref: '#/components/schemas/InlinePolicy'
description: Information about an inline policy.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Path:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserGroupName:
description: The name of the group.
@@ -10089,23 +9327,22 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserGroup:
- "$ref": "#/components/schemas/UserGroup"
+ $ref: '#/components/schemas/UserGroup'
description: Information about the user group.
Users:
description: A list of EIM users.
items:
- "$ref": "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
type: object
ReadUserGroupsPerUserRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserName:
description: The name of the user.
@@ -10120,60 +9357,55 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserGroups:
description: A list of user groups.
items:
- "$ref": "#/components/schemas/UserGroup"
+ $ref: '#/components/schemas/UserGroup'
type: array
type: object
ReadUserGroupsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersUserGroup"
+ $ref: '#/components/schemas/FiltersUserGroup'
description: One or more filters.
FirstItem:
description: The item starting the list of groups requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
type: object
ReadUserGroupsResponse:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserGroups:
description: A list of user groups.
items:
- "$ref": "#/components/schemas/UserGroup"
+ $ref: '#/components/schemas/UserGroup'
type: array
type: object
ReadUserPoliciesRequest:
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserName:
description: The name of the user.
@@ -10189,14 +9421,13 @@ components:
type: string
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadUserPolicyRequest:
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyName:
description: The name of the policy.
@@ -10217,7 +9448,7 @@ components:
description: The name of the inline policy.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserName:
description: The name of the user in which the inline policy is included.
@@ -10227,161 +9458,147 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersUsers"
+ $ref: '#/components/schemas/FiltersUsers'
description: One or more filters.
FirstItem:
description: The item starting the list of users requested.
type: integer
ResultsPerPage:
- description: The maximum number of items that can be returned in a single
- response (by default, `100`).
+ description: The maximum number of items that can be returned in a single response (by default, `100`).
type: integer
type: object
ReadUsersResponse:
additionalProperties: false
properties:
HasMoreItems:
- description: If true, there are more items to return using the `FirstItem`
- parameter in a new request.
+ description: If true, there are more items to return using the `FirstItem` parameter in a new request.
type: boolean
MaxResultsLimit:
description: Indicates maximum results defined for the operation.
type: integer
MaxResultsTruncated:
- description: If true, indicates whether requested page size is more than
- allowed.
+ description: If true, indicates whether requested page size is more than allowed.
type: boolean
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Users:
description: A list of EIM users.
items:
- "$ref": "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
type: object
ReadVirtualGatewaysRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVirtualGateway"
+ $ref: '#/components/schemas/FiltersVirtualGateway'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVirtualGatewaysResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VirtualGateways:
description: Information about one or more virtual gateways.
items:
- "$ref": "#/components/schemas/VirtualGateway"
+ $ref: '#/components/schemas/VirtualGateway'
type: array
type: object
ReadVmGroupsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVmGroup"
+ $ref: '#/components/schemas/FiltersVmGroup'
description: One or more filters.
type: object
ReadVmGroupsResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmGroups:
description: Information about one or more VM groups.
items:
- "$ref": "#/components/schemas/VmGroup"
+ $ref: '#/components/schemas/VmGroup'
type: array
type: object
ReadVmTemplatesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVmTemplate"
+ $ref: '#/components/schemas/FiltersVmTemplate'
description: One or more filters.
type: object
ReadVmTemplatesResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmTemplates:
description: Information about one or more VM templates.
items:
- "$ref": "#/components/schemas/VmTemplate"
+ $ref: '#/components/schemas/VmTemplate'
type: array
type: object
ReadVmTypesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVmType"
+ $ref: '#/components/schemas/FiltersVmType'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVmTypesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmTypes:
description: Information about one or more VM types.
items:
- "$ref": "#/components/schemas/VmType"
+ $ref: '#/components/schemas/VmType'
type: array
type: object
ReadVmsHealthRequest:
@@ -10393,8 +9610,7 @@ components:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer.
@@ -10408,47 +9624,43 @@ components:
BackendVmHealth:
description: Information about the health of one or more backend VMs.
items:
- "$ref": "#/components/schemas/BackendVmHealth"
+ $ref: '#/components/schemas/BackendVmHealth'
type: array
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ReadVmsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVm"
+ $ref: '#/components/schemas/FiltersVm'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVmsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vms:
description: Information about one or more VMs.
items:
- "$ref": "#/components/schemas/Vm"
+ $ref: '#/components/schemas/Vm'
type: array
type: object
ReadVmsStateRequest:
@@ -10456,160 +9668,172 @@ components:
properties:
AllVms:
default: false
- description: If true, includes the status of all VMs. If false, only includes
- the status of running VMs.
+ description: If true, includes the status of all VMs. If false, only includes the status of running VMs.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVmsState"
+ $ref: '#/components/schemas/FiltersVmsState'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVmsStateResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmStates:
description: Information about one or more VM states.
items:
- "$ref": "#/components/schemas/VmStates"
+ $ref: '#/components/schemas/VmStates'
+ type: array
+ type: object
+ ReadVmsStopHistoryRequest:
+ additionalProperties: false
+ properties:
+ Filters:
+ $ref: '#/components/schemas/FiltersVmsStopHistory'
+ description: One or more filters.
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers to a specific page.
+ format: byte
+ type: string
+ ResultsPerPage:
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
+ type: integer
+ type: object
+ ReadVmsStopHistoryResponse:
+ additionalProperties: false
+ properties:
+ NextPageToken:
+ description: The token to request the next page of results. Each token refers to a specific page.
+ format: byte
+ type: string
+ ResponseContext:
+ $ref: '#/components/schemas/ResponseContext'
+ description: Information about the context of the response.
+ VmsStopHistory:
+ description: Information about the VM(s) stop history.
+ items:
+ $ref: '#/components/schemas/VmsStopHistory'
type: array
type: object
ReadVolumeUpdateTasksRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersReadVolumeUpdateTask"
+ $ref: '#/components/schemas/FiltersReadVolumeUpdateTask'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included). By default, `100`.
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included). By default, `100`.
type: integer
type: object
ReadVolumeUpdateTasksResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VolumeUpdateTasks:
description: Information about one or more volume update tasks.
items:
- "$ref": "#/components/schemas/VolumeUpdateTask"
+ $ref: '#/components/schemas/VolumeUpdateTask'
type: array
type: object
ReadVolumesRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVolume"
+ $ref: '#/components/schemas/FiltersVolume'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVolumesResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Volumes:
description: Information about one or more volumes.
items:
- "$ref": "#/components/schemas/Volume"
+ $ref: '#/components/schemas/Volume'
type: array
type: object
ReadVpnConnectionsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Filters:
- "$ref": "#/components/schemas/FiltersVpnConnection"
+ $ref: '#/components/schemas/FiltersVpnConnection'
description: One or more filters.
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResultsPerPage:
- description: The maximum number of logs returned in a single response (between
- `1` and `1000`, both included).
+ description: The maximum number of logs returned in a single response (between `1` and `1000`, both included).
type: integer
type: object
ReadVpnConnectionsResponse:
additionalProperties: false
properties:
NextPageToken:
- description: The token to request the next page of results. Each token refers
- to a specific page.
+ description: The token to request the next page of results. Each token refers to a specific page.
format: byte
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VpnConnections:
description: Information about one or more VPN connections.
items:
- "$ref": "#/components/schemas/VpnConnection"
+ $ref: '#/components/schemas/VpnConnection'
type: array
type: object
RebootVmsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmIds:
description: One or more IDs of the VMs you want to reboot.
@@ -10623,7 +9847,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
Region:
@@ -10648,8 +9872,7 @@ components:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer.
@@ -10662,15 +9885,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
RejectNetPeeringRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetPeeringId:
description: The ID of the Net peering you want to reject.
@@ -10682,22 +9904,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
RemoveUserFromUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
UserGroupName:
description: The name of the group you want to remove the user from.
type: string
UserGroupPath:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserName:
description: The name of the user you want to remove from the group.
@@ -10713,7 +9933,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ResourceLoadBalancerTag:
@@ -10756,15 +9976,13 @@ components:
description: The method used to create the route.
type: string
DestinationIpRange:
- description: The IP range used for the destination match, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`).
type: string
DestinationServiceId:
description: The ID of the OUTSCALE service.
type: string
GatewayId:
- description: The ID of the internet service or virtual gateway attached
- to the Net.
+ description: The ID of the internet service or virtual gateway attached to the Net.
type: string
NatServiceId:
description: The ID of a NAT service attached to the Net.
@@ -10793,15 +10011,13 @@ components:
description: Information about the route.
properties:
DestinationIpRange:
- description: The IP range used for the destination match, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`).
type: string
RouteType:
description: The type of route (always `static`).
type: string
State:
- description: The current state of the static route (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The current state of the static route (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
type: object
RoutePropagatingVirtualGateway:
@@ -10819,7 +10035,7 @@ components:
LinkRouteTables:
description: One or more associations between the route table and Subnets.
items:
- "$ref": "#/components/schemas/LinkRouteTable"
+ $ref: '#/components/schemas/LinkRouteTable'
type: array
NetId:
description: The ID of the Net for the route table.
@@ -10827,7 +10043,7 @@ components:
RoutePropagatingVirtualGateways:
description: Information about virtual gateways propagating routes.
items:
- "$ref": "#/components/schemas/RoutePropagatingVirtualGateway"
+ $ref: '#/components/schemas/RoutePropagatingVirtualGateway'
type: array
RouteTableId:
description: The ID of the route table.
@@ -10835,20 +10051,19 @@ components:
Routes:
description: One or more routes in the route table.
items:
- "$ref": "#/components/schemas/Route"
+ $ref: '#/components/schemas/Route'
type: array
Tags:
description: One or more tags associated with the route table.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
ScaleDownVmGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmGroupId:
description: The ID of the VM group you want to scale down.
@@ -10864,15 +10079,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
ScaleUpVmGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmAddition:
description: The number of VMs you want to add to the VM group.
@@ -10888,12 +10102,11 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
SecureBootAction:
- description: One action to perform on the next boot of the VM (`enable` | `disable`
- | `setup-mode` | `none`). For more information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions).
+ description: One action to perform on the next boot of the VM (`enable` | `disable` | `setup-mode` | `none`). For more information, see [About Secure Boot](https://docs.outscale.com/en/userguide/About-Secure-Boot.html#_secure_boot_actions).
enum:
- enable
- disable
@@ -10914,7 +10127,7 @@ components:
InboundRules:
description: The inbound rules associated with the security group.
items:
- "$ref": "#/components/schemas/SecurityGroupRule"
+ $ref: '#/components/schemas/SecurityGroupRule'
type: array
NetId:
description: The ID of the Net for the security group.
@@ -10922,7 +10135,7 @@ components:
OutboundRules:
description: The outbound rules associated with the security group.
items:
- "$ref": "#/components/schemas/SecurityGroupRule"
+ $ref: '#/components/schemas/SecurityGroupRule'
type: array
SecurityGroupId:
description: The ID of the security group.
@@ -10933,7 +10146,7 @@ components:
Tags:
description: One or more tags associated with the security group.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
SecurityGroupLight:
@@ -10952,17 +10165,13 @@ components:
description: Information about the security group rule.
properties:
FromPortRange:
- description: The beginning of the port range for the TCP and UDP protocols,
- or an ICMP type number.
+ description: The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
type: integer
IpProtocol:
- description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all
- protocols). By default, `-1`. In a Net, this can also be an IP protocol
- number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
+ description: The IP protocol name (`tcp`, `udp`, `icmp`, or `-1` for all protocols). By default, `-1`. In a Net, this can also be an IP protocol number. For more information, see the [IANA.org website](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
type: string
IpRanges:
- description: One or more IP ranges for the security group rules, in CIDR
- notation (for example, `["10.0.0.0/24" , "10.0.1.0/24"]`).
+ description: One or more IP ranges for the security group rules, in CIDR notation (for example, `["10.0.0.0/24" , "10.0.1.0/24"]`).
items:
type: string
type: array
@@ -10970,20 +10179,17 @@ components:
description: The ID of the security group rule.
type: string
SecurityGroupsMembers:
- description: Information about one or more source or destination security
- groups.
+ description: Information about one or more source or destination security groups.
items:
- "$ref": "#/components/schemas/SecurityGroupsMember"
+ $ref: '#/components/schemas/SecurityGroupsMember'
type: array
ServiceIds:
- description: One or more service IDs to allow traffic from a Net to access
- the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices).
+ description: One or more service IDs to allow traffic from a Net to access the corresponding OUTSCALE services. For more information, see [ReadNetAccessPointServices](#readnetaccesspointservices).
items:
type: string
type: array
ToPortRange:
- description: The end of the port range for the TCP and UDP protocols, or
- an ICMP code number.
+ description: The end of the port range for the TCP and UDP protocols, or an ICMP code number.
type: integer
type: object
SecurityGroupsMember:
@@ -10991,16 +10197,13 @@ components:
description: Information about a source or destination security group.
properties:
AccountId:
- description: The OUTSCALE account ID that owns the source or destination
- security group.
+ description: The OUTSCALE account ID that owns the source or destination security group.
type: string
SecurityGroupId:
- description: The ID of a source or destination security group that you want
- to link to the security group of the rule.
+ description: The ID of a source or destination security group that you want to link to the security group of the rule.
type: string
SecurityGroupName:
- description: The name of a source or destination security group that you
- want to link to the security group of the rule.
+ description: The name of a source or destination security group that you want to link to the security group of the rule.
type: string
type: object
ServerCertificate:
@@ -11018,16 +10221,13 @@ components:
description: The name of the server certificate.
type: string
Orn:
- description: The OUTSCALE Resource Name (ORN) of the server certificate.
- For more information, see [Resource Identifiers > OUTSCALE Resource Names
- (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
+ description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
type: string
Path:
description: The path to the server certificate.
type: string
UploadDate:
- description: The date and time (UTC) on which the server certificate has
- been uploaded.
+ description: The date and time (UTC) on which the server certificate has been uploaded.
format: date-time
type: string
type: object
@@ -11051,9 +10251,8 @@ components:
additionalProperties: false
properties:
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
VersionId:
description: The ID of the version.
@@ -11066,9 +10265,26 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
+ ShutdownBehaviorConfiguration:
+ additionalProperties: false
+ description: Information about the actions performed by the orchestrator when the VM shuts down.
+ properties:
+ GuestAction:
+ description: The action performed by the orchestrator when the VM is shut down from the guest operating system. By default, `stop`.
+ enum:
+ - stop
+ - terminate
+ type: string
+ HostAction:
+ description: The action performed by the orchestrator when the VM is shut down due to a host infrastructure failure. By default, `restart`.
+ enum:
+ - restart
+ - stop
+ type: string
+ type: object
Snapshot:
additionalProperties: false
description: Information about the snapshot.
@@ -11084,13 +10300,13 @@ components:
type: string
CreationDate:
description: The date and time (UTC) at which the snapshot was created.
- format: datetime
+ format: date-time
type: string
Description:
description: The description of the snapshot.
type: string
PermissionsToCreateVolume:
- "$ref": "#/components/schemas/PermissionsOnResource"
+ $ref: '#/components/schemas/PermissionsOnResource'
description: Permissions for the resource.
Progress:
description: The progress of the snapshot, as a percentage.
@@ -11099,20 +10315,18 @@ components:
description: The ID of the snapshot.
type: string
State:
- description: The state of the snapshot (`in-queue` \| `pending` \| `completed`
- \| `error` \| `deleting`).
+ description: The state of the snapshot (`in-queue` \| `pending` \| `completed` \| `error` \| `deleting`).
type: string
Tags:
description: One or more tags associated with the snapshot.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VolumeId:
description: The ID of the volume used to create the snapshot.
type: string
VolumeSize:
- description: The size of the volume used to create the snapshot, in gibibytes
- (GiB).
+ description: The size of the volume used to create the snapshot, in gibibytes (GiB).
type: integer
type: object
SnapshotExportTask:
@@ -11123,7 +10337,7 @@ components:
description: If the snapshot export task fails, an error message appears.
type: string
OsuExport:
- "$ref": "#/components/schemas/OsuExportSnapshotExportTask"
+ $ref: '#/components/schemas/OsuExportSnapshotExportTask'
description: Information about the snapshot export task.
Progress:
description: The progress of the snapshot export task, as a percentage.
@@ -11132,13 +10346,12 @@ components:
description: The ID of the snapshot to be exported.
type: string
State:
- description: The state of the snapshot export task (`pending` \| `active`
- \| `completed` \| `cancelled` \| `failed`).
+ description: The state of the snapshot export task (`pending` \| `initializing` \| `preparing` \| `uploading` \| `completed` \| `cancelled` \| `failed`).
type: string
Tags:
description: One or more tags associated with the snapshot export task.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TaskId:
description: The ID of the snapshot export task.
@@ -11152,8 +10365,7 @@ components:
description: The OUTSCALE account ID of the owner of the source Net.
type: string
IpRange:
- description: The IP range for the source Net, in CIDR notation (for example,
- `10.0.0.0/16`).
+ description: The IP range for the source Net, in CIDR notation (for example, `10.0.0.0/16`).
type: string
NetId:
description: The ID of the source Net.
@@ -11176,8 +10388,7 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VmIds:
description: One or more IDs of VMs.
@@ -11191,12 +10402,12 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vms:
description: Information about one or more started VMs.
items:
- "$ref": "#/components/schemas/VmState"
+ $ref: '#/components/schemas/VmState'
type: array
type: object
StateComment:
@@ -11214,8 +10425,7 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ForceStop:
description: Forces the VM to stop.
@@ -11232,12 +10442,12 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vms:
description: Information about one or more stopped VMs.
items:
- "$ref": "#/components/schemas/VmState"
+ $ref: '#/components/schemas/VmState'
type: array
type: object
Subnet:
@@ -11248,12 +10458,10 @@ components:
description: The number of available IPs in the Subnets.
type: integer
IpRange:
- description: The IP range in the Subnet, in CIDR notation (for example,
- `10.0.0.0/16`).
+ description: The IP range in the Subnet, in CIDR notation (for example, `10.0.0.0/16`).
type: string
MapPublicIpOnLaunch:
- description: If true, a public IP is assigned to the network interface cards
- (NICs) created in the specified Subnet.
+ description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. By default, false.
type: boolean
NetId:
description: The ID of the Net in which the Subnet is.
@@ -11270,7 +10478,7 @@ components:
Tags:
description: One or more tags associated with the Subnet.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
type: object
Subregion:
@@ -11278,9 +10486,7 @@ components:
description: Information about the Subregion.
properties:
LocationCode:
- description: The location code (physical zone) of the Subregion. For more
- information, see [About Regions > Mapping Between Subregions and Physical
- Zones](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html#_mapping_between_subregions_and_physical_zones).
+ description: The location code (physical zone) of the Subregion. For more information, see [About Regions > Mapping Between Subregions and Physical Zones](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html#_mapping_between_subregions_and_physical_zones).
type: string
RegionName:
description: The name of the Region containing the Subregion.
@@ -11314,28 +10520,22 @@ components:
description: Information about the unit price entry.
properties:
Currency:
- description: The currency of your account for the `UnitPrice` parameter,
- in the ISO-4217 format (for example, `EUR`).
+ description: The currency of your account for the `UnitPrice` parameter, in the ISO-4217 format (for example, `EUR`).
type: string
Operation:
- description: The operation associated with the catalog entry (for example,
- `RunInstances-OD` or `CreateVolume`).
+ description: The operation associated with the catalog entry (for example, `RunInstances-OD` or `CreateVolume`).
type: string
Service:
- description: The service associated with the catalog entry (for example,
- `TinaOS-FCU` or `TinaOS-OOS`).
+ description: The service associated with the catalog entry (for example, `TinaOS-FCU` or `TinaOS-OOS`).
type: string
Type:
- description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1`
- or `BoxUsage:tinav6.c6r16p3`).
+ description: The type associated with the catalog entry (for example, `BSU:VolumeIOPS:io1` or `BoxUsage:tinav6.c6r16p3`).
type: string
Unit:
- description: The unit associated with the catalog entry (for example, `PER_MONTH`
- or `PER_COUNT`).
+ description: The unit associated with the catalog entry (for example, `PER_MONTH` or `PER_COUNT`).
type: string
UnitPrice:
- description: The unit price of the catalog entry in the currency of your
- account, in the ISO-4217 format (for example, `EUR`).
+ description: The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, `EUR`).
format: double
type: number
type: object
@@ -11343,8 +10543,7 @@ components:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FlexibleGpuId:
description: The ID of the fGPU you want to detach from your VM.
@@ -11356,22 +10555,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkInternetServiceRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
InternetServiceId:
description: The ID of the internet service you want to detach.
type: string
NetId:
- description: The ID of the Net from which you want to detach the internet
- service.
+ description: The ID of the Net from which you want to detach the internet service.
type: string
required:
- InternetServiceId
@@ -11381,7 +10578,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkLoadBalancerBackendMachinesRequest:
@@ -11398,8 +10595,7 @@ components:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LoadBalancerName:
description: The name of the load balancer.
@@ -11411,19 +10607,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkManagedPolicyFromUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
UserGroupName:
description: The name of the group you want to unlink the policy from.
@@ -11436,15 +10630,14 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkNicRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LinkNicId:
description: The ID of the attachment operation.
@@ -11456,20 +10649,18 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PolicyOrn:
- description: The OUTSCALE Resource Name (ORN) of the policy. For more information,
- see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
- pattern: "^orn:ows:(iam|idauth):\\S*:\\d{12}:policy/\\S+$"
+ description: The OUTSCALE Resource Name (ORN) of the policy. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ pattern: ^orn:ows:(iam|idauth):\S*:\d{12}:policy/\S+$
type: string
UserName:
description: The name of the user you want to detach the policy from.
@@ -11482,22 +10673,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkPrivateIpsRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NicId:
description: The ID of the NIC.
type: string
PrivateIps:
- description: One or more secondary private IPs you want to unassign from
- the NIC.
+ description: One or more secondary private IPs you want to unassign from the NIC.
items:
type: string
type: array
@@ -11509,39 +10698,34 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkPublicIpRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LinkPublicIpId:
- description: The ID representing the association of the public IP with the
- VM or the NIC. This parameter is required unless you use the `PublicIp`
- parameter.
+ description: The ID representing the association of the public IP with the VM or the NIC. This parameter is required unless you use the `PublicIp` parameter.
type: string
PublicIp:
- description: The public IP. This parameter is required unless you use the
- `LinkPublicIpId` parameter.
+ description: The public IP. This parameter is required unless you use the `LinkPublicIpId` parameter.
type: string
type: object
UnlinkPublicIpResponse:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkRouteTableRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LinkRouteTableId:
description: The ID of the association between the route table and the Subnet.
@@ -11553,19 +10737,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkVirtualGatewayRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
- description: The ID of the Net from which you want to detach the virtual
- gateway.
+ description: The ID of the Net from which you want to detach the virtual gateway.
type: string
VirtualGatewayId:
description: The ID of the virtual gateway.
@@ -11578,19 +10760,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UnlinkVolumeRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ForceUnlink:
- description: 'Forces the detachment of the volume in case of previous failure.
- Important: This action may damage your data or file systems.'
+ description: 'Forces the detachment of the volume in case of previous failure. Important: This action may damage your data or file systems.'
type: boolean
VolumeId:
description: The ID of the volume you want to detach.
@@ -11602,7 +10782,7 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateAccessKeyRequest:
@@ -11612,39 +10792,29 @@ components:
description: The ID of the access key.
type: string
ClearExpirationDate:
- description: If true, the current expiration date is deleted and the access
- key is set to not expire.
+ description: If true, the current expiration date is deleted and the access key is set to not expire.
type: boolean
ClearTag:
description: If true, the current tag of the access key is deleted.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ExpirationDate:
- description: The date and time, or the date, at which you want the access
- key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`
- or `2020-06-14`). If not specified, the access key is set to not expire.
- If the `ClearExpirationDate` parameter is set to true, the expiration
- date is ignored.
- format: datetime
- type: string
+ description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). If not specified, the access key is set to not expire. If the `ClearExpirationDate` parameter is set to true, the expiration date is ignored.
+ oneOf:
+ - format: date-time
+ type: string
+ - format: date
+ type: string
State:
- description: The new state for the access key (`ACTIVE` \| `INACTIVE`).
- When set to `ACTIVE`, the access key is enabled and can be used to send
- requests. When set to `INACTIVE`, the access key is disabled.
+ description: The new state for the access key (`ACTIVE` \| `INACTIVE`). When set to `ACTIVE`, the access key is enabled and can be used to send requests. When set to `INACTIVE`, the access key is disabled.
type: string
Tag:
- description: A new tag to add to the access key. If the access key already
- had a tag, this replaces it. If the `ClearTag` parameter is set to true,
- the tag is ignored.
+ description: A new tag to add to the access key. If the access key already had a tag, this replaces it. If the `ClearTag` parameter is set to true, the tag is ignored.
type: string
UserName:
- description: The name of the EIM user that the access key you want to modify
- is associated with. If you do not specify a user name, this action modifies
- the access key of the user who sends the request (which can be the root
- user).
+ description: The name of the EIM user that the access key you want to modify is associated with. If you do not specify a user name, this action modifies the access key of the user who sends the request (which can be the root user).
type: string
required:
- AccessKeyId
@@ -11653,22 +10823,19 @@ components:
additionalProperties: false
properties:
AccessKey:
- "$ref": "#/components/schemas/AccessKey"
+ $ref: '#/components/schemas/AccessKey'
description: Information about the access key.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateAccountRequest:
additionalProperties: false
properties:
AdditionalEmails:
- description: One or more additional email addresses for the account. These
- addresses are used for notifications only. If you already have a list
- of additional emails registered, you cannot add to it, only replace it.
- To remove all registered additional emails, specify an empty list.
+ description: One or more additional email addresses for the account. These addresses are used for notifications only. If you already have a list of additional emails registered, you cannot add to it, only replace it. To remove all registered additional emails, specify an empty list.
items:
- pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$"
+ pattern: ^.+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)+$
type: string
type: array
City:
@@ -11681,12 +10848,10 @@ components:
description: The new country of the account owner.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Email:
- description: The main email address for the account. This address is used
- for your credentials and notifications.
+ description: The main email address for the account. This address is used for your credentials and notifications.
type: string
FirstName:
description: The new first name of the account owner.
@@ -11710,33 +10875,27 @@ components:
description: The new value added tax (VAT) number for the account.
type: string
ZipCode:
- description: The new ZIP code of the city.
+ description: 'The new ZIP code of the city. With OSC CLI, you must wrap this value in two pairs of quotes to make sure it is parsed as a string: `--ZipCode ''"12345678"''`.'
type: string
type: object
UpdateAccountResponse:
additionalProperties: false
properties:
Account:
- "$ref": "#/components/schemas/Account"
+ $ref: '#/components/schemas/Account'
description: Information about the account.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateApiAccessPolicyRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
MaxAccessKeyExpirationSeconds:
- description: The maximum possible lifetime for your access keys, in seconds
- (between `0` and `3153600000`, both included). If set to `O`, your access
- keys can have unlimited lifetimes, but a trusted session cannot be activated.
- Otherwise, all your access keys must have an expiration date. This value
- must be greater than the remaining lifetime of each access key of your
- account.
+ description: The maximum possible lifetime for your access keys, in seconds (between `0` and `3153600000`, both included). If set to `O`, your access keys can have unlimited lifetimes, but a trusted session cannot be activated. Otherwise, all your access keys must have an expiration date. This value must be greater than the remaining lifetime of each access key of your account.
format: int64
type: integer
RequireTrustedEnv:
@@ -11752,10 +10911,10 @@ components:
additionalProperties: false
properties:
ApiAccessPolicy:
- "$ref": "#/components/schemas/ApiAccessPolicy"
+ $ref: '#/components/schemas/ApiAccessPolicy'
description: Information about the API access policy.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateApiAccessRuleRequest:
@@ -11778,8 +10937,7 @@ components:
description: A new description for the API access rule.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
IpRanges:
description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
@@ -11793,10 +10951,10 @@ components:
additionalProperties: false
properties:
ApiAccessRule:
- "$ref": "#/components/schemas/ApiAccessRule"
+ $ref: '#/components/schemas/ApiAccessRule'
description: Information about the API access rule.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateCaRequest:
@@ -11809,8 +10967,7 @@ components:
description: The description of the CA.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
required:
- CaId
@@ -11819,10 +10976,10 @@ components:
additionalProperties: false
properties:
Ca:
- "$ref": "#/components/schemas/Ca"
+ $ref: '#/components/schemas/Ca'
description: Information about the Client Certificate Authority (CA).
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateDedicatedGroupRequest:
@@ -11832,8 +10989,7 @@ components:
description: The ID of the dedicated group you want to update.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Name:
description: The new name of the dedicated group.
@@ -11846,10 +11002,10 @@ components:
additionalProperties: false
properties:
DedicatedGroup:
- "$ref": "#/components/schemas/DedicatedGroup"
+ $ref: '#/components/schemas/DedicatedGroup'
description: Information about the dedicated group.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateDirectLinkInterfaceRequest:
@@ -11859,12 +11015,10 @@ components:
description: The ID of the DirectLink interface you want to update.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Mtu:
- description: The maximum transmission unit (MTU) of the DirectLink interface,
- in bytes.
+ description: The maximum transmission unit (MTU) of the DirectLink interface, in bytes.
enum:
- 1500
type: integer
@@ -11876,10 +11030,10 @@ components:
additionalProperties: false
properties:
DirectLinkInterface:
- "$ref": "#/components/schemas/DirectLinkInterfaces"
+ $ref: '#/components/schemas/DirectLinkInterfaces'
description: Information about the DirectLink interfaces.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateFlexibleGpuRequest:
@@ -11889,8 +11043,7 @@ components:
description: If true, the fGPU is deleted when the VM is terminated.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
FlexibleGpuId:
description: The ID of the fGPU you want to modify.
@@ -11902,10 +11055,10 @@ components:
additionalProperties: false
properties:
FlexibleGpu:
- "$ref": "#/components/schemas/FlexibleGpu"
+ $ref: '#/components/schemas/FlexibleGpu'
description: Information about the flexible GPU (fGPU).
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateImageRequest:
@@ -11915,21 +11068,18 @@ components:
description: A new description for the image.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
ImageId:
description: The ID of the OMI you want to modify.
type: string
PermissionsToLaunch:
- "$ref": "#/components/schemas/PermissionsOnResourceCreation"
+ $ref: '#/components/schemas/PermissionsOnResourceCreation'
description: |-
Information about the permissions for the resource.
Specify either the `Additions` or the `Removals` parameter.
ProductCodes:
- description: The product codes associated with the OMI. Any previously set
- value is deleted. Make sure to specify all product codes you want to associate
- with the OMI.
+ description: The product codes associated with the OMI. Any previously set value is deleted. Make sure to specify all product codes you want to associate with the OMI.
items:
type: string
type: array
@@ -11940,32 +11090,27 @@ components:
additionalProperties: false
properties:
Image:
- "$ref": "#/components/schemas/Image"
+ $ref: '#/components/schemas/Image'
description: Information about the OMI.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateListenerRuleRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
HostPattern:
- description: A host-name pattern for the rule, with a maximum length of
- 128 characters. This host-name pattern supports maximum three wildcards,
- and must not contain any special characters except `-.?`.
+ description: A host-name pattern for the rule, with a maximum length of 128 characters. This host-name pattern supports maximum three wildcards, and must not contain any special characters except `-.?`.
nullable: true
type: string
ListenerRuleName:
description: The name of the listener rule.
type: string
PathPattern:
- description: A path pattern for the rule, with a maximum length of 128 characters.
- This path pattern supports maximum three wildcards, and must not contain
- any special characters except `_-.$/~"'@:+?`.
+ description: A path pattern for the rule, with a maximum length of 128 characters. This path pattern supports maximum three wildcards, and must not contain any special characters except `_-.$/~"'@:+?`.
nullable: true
type: string
required:
@@ -11975,32 +11120,29 @@ components:
additionalProperties: false
properties:
ListenerRule:
- "$ref": "#/components/schemas/ListenerRule"
+ $ref: '#/components/schemas/ListenerRule'
description: Information about the listener rule.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateLoadBalancerRequest:
additionalProperties: false
properties:
AccessLog:
- "$ref": "#/components/schemas/AccessLog"
+ $ref: '#/components/schemas/AccessLog'
description: Information about access logs.
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
HealthCheck:
- "$ref": "#/components/schemas/HealthCheck"
+ $ref: '#/components/schemas/HealthCheck'
description: Information about the health check configuration.
LoadBalancerName:
description: The name of the load balancer.
type: string
LoadBalancerPort:
- description: The port on which the load balancer is listening (between `1`
- and `65535`, both included). This parameter is required if you want to
- update the server certificate.
+ description: The port on which the load balancer is listening (between `1` and `65535`, both included). This parameter is required if you want to update the server certificate.
type: integer
PolicyNames:
description: The name of the policy you want to enable for the listener.
@@ -12008,30 +11150,18 @@ components:
type: string
type: array
PublicIp:
- description: "(internet-facing only) The public IP you want to associate
- with the load balancer. The former public IP of the load balancer is then
- disassociated. If you specify an empty string and the former public IP
- belonged to you, it is disassociated and replaced by a public IP owned
- by 3DS OUTSCALE."
+ description: (internet-facing only) The public IP you want to associate with the load balancer. The former public IP of the load balancer is then disassociated. If you specify an empty string and the former public IP belonged to you, it is disassociated and replaced by a public IP owned by 3DS OUTSCALE.
type: string
SecuredCookies:
description: If true, secure cookies are enabled for the load balancer.
type: boolean
SecurityGroups:
- description: "(Net only) One or more IDs of security groups you want to
- assign to the load balancer. You need to specify the already assigned
- security groups that you want to keep along with the new ones you are
- assigning. If the list is empty, the default security group of the Net
- is assigned to the load balancer."
+ description: (Net only) One or more IDs of security groups you want to assign to the load balancer. You need to specify the already assigned security groups that you want to keep along with the new ones you are assigning. If the list is empty, the default security group of the Net is assigned to the load balancer.
items:
type: string
type: array
ServerCertificateId:
- description: The OUTSCALE Resource Name (ORN) of the server certificate.
- For more information, see [Resource Identifiers > OUTSCALE Resource Names
- (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns).
- If this parameter is specified, you must also specify the `LoadBalancerPort`
- parameter.
+ description: The OUTSCALE Resource Name (ORN) of the server certificate. For more information, see [Resource Identifiers > OUTSCALE Resource Names (ORNs)](https://docs.outscale.com/en/userguide/Resource-Identifiers.html#_outscale_resource_names_orns). If this parameter is specified, you must also specify the `LoadBalancerPort` parameter.
type: string
required:
- LoadBalancerName
@@ -12040,31 +11170,28 @@ components:
additionalProperties: false
properties:
LoadBalancer:
- "$ref": "#/components/schemas/LoadBalancer"
+ $ref: '#/components/schemas/LoadBalancer'
description: Information about the load balancer.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateNetAccessPointRequest:
additionalProperties: false
properties:
AddRouteTableIds:
- description: One or more IDs of route tables to associate with the specified
- Net access point.
+ description: One or more IDs of route tables to associate with the specified Net access point.
items:
type: string
type: array
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetAccessPointId:
description: The ID of the Net access point.
type: string
RemoveRouteTableIds:
- description: One or more IDs of route tables to disassociate from the specified
- Net access point.
+ description: One or more IDs of route tables to disassociate from the specified Net access point.
items:
type: string
type: array
@@ -12075,22 +11202,20 @@ components:
additionalProperties: false
properties:
NetAccessPoint:
- "$ref": "#/components/schemas/NetAccessPoint"
+ $ref: '#/components/schemas/NetAccessPoint'
description: Information about the Net access point.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateNetRequest:
additionalProperties: false
properties:
DhcpOptionsSetId:
- description: The ID of the DHCP options set (or `default` if you want to
- associate the default one).
+ description: The ID of the DHCP options set (or `default` if you want to associate the default one).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NetId:
description: The ID of the Net.
@@ -12103,10 +11228,10 @@ components:
additionalProperties: false
properties:
Net:
- "$ref": "#/components/schemas/Net"
+ $ref: '#/components/schemas/Net'
description: Information about the Net.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateNicRequest:
@@ -12116,14 +11241,11 @@ components:
description: A new description for the NIC.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LinkNic:
- "$ref": "#/components/schemas/LinkNicToUpdate"
- description: Information about the NIC attachment. If you are modifying
- the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC
- attachment.
+ $ref: '#/components/schemas/LinkNicToUpdate'
+ description: Information about the NIC attachment. If you are modifying the `DeleteOnVmDeletion` attribute, you must specify the ID of the NIC attachment.
NicId:
description: The ID of the NIC you want to modify.
type: string
@@ -12141,22 +11263,20 @@ components:
additionalProperties: false
properties:
Nic:
- "$ref": "#/components/schemas/Nic"
+ $ref: '#/components/schemas/Nic'
description: Information about the NIC.
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateRoutePropagationRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Enable:
- description: If true, a virtual gateway can propagate routes to a specified
- route table of a Net. If false, the propagation is disabled.
+ description: If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
type: boolean
RouteTableId:
description: The ID of the route table.
@@ -12173,26 +11293,23 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTable:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
description: Information about the route table.
type: object
UpdateRouteRequest:
additionalProperties: false
properties:
DestinationIpRange:
- description: The IP range used for the destination match, in CIDR notation
- (for example, `10.0.0.0/24`).
+ description: The IP range used for the destination match, in CIDR notation (for example, `10.0.0.0/24`).
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
GatewayId:
- description: The ID of an internet service or virtual gateway attached to
- your Net.
+ description: The ID of an internet service or virtual gateway attached to your Net.
type: string
NatServiceId:
description: The ID of a NAT service.
@@ -12217,18 +11334,17 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
RouteTable:
- "$ref": "#/components/schemas/RouteTable"
+ $ref: '#/components/schemas/RouteTable'
description: Information about the route table.
type: object
UpdateRouteTableLinkRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
LinkRouteTableId:
description: The ID of the current route table link.
@@ -12247,15 +11363,14 @@ components:
description: The ID of the association between the route table and the Subnet.
type: string
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
type: object
UpdateServerCertificateRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Name:
description: The name of the server certificate you want to modify.
@@ -12273,21 +11388,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
ServerCertificate:
- "$ref": "#/components/schemas/ServerCertificate"
+ $ref: '#/components/schemas/ServerCertificate'
description: Information about the server certificate.
type: object
UpdateSnapshotRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
PermissionsToCreateVolume:
- "$ref": "#/components/schemas/PermissionsOnResourceCreation"
+ $ref: '#/components/schemas/PermissionsOnResourceCreation'
description: |-
Information about the permissions for the resource.
Specify either the `Additions` or the `Removals` parameter.
@@ -12302,22 +11416,20 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Snapshot:
- "$ref": "#/components/schemas/Snapshot"
+ $ref: '#/components/schemas/Snapshot'
description: Information about the snapshot.
type: object
UpdateSubnetRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
MapPublicIpOnLaunch:
- description: If true, a public IP is assigned to the network interface cards
- (NICs) created in the specified Subnet.
+ description: If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet.
type: boolean
SubnetId:
description: The ID of the Subnet.
@@ -12330,29 +11442,26 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Subnet:
- "$ref": "#/components/schemas/Subnet"
+ $ref: '#/components/schemas/Subnet'
description: Information about the Subnet.
type: object
UpdateUserGroupRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NewPath:
- description: A new path for the group. If not specified, it is set to a
- slash (`/`).
+ description: A new path for the group. If not specified, it is set to a slash (`/`).
type: string
NewUserGroupName:
description: A new name for the user group.
type: string
Path:
- description: The path to the group. If not specified, it is set to a slash
- (`/`).
+ description: The path to the group. If not specified, it is set to a slash (`/`).
type: string
UserGroupName:
description: The name of the group you want to update.
@@ -12364,23 +11473,22 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
UserGroup:
- "$ref": "#/components/schemas/UserGroup"
+ $ref: '#/components/schemas/UserGroup'
description: Information about the user group.
Users:
description: A list of EIM users.
items:
- "$ref": "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
type: object
UpdateUserRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
NewPath:
description: A new path for the EIM user.
@@ -12401,10 +11509,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
User:
- "$ref": "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
description: Information about the EIM user.
type: object
UpdateVmGroupRequest:
@@ -12414,13 +11522,12 @@ components:
description: A new description for the VM group.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Tags:
description: New tags for your VM group.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmGroupId:
description: The ID of the VM group you want to update.
@@ -12438,38 +11545,34 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmGroup:
- "$ref": "#/components/schemas/VmGroup"
+ $ref: '#/components/schemas/VmGroup'
description: Information about the VM group.
type: object
UpdateVmRequest:
additionalProperties: false
properties:
ActionsOnNextBoot:
- "$ref": "#/components/schemas/ActionsOnNextBoot"
+ $ref: '#/components/schemas/ActionsOnNextBoot'
description: The action to perform on the next boot of the VM.
BlockDeviceMappings:
description: One or more block device mappings of the VM.
items:
- "$ref": "#/components/schemas/BlockDeviceMappingVmUpdate"
+ $ref: '#/components/schemas/BlockDeviceMappingVmUpdate'
type: array
BsuOptimized:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: boolean
DeletionProtection:
- description: If true, you cannot delete the VM unless you change this parameter
- back to false.
+ description: If true, you cannot delete the VM unless you change this parameter back to false.
type: boolean
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
IsSourceDestChecked:
- description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled."
+ description: (Net only) If true, the source/destination check is enabled. If false, it is disabled.
type: boolean
KeypairName:
description: |-
@@ -12477,8 +11580,7 @@ components:
When you replace the keypair of a VM with another one, the metadata of the VM is modified to reflect the new public key, but the replacement is still not effective in the operating system of the VM. To complete the replacement and effectively apply the new keypair, you need to perform other actions inside the VM. For more information, see [Modifying the Keypair of a VM](https://docs.outscale.com/en/userguide/Modifying-the-Keypair-of-a-VM.html).
type: string
NestedVirtualization:
- description: "(dedicated tenancy only) If true, nested virtualization is
- enabled. If false, it is disabled."
+ description: (dedicated tenancy only) If true, nested virtualization is enabled. If false, it is disabled.
type: boolean
Performance:
description: The performance of the VM.
@@ -12492,17 +11594,18 @@ components:
items:
type: string
type: array
+ ShutdownBehaviorConfiguration:
+ $ref: '#/components/schemas/ShutdownBehaviorConfiguration'
+ description: Information about the actions performed by the orchestrator when the VM shuts down.
UserData:
- description: The Base64-encoded MIME user data, limited to 500 kibibytes
- (KiB).
+ description: The Base64-encoded MIME user data, limited to 500 kibibytes (KiB).
type: string
VmId:
description: The ID of the VM.
type: string
VmInitiatedShutdownBehavior:
- description: The VM behavior when you stop it. If set to `stop`, the VM
- stops. If set to `restart`, the VM stops then automatically restarts.
- If set to `terminate`, the VM stops and is terminated.
+ deprecated: true
+ description: The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is terminated.
type: string
VmType:
description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
@@ -12514,10 +11617,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Vm:
- "$ref": "#/components/schemas/Vm"
+ $ref: '#/components/schemas/Vm'
description: Information about the VM.
type: object
UpdateVmTemplateRequest:
@@ -12527,13 +11630,12 @@ components:
description: A new description for the VM template.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Tags:
description: New tags for your VM template.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmTemplateId:
description: The ID of the VM template you want to update.
@@ -12548,35 +11650,29 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VmTemplate:
- "$ref": "#/components/schemas/VmTemplate"
+ $ref: '#/components/schemas/VmTemplate'
description: Information about the VM template.
type: object
UpdateVolumeRequest:
additionalProperties: false
properties:
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
Iops:
- description: The new number of I/O operations per second (IOPS). This parameter
- can be specified only if you update an `io1` volume or if you change the
- type of the volume for an `io1`.
+ description: The new number of I/O operations per second (IOPS). This parameter can be specified only if you update an `io1` volume or if you change the type of the volume for an `io1`.
type: integer
Size:
- description: The new size of the volume, in gibibytes (GiB). This value
- must be equal to or greater than the current size of the volume. This
- modification is not instantaneous.
+ description: The new size of the volume, in gibibytes (GiB). This value must be equal to or greater than the current size of the volume. This modification is not instantaneous.
type: integer
VolumeId:
description: The ID of the volume you want to update.
type: string
VolumeType:
- description: The new type of the volume (`standard` \| `io1` \| `gp2`).
- If you update to an `io1` volume, you must also specify the `Iops` parameter.
+ description: The new type of the volume (`standard` \| `io1` \| `gp2`). If you update to an `io1` volume, you must also specify the `Iops` parameter.
type: string
required:
- VolumeId
@@ -12585,10 +11681,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
Volume:
- "$ref": "#/components/schemas/Volume"
+ $ref: '#/components/schemas/Volume'
description: Information about the volume.
type: object
UpdateVpnConnectionRequest:
@@ -12598,8 +11694,7 @@ components:
description: The ID of the client gateway.
type: string
DryRun:
- description: If true, checks whether you have the required permissions to
- perform the action.
+ description: If true, checks whether you have the required permissions to perform the action.
type: boolean
VirtualGatewayId:
description: The ID of the virtual gateway.
@@ -12608,7 +11703,7 @@ components:
description: The ID of the VPN connection you want to modify.
type: string
VpnOptions:
- "$ref": "#/components/schemas/VpnOptions"
+ $ref: '#/components/schemas/VpnOptions'
description: Information about the VPN options.
required:
- VpnConnectionId
@@ -12617,10 +11712,10 @@ components:
additionalProperties: false
properties:
ResponseContext:
- "$ref": "#/components/schemas/ResponseContext"
+ $ref: '#/components/schemas/ResponseContext'
description: Information about the context of the response.
VpnConnection:
- "$ref": "#/components/schemas/VpnConnection"
+ $ref: '#/components/schemas/VpnConnection'
description: Information about a VPN connection.
type: object
User:
@@ -12632,13 +11727,11 @@ components:
format: date-time
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the EIM
- user.
+ description: The date and time (UTC) of the last modification of the EIM user.
format: date-time
type: string
OutscaleLoginAllowed:
- description: Whether the user is allowed to log in to Cockpit v2 using its
- Outscale credentials when identity federation is activated.
+ description: Whether the user is allowed to log in to Cockpit v2 using its Outscale credentials when identity federation is activated.
type: boolean
Path:
description: The path to the EIM user.
@@ -12662,16 +11755,14 @@ components:
format: date-time
type: string
LastModificationDate:
- description: The date and time (UTC) of the last modification of the user
- group.
+ description: The date and time (UTC) of the last modification of the user group.
format: date-time
type: string
Name:
description: The name of the user group.
type: string
Orn:
- description: The Outscale Resource Name (ORN) of the user group. For more
- information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
+ description: The Outscale Resource Name (ORN) of the user group. For more information, see [Resource Identifiers](https://docs.outscale.com/en/userguide/Resource-Identifiers.html).
type: string
Path:
description: The path to the user group.
@@ -12685,12 +11776,11 @@ components:
description: Information about the current state of a VPN tunnel.
properties:
AcceptedRouteCount:
- description: The number of routes accepted through BGP (Border Gateway Protocol)
- route exchanges.
+ description: The number of routes accepted through BGP (Border Gateway Protocol) route exchanges.
type: integer
LastStateChangeDate:
description: The date and time (UTC) of the latest state update.
- format: datetime
+ format: date-time
type: string
OutsideIpAddress:
description: The IP on the OUTSCALE side of the tunnel.
@@ -12707,22 +11797,20 @@ components:
description: Information about the virtual gateway.
properties:
ConnectionType:
- description: The type of VPN connection supported by the virtual gateway
- (always `ipsec.1`).
+ description: The type of VPN connection supported by the virtual gateway (always `ipsec.1`).
type: string
NetToVirtualGatewayLinks:
description: The Net to which the virtual gateway is attached.
items:
- "$ref": "#/components/schemas/NetToVirtualGatewayLink"
+ $ref: '#/components/schemas/NetToVirtualGatewayLink'
type: array
State:
- description: The state of the virtual gateway (`pending` \| `available`
- \| `deleting` \| `deleted`).
+ description: The state of the virtual gateway (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
Tags:
description: One or more tags associated with the virtual gateway.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VirtualGatewayId:
description: The ID of the virtual gateway.
@@ -12733,7 +11821,7 @@ components:
description: Information about the VM.
properties:
ActionsOnNextBoot:
- "$ref": "#/components/schemas/ActionsOnNextBoot"
+ $ref: '#/components/schemas/ActionsOnNextBoot'
description: The action to perform on the next boot of the VM.
Architecture:
description: The architecture of the VM (`i386` \| `x86_64`).
@@ -12741,25 +11829,23 @@ components:
BlockDeviceMappings:
description: The block device mapping of the VM.
items:
- "$ref": "#/components/schemas/BlockDeviceMappingCreated"
+ $ref: '#/components/schemas/BlockDeviceMappingCreated'
type: array
BootMode:
- "$ref": "#/components/schemas/BootMode"
+ $ref: '#/components/schemas/BootMode'
description: The boot mode of the VM.
BsuOptimized:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: boolean
ClientToken:
description: The idempotency token provided when launching the VM.
type: string
CreationDate:
description: The date and time (UTC) at which the VM was created.
- format: datetime
+ format: date-time
type: string
DeletionProtection:
- description: If true, you cannot delete the VM unless you change this parameter
- back to false.
+ description: If true, you cannot delete the VM unless you change this parameter back to false.
type: boolean
Hypervisor:
description: The hypervisor type of the VMs (`ovm` \| `xen`).
@@ -12768,28 +11854,24 @@ components:
description: The ID of the OMI used to create the VM.
type: string
IsSourceDestChecked:
- description: "(Net only) If true, the source/destination check is enabled.
- If false, it is disabled."
+ description: (Net only) If true, the source/destination check is enabled. If false, it is disabled.
type: boolean
KeypairName:
description: The name of the keypair used when launching the VM.
type: string
LaunchNumber:
- description: The number for the VM when launching a group of several VMs
- (for example, `0`, `1`, `2`, and so on).
+ description: The number for the VM when launching a group of several VMs (for example, `0`, `1`, `2`, and so on).
type: integer
NestedVirtualization:
- description: If true, nested virtualization is enabled. If false, it is
- disabled.
+ description: If true, nested virtualization is enabled. If false, it is disabled.
type: boolean
NetId:
description: The ID of the Net in which the VM is running.
type: string
Nics:
- description: "(Net only) The network interface cards (NICs) the VMs are
- attached to."
+ description: (Net only) The network interface cards (NICs) the VMs are attached to.
items:
- "$ref": "#/components/schemas/NicLight"
+ $ref: '#/components/schemas/NicLight'
type: array
OsFamily:
description: Indicates the operating system (OS) of the VM.
@@ -12798,7 +11880,7 @@ components:
description: The performance of the VM.
type: string
Placement:
- "$ref": "#/components/schemas/Placement"
+ $ref: '#/components/schemas/Placement'
description: Information about the placement of the VM.
PrivateDnsName:
description: The name of the private DNS.
@@ -12807,8 +11889,7 @@ components:
description: The primary private IP of the VM.
type: string
ProductCodes:
- description: The product codes associated with the OMI used to create the
- VM.
+ description: The product codes associated with the OMI used to create the VM.
items:
type: string
type: array
@@ -12830,14 +11911,16 @@ components:
SecurityGroups:
description: One or more security groups associated with the VM.
items:
- "$ref": "#/components/schemas/SecurityGroupLight"
+ $ref: '#/components/schemas/SecurityGroupLight'
type: array
+ ShutdownBehaviorConfiguration:
+ $ref: '#/components/schemas/ShutdownBehaviorConfiguration'
+ description: Information about the actions performed by the orchestrator when the VM shuts down.
State:
- description: The state of the VM (`pending` \| `running` \| `stopping` \|
- `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+ description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
type: string
StateReason:
- description: The reason explaining the current state of the VM.
+ description: The reason explaining the current state of the VM. For more information, see [Creating VMs > VM State Reference](https://docs.outscale.com/en/userguide/Creating-VMs.html#_vm_state_reference_statereason_2).
type: string
SubnetId:
description: The ID of the Subnet for the VM.
@@ -12845,17 +11928,10 @@ components:
Tags:
description: One or more tags associated with the VM.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TpmEnabled:
- description: If true, a virtual Trusted Platform Module (vTPM) is enabled
- on the VM. If false, it is not. The default behavior for this parameter
- varies depending on the source OMI of the VM. If the `TpmMandatory`
- parameter of the source OMI is true, a vTPM has to be attached to the
- VM and it will be created by default. Setting `TpmEnabled` to false will
- cause the creation request to fail. If the `TpmMandatory` parameter
- of the source OMI is false, only setting `TpmEnabled` to true will create
- and attach a vTPM to the VM.
+ description: If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM. If false, it is not. The default behavior for this parameter varies depending on the source OMI of the VM. If the `TpmMandatory` parameter of the source OMI is true, a vTPM has to be attached to the VM and it will be created by default. Setting `TpmEnabled` to false will cause the creation request to fail. If the `TpmMandatory` parameter of the source OMI is false, only setting `TpmEnabled` to true will create and attach a vTPM to the VM.
type: boolean
UserData:
description: The Base64-encoded MIME user data.
@@ -12864,9 +11940,7 @@ components:
description: The ID of the VM.
type: string
VmInitiatedShutdownBehavior:
- description: The VM behavior when you stop it. If set to `stop`, the VM
- stops. If set to `restart`, the VM stops then automatically restarts.
- If set to `terminate`, the VM stops and is deleted.
+ description: 'The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is deleted. Important: This parameter is deprecated in favor of `ShutDownBeheviorConfiguration` and will be removed.'
type: string
VmType:
description: The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
@@ -12878,17 +11952,13 @@ components:
properties:
CreationDate:
description: The date and time (UTC) at which the VM group was created.
- format: datetime
+ format: date-time
type: string
Description:
description: The description of the VM group.
type: string
PositioningStrategy:
- description: The positioning strategy of the VMs on hypervisors. If set
- to `no-strategy`, TINA determines the most adequate position for the VMs.
- If set to `attract`, the VMs are deployed on the same hypervisor, which
- improves network performance. If set to `repulse`, the VMs are deployed
- on a different hypervisor, which improves fault tolerance.
+ description: The positioning strategy of the VMs on hypervisors. If set to `no-strategy`, TINA determines the most adequate position for the VMs. If set to `attract`, the VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, the VMs are deployed on a different hypervisor, which improves fault tolerance.
enum:
- attract
- no-strategy
@@ -12915,7 +11985,7 @@ components:
Tags:
description: One or more tags associated with the VM group.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmCount:
description: The number of VMs in the VM group.
@@ -12940,12 +12010,10 @@ components:
description: Information about the state of the VM.
properties:
CurrentState:
- description: The current state of the VM (`InService` \| `OutOfService`
- \| `Unknown`).
+ description: The current state of the VM (`InService` \| `OutOfService` \| `Unknown`).
type: string
PreviousState:
- description: The previous state of the VM (`InService` \| `OutOfService`
- \| `Unknown`).
+ description: The previous state of the VM (`InService` \| `OutOfService` \| `Unknown`).
type: string
VmId:
description: The ID of the VM.
@@ -12958,7 +12026,7 @@ components:
MaintenanceEvents:
description: One or more scheduled events associated with the VM.
items:
- "$ref": "#/components/schemas/MaintenanceEvent"
+ $ref: '#/components/schemas/MaintenanceEvent'
type: array
SubregionName:
description: The name of the Subregion of the VM.
@@ -12967,8 +12035,7 @@ components:
description: The ID of the VM.
type: string
VmState:
- description: The state of the VM (`pending` \| `running` \| `stopping` \|
- `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
+ description: The state of the VM (`pending` \| `running` \| `stopping` \| `stopped` \| `shutting-down` \| `terminated` \| `quarantine`).
type: string
type: object
VmTemplate:
@@ -13007,7 +12074,7 @@ components:
Tags:
description: One or more tags associated with the VM template.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VmTemplateId:
description: The ID of the VM template.
@@ -13028,8 +12095,7 @@ components:
description: Information about the VM type.
properties:
BsuOptimized:
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
type: boolean
EphemeralsType:
description: The type of ephemeral storage disk.
@@ -13041,8 +12107,7 @@ components:
description: The number of GPU available.
type: integer
MaxPrivateIps:
- description: The maximum number of private IPs per network interface card
- (NIC).
+ description: The maximum number of private IPs per network interface card (NIC).
type: integer
MemorySize:
description: The amount of memory, in gibibytes.
@@ -13061,6 +12126,21 @@ components:
description: The size of one ephemeral storage disk, in gibibytes (GiB).
type: integer
type: object
+ VmsStopHistory:
+ additionalProperties: false
+ description: Information about the stop history of one or more VMs.
+ properties:
+ StateReason:
+ description: The reason explaining why the VM stopped. For more information, see [Creating VMs > VM State Reference](https://docs.outscale.com/en/userguide/Creating-VMs.html#_vm_state_reference_statereason_2).
+ type: string
+ StopDate:
+ description: The date and time (UTC) of the stop event.
+ format: date-time
+ type: string
+ VmId:
+ description: The ID of the VM.
+ type: string
+ type: object
Volume:
additionalProperties: false
description: Information about the volume.
@@ -13070,7 +12150,7 @@ components:
type: string
CreationDate:
description: The date and time (UTC) at which the volume was created.
- format: datetime
+ format: date-time
type: string
Iops:
description: |-
@@ -13081,7 +12161,7 @@ components:
LinkedVolumes:
description: Information about your volume attachment.
items:
- "$ref": "#/components/schemas/LinkedVolume"
+ $ref: '#/components/schemas/LinkedVolume'
type: array
Size:
description: The size of the volume, in gibibytes (GiB).
@@ -13090,8 +12170,7 @@ components:
description: The snapshot from which the volume was created.
type: string
State:
- description: The state of the volume (`creating` \| `available` \| `in-use`
- \| `deleting` \| `error`).
+ description: The state of the volume (`creating` \| `available` \| `in-use` \| `deleting` \| `error`).
type: string
SubregionName:
description: The Subregion in which the volume was created.
@@ -13099,11 +12178,10 @@ components:
Tags:
description: One or more tags associated with the volume.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TaskId:
- description: The ID of the volume update task in progress. Otherwise, it
- is not returned.
+ description: The ID of the volume update task in progress. Otherwise, it is not returned.
nullable: true
type: string
VolumeId:
@@ -13118,10 +12196,10 @@ components:
description: Information about the update of a volume.
properties:
Origin:
- "$ref": "#/components/schemas/VolumeUpdateParameters"
+ $ref: '#/components/schemas/VolumeUpdateParameters'
description: Information about the parameters of the update of a volume.
Target:
- "$ref": "#/components/schemas/VolumeUpdateParameters"
+ $ref: '#/components/schemas/VolumeUpdateParameters'
description: Information about the parameters of the update of a volume.
type: object
VolumeUpdateParameters:
@@ -13170,18 +12248,16 @@ components:
format: date-time
type: string
State:
- description: The state of the volume (`pending` \| `active` \| `completed`
- \| `failed` \| `canceled`).
+ description: The state of the volume (`pending` \| `active` \| `completed` \| `failed` \| `canceled`).
example: completed
type: string
Tags:
description: One or more tags associated with the volume update task.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
TaskId:
- description: The ID of the volume update task in progress. Otherwise, it
- is not returned.
+ description: The ID of the volume update task in progress. Otherwise, it is not returned.
example: vol-update-12345678
type: string
VolumeId:
@@ -13189,7 +12265,7 @@ components:
example: vol-12345678
type: string
VolumeUpdate:
- "$ref": "#/components/schemas/VolumeUpdate"
+ $ref: '#/components/schemas/VolumeUpdate'
description: Information about the update of a volume.
type: object
VpnConnection:
@@ -13200,48 +12276,40 @@ components:
description: Example configuration for the client gateway.
type: string
ClientGatewayId:
- description: The ID of the client gateway used on the client end of the
- connection.
+ description: The ID of the client gateway used on the client end of the connection.
type: string
ConnectionType:
description: The type of VPN connection (always `ipsec.1`).
type: string
Routes:
- description: Information about one or more static routes associated with
- the VPN connection, if any.
+ description: Information about one or more static routes associated with the VPN connection, if any.
items:
- "$ref": "#/components/schemas/RouteLight"
+ $ref: '#/components/schemas/RouteLight'
type: array
State:
- description: The state of the VPN connection (`pending` \| `available` \|
- `deleting` \| `deleted`).
+ description: The state of the VPN connection (`pending` \| `available` \| `deleting` \| `deleted`).
type: string
StaticRoutesOnly:
- description: If false, the VPN connection uses dynamic routing with Border
- Gateway Protocol (BGP). If true, routing is controlled using static routes.
- For more information about how to create and delete static routes, see
- [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
+ description: If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see [CreateVpnConnectionRoute](#createvpnconnectionroute) and [DeleteVpnConnectionRoute](#deletevpnconnectionroute).
type: boolean
Tags:
description: One or more tags associated with the VPN connection.
items:
- "$ref": "#/components/schemas/ResourceTag"
+ $ref: '#/components/schemas/ResourceTag'
type: array
VgwTelemetries:
- description: Information about the current state of one or more of the VPN
- tunnels.
+ description: Information about the current state of one or more of the VPN tunnels.
items:
- "$ref": "#/components/schemas/VgwTelemetry"
+ $ref: '#/components/schemas/VgwTelemetry'
type: array
VirtualGatewayId:
- description: The ID of the virtual gateway used on the OUTSCALE end of the
- connection.
+ description: The ID of the virtual gateway used on the OUTSCALE end of the connection.
type: string
VpnConnectionId:
description: The ID of the VPN connection.
type: string
VpnOptions:
- "$ref": "#/components/schemas/VpnOptions"
+ $ref: '#/components/schemas/VpnOptions'
description: Information about the VPN options.
type: object
VpnOptions:
@@ -13249,16 +12317,13 @@ components:
description: Information about the VPN options.
properties:
Phase1Options:
- "$ref": "#/components/schemas/Phase1Options"
- description: This parameter is not available. It is present in our API for
- the sake of historical compatibility with AWS.
+ $ref: '#/components/schemas/Phase1Options'
+ description: This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
Phase2Options:
- "$ref": "#/components/schemas/Phase2Options"
- description: Information about Phase 2 of the Internet Key Exchange (IKE)
- negotiation.
+ $ref: '#/components/schemas/Phase2Options'
+ description: Information about Phase 2 of the Internet Key Exchange (IKE) negotiation.
TunnelInsideIpRange:
- description: The range of inside IPs for the tunnel. This must be a /30
- CIDR block from the 169.254.254.0/24 range.
+ description: The range of inside IPs for the tunnel. This must be a /30 CIDR block from the 169.254.254.0/24 range.
type: string
type: object
With:
@@ -13299,8 +12364,7 @@ components:
type: boolean
QueryHeaderSize:
default: true
- description: If true, the size of the raw header of the HTTP request is
- displayed.
+ description: If true, the size of the raw header of the HTTP request is displayed.
type: boolean
QueryIpAddress:
default: true
@@ -13312,8 +12376,7 @@ components:
type: boolean
QueryPayloadSize:
default: true
- description: If true, the size of the raw payload of the HTTP request is
- displayed.
+ description: If true, the size of the raw payload of the HTTP request is displayed.
type: boolean
QueryUserAgent:
default: true
@@ -13373,11 +12436,11 @@ info:
The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).
In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.
- > For example, if you use OSC CLI:
- > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account.
- > 2. You then specify the `--profile` option when executing OSC CLI commands.
+ > For example, to authenticate with access key/secret key when using octl:
+ > * You can specify the following environment variables: `OSC_ACCESS_KEY`, `OSC_SECRET_KEY`, and `OSC_REGION`.
+ > * Or you can store a profile in a **~/.osc/config.json** file, with the following fields specified: `access_key`, `secret_key`, and `region`. Then you select the profile by specifying the `--profile` option when executing octl commands.
>
- > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).
+ > For more information, see [Installing and Configuring octl](https://docs.outscale.com/en/userguide/Installing-and-Configuring-octl.html).
See the code samples in each section of this documentation for specific examples in different programming languages.
For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).
@@ -13389,9 +12452,11 @@ info:
This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.
In most cases, however, you can use the Cockpit web interface to retrieve them.
- > For example, if you use OSC CLI:
- > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`).
- > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands.
+ > For example, to authenticate with login/password when using octl:
+ > * You can specify the following environment variables: `OSC_LOGIN`, `OSC_PASSWORD`, and `OSC_REGION`.
+ > * Or you can store a profile in a **~/.osc/config.json** file, with the following fields specified: `login`, `password`, and `region`. Then you select the profile by specifying the `--profile` option when executing octl commands.
+ >
+ > For more information, see [Installing and Configuring octl](https://docs.outscale.com/en/userguide/Installing-and-Configuring-octl.html).
See the code samples in each section of this documentation for specific examples in different programming languages.
@@ -13411,16 +12476,16 @@ info:
url: https://opensource.org/licenses/BSD-3-Clause
termsOfService: https://en.outscale.com/terms-of-service/
title: 3DS OUTSCALE API
- version: 1.40.1
- x-osc-api-osc-billing: 1.38.0
+ version: 1.42.0
+ x-osc-api-osc-billing: 1.39.0
x-osc-api-osc-cloud-region: 1.37.0
- x-osc-api-osc-cloud-vision: 1.36.0
- x-osc-api-osc-core-iaas: 1.38.1
- x-osc-api-osc-iam: 1.37.5
+ x-osc-api-osc-cloud-vision: 1.37.0
+ x-osc-api-osc-core-iaas: 1.40.0
+ x-osc-api-osc-iam: 1.37.6
x-osc-api-type: external
openapi: 3.0.0
paths:
- "/AcceptNetPeering":
+ /AcceptNetPeering:
post:
description: |-
Accepts a Net peering request.
@@ -13433,7 +12498,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/AcceptNetPeeringRequest"
+ $ref: '#/components/schemas/AcceptNetPeeringRequest'
examples:
ex1:
value:
@@ -13443,7 +12508,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/AcceptNetPeeringResponse"
+ $ref: '#/components/schemas/AcceptNetPeeringResponse'
examples:
ex1:
value:
@@ -13469,29 +12534,29 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'409':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 409 response (Conflict).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
- "/AddUserToUserGroup":
+ /AddUserToUserGroup:
post:
description: Adds a user to a specified group.
operationId: AddUserToUserGroup
@@ -13499,20 +12564,20 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/AddUserToUserGroupRequest"
+ $ref: '#/components/schemas/AddUserToUserGroupRequest'
examples:
ex1:
value:
UserGroupName: example-usergroup
- UserGroupPath: "/example/"
+ UserGroupPath: /example/
UserName: example-user
- UserPath: "/example/"
+ UserPath: /example/
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/AddUserToUserGroupResponse"
+ $ref: '#/components/schemas/AddUserToUserGroupResponse'
examples:
ex1:
value:
@@ -13521,7 +12586,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- UserGroup
- "/CheckAuthentication":
+ /CheckAuthentication:
post:
description: Validates the authenticity of the OUTSCALE account.
operationId: CheckAuthentication
@@ -13529,18 +12594,18 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CheckAuthenticationRequest"
+ $ref: '#/components/schemas/CheckAuthenticationRequest'
examples:
ex1:
value:
Login: example@example.com
- Password: "$OSC_PASSWORD"
+ Password: $OSC_PASSWORD
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/CheckAuthenticationResponse"
+ $ref: '#/components/schemas/CheckAuthenticationResponse'
examples:
ex1:
value:
@@ -13549,7 +12614,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/CreateAccessKey":
+ /CreateAccessKey:
post:
description: |-
Creates an access key for either the root user or an EIM user. The new key is automatically set to `ACTIVE`.
**[IMPORTANT]**
* You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.
- * If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`).
For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-OUTSCALE-Account.html).
operationId: CreateAccount
@@ -13606,7 +12670,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateAccountRequest"
+ $ref: '#/components/schemas/CreateAccountRequest'
examples:
ex1:
value:
@@ -13623,7 +12687,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateAccountResponse"
+ $ref: '#/components/schemas/CreateAccountResponse'
examples:
ex1:
value:
@@ -13641,7 +12705,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/CreateApiAccessRule":
+ /CreateApiAccessRule:
post:
description: |-
Creates a rule to allow access to the API from your OUTSCALE account.
@@ -13655,7 +12719,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateApiAccessRuleRequest"
+ $ref: '#/components/schemas/CreateApiAccessRuleRequest'
examples:
ex1:
summary: Creating an API access rule based on IPs
@@ -13665,8 +12729,7 @@ paths:
- 198.51.100.0/24
Description: Basic API Access Rule with IPs
ex2:
- summary: Creating an API access rule based on IPs and Certificate
- Authority (CA)
+ summary: Creating an API access rule based on IPs and Certificate Authority (CA)
value:
IpRanges:
- 192.0.2.0
@@ -13679,7 +12742,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateApiAccessRuleResponse"
+ $ref: '#/components/schemas/CreateApiAccessRuleResponse'
examples:
ex1:
summary: Creating an API access rule based on IPs
@@ -13695,8 +12758,7 @@ paths:
Cns: []
Description: Basic API Access Rule with IPs
ex2:
- summary: Creating an API access rule based on IPs and Certificate
- Authority (CA)
+ summary: Creating an API access rule based on IPs and Certificate Authority (CA)
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
@@ -13715,7 +12777,7 @@ paths:
- BasicAuth: []
tags:
- ApiAccessRule
- "/CreateCa":
+ /CreateCa:
post:
description: |-
Creates a Client Certificate Authority (CA).
@@ -14702,7 +13763,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerListenersRequest"
+ $ref: '#/components/schemas/CreateLoadBalancerListenersRequest'
examples:
ex1:
value:
@@ -14717,7 +13778,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerListenersResponse"
+ $ref: '#/components/schemas/CreateLoadBalancerListenersResponse'
examples:
ex1:
value:
@@ -14764,7 +13825,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Listener
- "/CreateLoadBalancerPolicy":
+ /CreateLoadBalancerPolicy:
post:
description: |-
Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
@@ -14780,7 +13841,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerPolicyRequest"
+ $ref: '#/components/schemas/CreateLoadBalancerPolicyRequest'
examples:
ex1:
summary: Creating a load balancer policy based on browser
@@ -14800,7 +13861,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerPolicyResponse"
+ $ref: '#/components/schemas/CreateLoadBalancerPolicyResponse'
examples:
ex1:
summary: Creating a load balancer policy based on browser
@@ -14885,7 +13946,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancerPolicy
- "/CreateLoadBalancerTags":
+ /CreateLoadBalancerTags:
post:
description: |-
Adds one or more tags to the specified load balancers.
@@ -14896,7 +13957,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerTagsRequest"
+ $ref: '#/components/schemas/CreateLoadBalancerTagsRequest'
examples:
ex1:
value:
@@ -14910,7 +13971,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateLoadBalancerTagsResponse"
+ $ref: '#/components/schemas/CreateLoadBalancerTagsResponse'
examples:
ex1:
value:
@@ -14919,7 +13980,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/CreateNatService":
+ /CreateNatService:
post:
description: |-
Creates a network address translation (NAT) service in the specified public Subnet of a Net.
@@ -14935,7 +13996,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNatServiceRequest"
+ $ref: '#/components/schemas/CreateNatServiceRequest'
examples:
ex1:
value:
@@ -14946,7 +14007,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNatServiceResponse"
+ $ref: '#/components/schemas/CreateNatServiceResponse'
examples:
ex1:
value:
@@ -14966,23 +14027,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NatService
- "/CreateNet":
+ /CreateNet:
post:
description: |-
Creates a Net with a specified IP range.
@@ -14993,7 +14054,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetRequest"
+ $ref: '#/components/schemas/CreateNetRequest'
examples:
ex1:
value:
@@ -15003,7 +14064,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetResponse"
+ $ref: '#/components/schemas/CreateNetResponse'
examples:
ex1:
value:
@@ -15021,32 +14082,32 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'409':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 409 response (Conflict).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Net
- "/CreateNetAccessPoint":
+ /CreateNetAccessPoint:
post:
description: |-
- Creates a Net access point to access an OUTSCALE service from this Net without using the Internet and public IPs.
+ Creates a Net access point to access an OUTSCALE service from this Net without using the Internet or public IPs.
You specify the service using its name. For more information about the available services, see [ReadNetAccessPointServices](#readnetaccesspointservices).
To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.
When a Net access point is created, a public IP is automatically allocated to your OUTSCALE account and used for the Net access point. This public IP is not connected to the Internet. It is counted in your quota, but it is not billed.
@@ -15056,7 +14117,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetAccessPointRequest"
+ $ref: '#/components/schemas/CreateNetAccessPointRequest'
examples:
ex1:
value:
@@ -15069,7 +14130,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetAccessPointResponse"
+ $ref: '#/components/schemas/CreateNetAccessPointResponse'
examples:
ex1:
value:
@@ -15086,7 +14147,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- NetAccessPoint
- "/CreateNetPeering":
+ /CreateNetPeering:
post:
description: |-
Requests a Net peering between a Net you own and a peer Net that belongs to you or another OUTSCALE account.
@@ -15102,7 +14163,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetPeeringRequest"
+ $ref: '#/components/schemas/CreateNetPeeringRequest'
examples:
ex1:
summary: Creating a Net peering between two Nets belonging to you
@@ -15110,8 +14171,7 @@ paths:
SourceNetId: vpc-12345678
AccepterNetId: vpc-87654321
ex2:
- summary: Creating a Net peering with a Net that belongs to another
- account
+ summary: Creating a Net peering with a Net that belongs to another account
value:
SourceNetId: vpc-12345678
AccepterNetId: vpc-87654321
@@ -15121,7 +14181,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNetPeeringResponse"
+ $ref: '#/components/schemas/CreateNetPeeringResponse'
examples:
ex1:
summary: Creating a Net peering between two Nets belonging to you
@@ -15143,8 +14203,7 @@ paths:
AccountId: '123456789012'
NetPeeringId: pcx-12345678
ex2:
- summary: Creating a Net peering with a Net that belongs to another
- account
+ summary: Creating a Net peering with a Net that belongs to another account
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
@@ -15167,23 +14226,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
- "/CreateNic":
+ /CreateNic:
post:
description: |-
Creates a network interface card (NIC) in the specified Subnet.
@@ -15193,7 +14252,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNicRequest"
+ $ref: '#/components/schemas/CreateNicRequest'
examples:
ex1:
summary: Creating a NIC
@@ -15218,7 +14277,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateNicResponse"
+ $ref: '#/components/schemas/CreateNicResponse'
examples:
ex1:
summary: Creating a NIC
@@ -15276,23 +14335,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Nic
- "/CreatePolicy":
+ /CreatePolicy:
post:
description: |-
Creates a managed policy to apply to a user.
@@ -15302,21 +14361,20 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreatePolicyRequest"
+ $ref: '#/components/schemas/CreatePolicyRequest'
examples:
ex1:
value:
Description: Example of description
- Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
- Path: "/example/"
+ Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
+ Path: /example/
PolicyName: example-user-policy
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreatePolicyResponse"
+ $ref: '#/components/schemas/CreatePolicyResponse'
examples:
ex1:
value:
@@ -15326,17 +14384,17 @@ paths:
ResourcesCount: 0
PolicyName: example-user-policy
PolicyDefaultVersionId: v1
- Path: "/example/"
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
+ Path: /example/
+ CreationDate: 2010-10-01T12:34:56.789+0000
Description: Example of description
PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234
Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy
IsLinkable: true
- LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ LastModificationDate: 2010-10-01T12:34:56.789+0000
description: The HTTP 200 response (OK).
tags:
- Policy
- "/CreatePolicyVersion":
+ /CreatePolicyVersion:
post:
description: |-
Creates a version of a specified managed policy.
@@ -15350,12 +14408,11 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreatePolicyVersionRequest"
+ $ref: '#/components/schemas/CreatePolicyVersionRequest'
examples:
ex1:
value:
- Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ Document: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
PolicyOrn: orn:ows:idauth::012345678910:policy/example/example-user-policy
SetAsDefault: true
responses:
@@ -15363,7 +14420,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreatePolicyVersionResponse"
+ $ref: '#/components/schemas/CreatePolicyVersionResponse'
examples:
ex1:
value:
@@ -15372,22 +14429,20 @@ paths:
PolicyVersion:
VersionId: v2
DefaultVersion: true
- CreationDate: 2017-05-10 12:34:56.789000000 +00:00
- Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ CreationDate: 2017-05-10T12:34:56.789+0000
+ Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
description: The HTTP 200 response (OK).
tags:
- Policy
- "/CreateProductType":
+ /CreateProductType:
post:
- description: Creates a product type you can associate with an OMI for consumption
- monitoring and billing purposes.
+ description: Creates a product type you can associate with an OMI for consumption monitoring and billing purposes.
operationId: CreateProductType
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateProductTypeRequest"
+ $ref: '#/components/schemas/CreateProductTypeRequest'
examples:
ex1:
value:
@@ -15398,7 +14453,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/CreateProductTypeResponse"
+ $ref: '#/components/schemas/CreateProductTypeResponse'
examples:
ex1:
value:
@@ -15411,18 +14466,18 @@ paths:
description: The HTTP 200 response (OK).
tags:
- ProductType
- "/CreatePublicIp":
+ /CreatePublicIp:
post:
description: |-
Acquires a public IP for your account.
- A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.
+ A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud, a VM in a Net, a network interface card (NIC), or a NAT service.
@@ -16922,11 +15977,10 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteAccessKeyRequest"
+ $ref: '#/components/schemas/DeleteAccessKeyRequest'
examples:
ex1:
- summary: Deleting one of your own access keys (if you are the root
- user or an EIM user)
+ summary: Deleting one of your own access keys (if you are the root user or an EIM user)
value:
AccessKeyId: ABCDEFGHIJ0123456789
ex2:
@@ -16939,7 +15993,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteAccessKeyResponse"
+ $ref: '#/components/schemas/DeleteAccessKeyResponse'
examples:
ex1:
value:
@@ -16951,7 +16005,7 @@ paths:
- BasicAuth: []
tags:
- AccessKey
- "/DeleteApiAccessRule":
+ /DeleteApiAccessRule:
post:
description: |-
Deletes a specified API access rule.
@@ -16963,7 +16017,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteApiAccessRuleRequest"
+ $ref: '#/components/schemas/DeleteApiAccessRuleRequest'
examples:
ex1:
value:
@@ -16973,7 +16027,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteApiAccessRuleResponse"
+ $ref: '#/components/schemas/DeleteApiAccessRuleResponse'
examples:
ex1:
value:
@@ -16985,7 +16039,7 @@ paths:
- BasicAuth: []
tags:
- ApiAccessRule
- "/DeleteCa":
+ /DeleteCa:
post:
description: Deletes a specified Client Certificate Authority (CA).
operationId: DeleteCa
@@ -16993,7 +16047,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteCaRequest"
+ $ref: '#/components/schemas/DeleteCaRequest'
examples:
ex1:
value:
@@ -17003,7 +16057,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteCaResponse"
+ $ref: '#/components/schemas/DeleteCaResponse'
examples:
ex1:
value:
@@ -17015,7 +16069,7 @@ paths:
- BasicAuth: []
tags:
- Ca
- "/DeleteClientGateway":
+ /DeleteClientGateway:
post:
description: |-
Deletes a client gateway.
@@ -17025,7 +16079,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteClientGatewayRequest"
+ $ref: '#/components/schemas/DeleteClientGatewayRequest'
examples:
ex1:
value:
@@ -17035,7 +16089,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteClientGatewayResponse"
+ $ref: '#/components/schemas/DeleteClientGatewayResponse'
examples:
ex1:
value:
@@ -17044,7 +16098,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- ClientGateway
- "/DeleteDedicatedGroup":
+ /DeleteDedicatedGroup:
post:
description: |-
Deletes a specified dedicated group of virtual machines (VMs).
@@ -17059,15 +16113,14 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDedicatedGroupRequest"
+ $ref: '#/components/schemas/DeleteDedicatedGroupRequest'
examples:
ex1:
summary: Deleting a dedicated group without any resource in it.
value:
DedicatedGroupId: ded-12345678
ex2:
- summary: Forcing the deletion of a dedicated group and all resources
- in it.
+ summary: Forcing the deletion of a dedicated group and all resources in it.
value:
DedicatedGroupId: ded-12345678
Force: true
@@ -17076,7 +16129,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDedicatedGroupResponse"
+ $ref: '#/components/schemas/DeleteDedicatedGroupResponse'
examples:
ex1:
value:
@@ -17087,23 +16140,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- DedicatedGroup
- "/DeleteDhcpOptions":
+ /DeleteDhcpOptions:
post:
description: |-
Deletes a specified DHCP options set.
@@ -17116,7 +16169,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDhcpOptionsRequest"
+ $ref: '#/components/schemas/DeleteDhcpOptionsRequest'
examples:
ex1:
value:
@@ -17126,7 +16179,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDhcpOptionsResponse"
+ $ref: '#/components/schemas/DeleteDhcpOptionsResponse'
examples:
ex1:
value:
@@ -17135,7 +16188,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DhcpOption
- "/DeleteDirectLink":
+ /DeleteDirectLink:
post:
description: |-
Deletes a specified DirectLink.
@@ -17145,7 +16198,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDirectLinkRequest"
+ $ref: '#/components/schemas/DeleteDirectLinkRequest'
examples:
ex1:
value:
@@ -17155,7 +16208,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDirectLinkResponse"
+ $ref: '#/components/schemas/DeleteDirectLinkResponse'
examples:
ex1:
value:
@@ -17164,7 +16217,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DirectLink
- "/DeleteDirectLinkInterface":
+ /DeleteDirectLinkInterface:
post:
description: Deletes a specified DirectLink interface.
operationId: DeleteDirectLinkInterface
@@ -17172,7 +16225,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDirectLinkInterfaceRequest"
+ $ref: '#/components/schemas/DeleteDirectLinkInterfaceRequest'
examples:
ex1:
value:
@@ -17182,7 +16235,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteDirectLinkInterfaceResponse"
+ $ref: '#/components/schemas/DeleteDirectLinkInterfaceResponse'
examples:
ex1:
value:
@@ -17191,7 +16244,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DirectLinkInterface
- "/DeleteExportTask":
+ /DeleteExportTask:
post:
description: |-
Deletes an export task.
@@ -17201,7 +16254,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteExportTaskRequest"
+ $ref: '#/components/schemas/DeleteExportTaskRequest'
examples:
ex1:
summary: Deleting an image export task
@@ -17216,7 +16269,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteExportTaskResponse"
+ $ref: '#/components/schemas/DeleteExportTaskResponse'
examples:
ex1:
summary: Deleting an image export task
@@ -17231,7 +16284,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Task
- "/DeleteFlexibleGpu":
+ /DeleteFlexibleGpu:
post:
description: |-
Releases a flexible GPU (fGPU) from your OUTSCALE account.
@@ -17241,7 +16294,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteFlexibleGpuRequest"
+ $ref: '#/components/schemas/DeleteFlexibleGpuRequest'
examples:
ex1:
value:
@@ -17251,7 +16304,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteFlexibleGpuResponse"
+ $ref: '#/components/schemas/DeleteFlexibleGpuResponse'
examples:
ex1:
value:
@@ -17260,17 +16313,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- FlexibleGpu
- "/DeleteImage":
+ /DeleteImage:
post:
- description: Deletes an OUTSCALE machine image (OMI) so that you cannot use
- it anymore to launch virtual machines (VMs). However, you can still use VMs
- already launched from this OMI.
+ description: Deletes an OUTSCALE machine image (OMI) so that you cannot use it anymore to launch virtual machines (VMs). However, you can still use VMs already launched from this OMI.
operationId: DeleteImage
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteImageRequest"
+ $ref: '#/components/schemas/DeleteImageRequest'
examples:
ex1:
value:
@@ -17280,7 +16331,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteImageResponse"
+ $ref: '#/components/schemas/DeleteImageResponse'
examples:
ex1:
value:
@@ -17291,23 +16342,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Image
- "/DeleteInternetService":
+ /DeleteInternetService:
post:
description: |-
Deletes an internet service.
@@ -17317,7 +16368,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteInternetServiceRequest"
+ $ref: '#/components/schemas/DeleteInternetServiceRequest'
examples:
ex1:
value:
@@ -17327,7 +16378,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteInternetServiceResponse"
+ $ref: '#/components/schemas/DeleteInternetServiceResponse'
examples:
ex1:
value:
@@ -17338,23 +16389,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- InternetService
- "/DeleteKeypair":
+ /DeleteKeypair:
post:
description: |-
Deletes the specified keypair.
@@ -17364,7 +16415,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteKeypairRequest"
+ $ref: '#/components/schemas/DeleteKeypairRequest'
examples:
ex1:
summary: Deleting a keypair with its name
@@ -17379,7 +16430,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteKeypairResponse"
+ $ref: '#/components/schemas/DeleteKeypairResponse'
examples:
ex1:
value:
@@ -17390,23 +16441,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Keypair
- "/DeleteListenerRule":
+ /DeleteListenerRule:
post:
description: |-
Deletes a listener rule.
@@ -17416,7 +16467,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteListenerRuleRequest"
+ $ref: '#/components/schemas/DeleteListenerRuleRequest'
examples:
ex1:
value:
@@ -17426,7 +16477,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteListenerRuleResponse"
+ $ref: '#/components/schemas/DeleteListenerRuleResponse'
examples:
ex1:
value:
@@ -17435,7 +16486,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Listener
- "/DeleteLoadBalancer":
+ /DeleteLoadBalancer:
post:
description: Deletes a specified load balancer.
operationId: DeleteLoadBalancer
@@ -17443,7 +16494,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerRequest"
+ $ref: '#/components/schemas/DeleteLoadBalancerRequest'
examples:
ex1:
value:
@@ -17453,7 +16504,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerResponse"
+ $ref: '#/components/schemas/DeleteLoadBalancerResponse'
examples:
ex1:
value:
@@ -17498,7 +16549,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/DeleteLoadBalancerListeners":
+ /DeleteLoadBalancerListeners:
post:
description: Deletes listeners of a specified load balancer.
operationId: DeleteLoadBalancerListeners
@@ -17506,7 +16557,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerListenersRequest"
+ $ref: '#/components/schemas/DeleteLoadBalancerListenersRequest'
examples:
ex1:
value:
@@ -17518,7 +16569,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerListenersResponse"
+ $ref: '#/components/schemas/DeleteLoadBalancerListenersResponse'
examples:
ex1:
value:
@@ -17557,7 +16608,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Listener
- "/DeleteLoadBalancerPolicy":
+ /DeleteLoadBalancerPolicy:
post:
description: |-
Deletes a specified policy from a load balancer.
@@ -17567,7 +16618,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerPolicyRequest"
+ $ref: '#/components/schemas/DeleteLoadBalancerPolicyRequest'
examples:
ex1:
value:
@@ -17578,7 +16629,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerPolicyResponse"
+ $ref: '#/components/schemas/DeleteLoadBalancerPolicyResponse'
examples:
ex1:
value:
@@ -17622,7 +16673,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancerPolicy
- "/DeleteLoadBalancerTags":
+ /DeleteLoadBalancerTags:
post:
description: Deletes one or more tags from the specified load balancers.
operationId: DeleteLoadBalancerTags
@@ -17630,7 +16681,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerTagsRequest"
+ $ref: '#/components/schemas/DeleteLoadBalancerTagsRequest'
examples:
ex1:
value:
@@ -17643,7 +16694,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteLoadBalancerTagsResponse"
+ $ref: '#/components/schemas/DeleteLoadBalancerTagsResponse'
examples:
ex1:
value:
@@ -17652,7 +16703,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/DeleteNatService":
+ /DeleteNatService:
post:
description: |-
Deletes a specified network address translation (NAT) service.
@@ -17662,7 +16713,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNatServiceRequest"
+ $ref: '#/components/schemas/DeleteNatServiceRequest'
examples:
ex1:
value:
@@ -17672,7 +16723,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNatServiceResponse"
+ $ref: '#/components/schemas/DeleteNatServiceResponse'
examples:
ex1:
value:
@@ -17683,23 +16734,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NatService
- "/DeleteNet":
+ /DeleteNet:
post:
description: |-
Deletes a specified Net.
@@ -17719,7 +16770,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetRequest"
+ $ref: '#/components/schemas/DeleteNetRequest'
examples:
ex1:
value:
@@ -17729,7 +16780,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetResponse"
+ $ref: '#/components/schemas/DeleteNetResponse'
examples:
ex1:
value:
@@ -17740,23 +16791,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Net
- "/DeleteNetAccessPoint":
+ /DeleteNetAccessPoint:
post:
description: |-
Deletes a specified Net access point.
@@ -17766,7 +16817,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetAccessPointRequest"
+ $ref: '#/components/schemas/DeleteNetAccessPointRequest'
examples:
ex1:
value:
@@ -17776,7 +16827,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetAccessPointResponse"
+ $ref: '#/components/schemas/DeleteNetAccessPointResponse'
examples:
ex1:
value:
@@ -17785,7 +16836,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- NetAccessPoint
- "/DeleteNetPeering":
+ /DeleteNetPeering:
post:
description: |-
Deletes a Net peering.
@@ -17797,7 +16848,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetPeeringRequest"
+ $ref: '#/components/schemas/DeleteNetPeeringRequest'
examples:
ex1:
value:
@@ -17807,7 +16858,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNetPeeringResponse"
+ $ref: '#/components/schemas/DeleteNetPeeringResponse'
examples:
ex1:
value:
@@ -17818,29 +16869,29 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'409':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 409 response (Conflict).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
- "/DeleteNic":
+ /DeleteNic:
post:
description: |-
Deletes the specified network interface card (NIC).
@@ -17850,7 +16901,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNicRequest"
+ $ref: '#/components/schemas/DeleteNicRequest'
examples:
ex1:
value:
@@ -17860,7 +16911,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteNicResponse"
+ $ref: '#/components/schemas/DeleteNicResponse'
examples:
ex1:
value:
@@ -17871,23 +16922,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Nic
- "/DeletePolicy":
+ /DeletePolicy:
post:
description: |-
Deletes a managed policy.
@@ -17897,7 +16948,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePolicyRequest"
+ $ref: '#/components/schemas/DeletePolicyRequest'
examples:
ex1:
value:
@@ -17907,7 +16958,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePolicyResponse"
+ $ref: '#/components/schemas/DeletePolicyResponse'
examples:
ex1:
value:
@@ -17916,7 +16967,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/DeletePolicyVersion":
+ /DeletePolicyVersion:
post:
description: |-
Deletes a specified version of a managed policy, if it is not set as the default one.
@@ -17929,7 +16980,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePolicyVersionRequest"
+ $ref: '#/components/schemas/DeletePolicyVersionRequest'
examples:
ex1:
value:
@@ -17940,7 +16991,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePolicyVersionResponse"
+ $ref: '#/components/schemas/DeletePolicyVersionResponse'
examples:
ex1:
value:
@@ -17949,7 +17000,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/DeleteProductType":
+ /DeleteProductType:
post:
description: |-
Deletes a specified product type that belongs to you.
@@ -17962,7 +17013,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteProductTypeRequest"
+ $ref: '#/components/schemas/DeleteProductTypeRequest'
examples:
ex1:
value:
@@ -17972,7 +17023,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteProductTypeResponse"
+ $ref: '#/components/schemas/DeleteProductTypeResponse'
examples:
ex1:
value:
@@ -17983,23 +17034,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- ProductType
- "/DeletePublicIp":
+ /DeletePublicIp:
post:
description: |-
Releases a public IP.
@@ -18009,7 +17060,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePublicIpRequest"
+ $ref: '#/components/schemas/DeletePublicIpRequest'
examples:
ex1:
value:
@@ -18019,7 +17070,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeletePublicIpResponse"
+ $ref: '#/components/schemas/DeletePublicIpResponse'
examples:
ex1:
value:
@@ -18030,23 +17081,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- PublicIp
- "/DeleteRoute":
+ /DeleteRoute:
post:
description: Deletes a route from a specified route table.
operationId: DeleteRoute
@@ -18054,7 +17105,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteRouteRequest"
+ $ref: '#/components/schemas/DeleteRouteRequest'
examples:
ex1:
value:
@@ -18065,7 +17116,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteRouteResponse"
+ $ref: '#/components/schemas/DeleteRouteResponse'
examples:
ex1:
value:
@@ -18086,23 +17137,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Route
- "/DeleteRouteTable":
+ /DeleteRouteTable:
post:
description: |-
Deletes a specified route table.
@@ -18112,7 +17163,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteRouteTableRequest"
+ $ref: '#/components/schemas/DeleteRouteTableRequest'
examples:
ex1:
value:
@@ -18122,7 +17173,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteRouteTableResponse"
+ $ref: '#/components/schemas/DeleteRouteTableResponse'
examples:
ex1:
value:
@@ -18133,23 +17184,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- RouteTable
- "/DeleteSecurityGroup":
+ /DeleteSecurityGroup:
post:
description: |-
Deletes a specified security group.
@@ -18160,7 +17211,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSecurityGroupRequest"
+ $ref: '#/components/schemas/DeleteSecurityGroupRequest'
examples:
ex1:
value:
@@ -18170,7 +17221,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSecurityGroupResponse"
+ $ref: '#/components/schemas/DeleteSecurityGroupResponse'
examples:
ex1:
value:
@@ -18181,23 +17232,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- SecurityGroup
- "/DeleteSecurityGroupRule":
+ /DeleteSecurityGroupRule:
post:
description: |-
Deletes one or more inbound or outbound rules from a security group.
@@ -18212,7 +17263,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSecurityGroupRuleRequest"
+ $ref: '#/components/schemas/DeleteSecurityGroupRuleRequest'
examples:
ex1:
summary: Deleting an inbound rule from an IP range
@@ -18240,7 +17291,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSecurityGroupRuleResponse"
+ $ref: '#/components/schemas/DeleteSecurityGroupRuleResponse'
examples:
ex1:
summary: Deleting an inbound rule from an IP range
@@ -18250,7 +17301,7 @@ paths:
SecurityGroupName: security-group-example
OutboundRules:
- FromPortRange: -1
- IpProtocol: "-1"
+ IpProtocol: '-1'
ToPortRange: -1
IpRanges:
- 0.0.0.0/0
@@ -18269,7 +17320,7 @@ paths:
SecurityGroupName: security-group-example
OutboundRules:
- FromPortRange: -1
- IpProtocol: "-1"
+ IpProtocol: '-1'
ToPortRange: -1
IpRanges:
- 0.0.0.0/0
@@ -18285,23 +17336,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- SecurityGroupRule
- "/DeleteServerCertificate":
+ /DeleteServerCertificate:
post:
description: Deletes a specified server certificate.
operationId: DeleteServerCertificate
@@ -18309,7 +17360,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteServerCertificateRequest"
+ $ref: '#/components/schemas/DeleteServerCertificateRequest'
examples:
ex1:
value:
@@ -18319,7 +17370,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteServerCertificateResponse"
+ $ref: '#/components/schemas/DeleteServerCertificateResponse'
examples:
ex1:
value:
@@ -18328,7 +17379,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- ServerCertificate
- "/DeleteSnapshot":
+ /DeleteSnapshot:
post:
description: |-
Deletes a specified snapshot.
@@ -18338,7 +17389,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSnapshotRequest"
+ $ref: '#/components/schemas/DeleteSnapshotRequest'
examples:
ex1:
value:
@@ -18348,7 +17399,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSnapshotResponse"
+ $ref: '#/components/schemas/DeleteSnapshotResponse'
examples:
ex1:
value:
@@ -18359,23 +17410,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Snapshot
- "/DeleteSubnet":
+ /DeleteSubnet:
post:
description: |-
Deletes a specified Subnet.
@@ -18390,7 +17441,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSubnetRequest"
+ $ref: '#/components/schemas/DeleteSubnetRequest'
examples:
ex1:
value:
@@ -18400,7 +17451,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteSubnetResponse"
+ $ref: '#/components/schemas/DeleteSubnetResponse'
examples:
ex1:
value:
@@ -18411,23 +17462,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Subnet
- "/DeleteTags":
+ /DeleteTags:
post:
description: Deletes one or more tags from the specified resources.
operationId: DeleteTags
@@ -18435,7 +17486,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteTagsRequest"
+ $ref: '#/components/schemas/DeleteTagsRequest'
examples:
ex1:
value:
@@ -18449,7 +17500,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteTagsResponse"
+ $ref: '#/components/schemas/DeleteTagsResponse'
examples:
ex1:
value:
@@ -18460,32 +17511,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Tag
- "/DeleteUser":
+ /DeleteUser:
post:
- description: Deletes a specified EIM user. The EIM user must not belong to any
- group, nor have any key or linked policy.
+ description: Deletes a specified EIM user. The EIM user must not belong to any group, nor have any key or linked policy.
operationId: DeleteUser
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserRequest"
+ $ref: '#/components/schemas/DeleteUserRequest'
examples:
ex1:
value:
@@ -18495,7 +17545,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserResponse"
+ $ref: '#/components/schemas/DeleteUserResponse'
examples:
ex1:
value:
@@ -18504,7 +17554,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- User
- "/DeleteUserGroup":
+ /DeleteUserGroup:
post:
description: |-
Deletes a specified user group.
@@ -18517,19 +17567,19 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserGroupRequest"
+ $ref: '#/components/schemas/DeleteUserGroupRequest'
examples:
ex1:
value:
Force: false
- Path: "/example/"
+ Path: /example/
UserGroupName: example-usergroup
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserGroupResponse"
+ $ref: '#/components/schemas/DeleteUserGroupResponse'
examples:
ex1:
value:
@@ -18538,7 +17588,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- UserGroup
- "/DeleteUserGroupPolicy":
+ /DeleteUserGroupPolicy:
post:
description: |-
Deletes a specified inline policy from a specific group.
@@ -18551,19 +17601,19 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserGroupPolicyRequest"
+ $ref: '#/components/schemas/DeleteUserGroupPolicyRequest'
examples:
ex1:
value:
PolicyName: example-usergroup-policy
UserGroupName: example-usergroup
- UserGroupPath: "/example/"
+ UserGroupPath: /example/
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserGroupPolicyResponse"
+ $ref: '#/components/schemas/DeleteUserGroupPolicyResponse'
examples:
ex1:
value:
@@ -18572,7 +17622,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/DeleteUserPolicy":
+ /DeleteUserPolicy:
post:
description: |-
Deletes a specified inline policy from a specific user.
@@ -18585,7 +17635,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserPolicyRequest"
+ $ref: '#/components/schemas/DeleteUserPolicyRequest'
examples:
ex1:
value:
@@ -18596,7 +17646,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteUserPolicyResponse"
+ $ref: '#/components/schemas/DeleteUserPolicyResponse'
examples:
ex1:
value:
@@ -18605,7 +17655,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/DeleteVirtualGateway":
+ /DeleteVirtualGateway:
post:
description: |-
Deletes a specified virtual gateway.
@@ -18616,7 +17666,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVirtualGatewayRequest"
+ $ref: '#/components/schemas/DeleteVirtualGatewayRequest'
examples:
ex1:
value:
@@ -18626,7 +17676,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVirtualGatewayResponse"
+ $ref: '#/components/schemas/DeleteVirtualGatewayResponse'
examples:
ex1:
value:
@@ -18635,7 +17685,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- VirtualGateway
- "/DeleteVmGroup":
+ /DeleteVmGroup:
post:
description: |-
> [WARNING]
@@ -18647,7 +17697,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmGroupRequest"
+ $ref: '#/components/schemas/DeleteVmGroupRequest'
examples:
ex1:
value:
@@ -18657,7 +17707,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmGroupResponse"
+ $ref: '#/components/schemas/DeleteVmGroupResponse'
examples:
ex1:
value:
@@ -18668,23 +17718,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- VmGroup
- "/DeleteVmTemplate":
+ /DeleteVmTemplate:
post:
description: |-
> [WARNING]
@@ -18697,7 +17747,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmTemplateRequest"
+ $ref: '#/components/schemas/DeleteVmTemplateRequest'
examples:
ex1:
value:
@@ -18707,7 +17757,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmTemplateResponse"
+ $ref: '#/components/schemas/DeleteVmTemplateResponse'
examples:
ex1:
value:
@@ -18716,7 +17766,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- VmTemplate
- "/DeleteVms":
+ /DeleteVms:
post:
description: |-
Terminates one or more virtual machines (VMs).
@@ -18726,7 +17776,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmsRequest"
+ $ref: '#/components/schemas/DeleteVmsRequest'
examples:
ex1:
value:
@@ -18737,7 +17787,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVmsResponse"
+ $ref: '#/components/schemas/DeleteVmsResponse'
examples:
ex1:
value:
@@ -18752,23 +17802,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Vm
- "/DeleteVolume":
+ /DeleteVolume:
post:
description: |-
Deletes a specified Block Storage Unit (BSU) volume.
@@ -18778,7 +17828,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVolumeRequest"
+ $ref: '#/components/schemas/DeleteVolumeRequest'
examples:
ex1:
value:
@@ -18788,7 +17838,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVolumeResponse"
+ $ref: '#/components/schemas/DeleteVolumeResponse'
examples:
ex1:
value:
@@ -18799,23 +17849,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Volume
- "/DeleteVpnConnection":
+ /DeleteVpnConnection:
post:
description: |-
Deletes a specified VPN connection.
@@ -18825,7 +17875,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVpnConnectionRequest"
+ $ref: '#/components/schemas/DeleteVpnConnectionRequest'
examples:
ex1:
value:
@@ -18835,7 +17885,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVpnConnectionResponse"
+ $ref: '#/components/schemas/DeleteVpnConnectionResponse'
examples:
ex1:
value:
@@ -18844,16 +17894,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- VpnConnection
- "/DeleteVpnConnectionRoute":
+ /DeleteVpnConnectionRoute:
post:
- description: Deletes a static route to a VPN connection previously created using
- the CreateVpnConnectionRoute method.
+ description: Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method.
operationId: DeleteVpnConnectionRoute
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVpnConnectionRouteRequest"
+ $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest'
examples:
ex1:
value:
@@ -18864,7 +17913,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeleteVpnConnectionRouteResponse"
+ $ref: '#/components/schemas/DeleteVpnConnectionRouteResponse'
examples:
ex1:
value:
@@ -18873,7 +17922,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- VpnConnection
- "/DeregisterVmsInLoadBalancer":
+ /DeregisterVmsInLoadBalancer:
post:
description: |-
> [WARNING]
@@ -18885,7 +17934,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerRequest"
+ $ref: '#/components/schemas/DeregisterVmsInLoadBalancerRequest'
examples:
ex1:
value:
@@ -18898,7 +17947,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DeregisterVmsInLoadBalancerResponse"
+ $ref: '#/components/schemas/DeregisterVmsInLoadBalancerResponse'
examples:
ex1:
value:
@@ -18907,16 +17956,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/DisableOutscaleLogin":
+ /DisableOutscaleLogin:
post:
- description: Disables the possibility of logging in using the Outscale credentials
- of your root user when identity federation is activated.
+ description: Disables the possibility of logging in using the Outscale credentials of your root user when identity federation is activated.
operationId: DisableOutscaleLogin
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginRequest"
+ $ref: '#/components/schemas/DisableOutscaleLoginRequest'
examples:
ex1:
value: {}
@@ -18925,7 +17973,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginResponse"
+ $ref: '#/components/schemas/DisableOutscaleLoginResponse'
examples:
ex1:
value:
@@ -18934,16 +17982,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/DisableOutscaleLoginForUsers":
+ /DisableOutscaleLoginForUsers:
post:
- description: Disables the possibility of logging in using the Outscale credentials
- of your EIM users when identity federation is activated.
+ description: Disables the possibility of logging in using the Outscale credentials of your EIM users when identity federation is activated.
operationId: DisableOutscaleLoginForUsers
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginRequest"
+ $ref: '#/components/schemas/DisableOutscaleLoginRequest'
examples:
ex1:
value: {}
@@ -18952,7 +17999,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginResponse"
+ $ref: '#/components/schemas/DisableOutscaleLoginResponse'
examples:
ex1:
value:
@@ -18961,16 +18008,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/DisableOutscaleLoginPerUsers":
+ /DisableOutscaleLoginPerUsers:
post:
- description: Disables the possibility for one or more specific users to log
- in using their Outscale credentials when identity federation is activated.
+ description: Disables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated.
operationId: DisableOutscaleLoginPerUsers
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersRequest"
+ $ref: '#/components/schemas/DisableOutscaleLoginPerUsersRequest'
examples:
ex1:
value:
@@ -18982,7 +18028,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/DisableOutscaleLoginPerUsersResponse"
+ $ref: '#/components/schemas/DisableOutscaleLoginPerUsersResponse'
examples:
ex1:
value:
@@ -18991,16 +18037,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/EnableOutscaleLogin":
+ /EnableOutscaleLogin:
post:
- description: Enables the possibility of logging in using the Outscale credentials
- of your root user when identity federation is activated.
+ description: Enables the possibility of logging in using the Outscale credentials of your root user when identity federation is activated.
operationId: EnableOutscaleLogin
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginRequest"
+ $ref: '#/components/schemas/EnableOutscaleLoginRequest'
examples:
ex1:
value: {}
@@ -19009,7 +18054,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginResponse"
+ $ref: '#/components/schemas/EnableOutscaleLoginResponse'
examples:
ex1:
value:
@@ -19018,16 +18063,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/EnableOutscaleLoginForUsers":
+ /EnableOutscaleLoginForUsers:
post:
- description: Enables the possibility for all your EIM users to log in using
- their Outscale credentials when identity federation is activated.
+ description: Enables the possibility for all your EIM users to log in using their Outscale credentials when identity federation is activated.
operationId: EnableOutscaleLoginForUsers
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginForUsersRequest"
+ $ref: '#/components/schemas/EnableOutscaleLoginForUsersRequest'
examples:
ex1:
value: {}
@@ -19036,7 +18080,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginForUsersResponse"
+ $ref: '#/components/schemas/EnableOutscaleLoginForUsersResponse'
examples:
ex1:
value:
@@ -19045,16 +18089,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/EnableOutscaleLoginPerUsers":
+ /EnableOutscaleLoginPerUsers:
post:
- description: Enables the possibility for one or more specific users to log in
- using their Outscale credentials when identity federation is activated.
+ description: Enables the possibility for one or more specific users to log in using their Outscale credentials when identity federation is activated.
operationId: EnableOutscaleLoginPerUsers
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersRequest"
+ $ref: '#/components/schemas/EnableOutscaleLoginPerUsersRequest'
examples:
ex1:
value:
@@ -19066,7 +18109,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/EnableOutscaleLoginPerUsersResponse"
+ $ref: '#/components/schemas/EnableOutscaleLoginPerUsersResponse'
examples:
ex1:
value:
@@ -19075,7 +18118,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- IdentityProvider
- "/LinkFlexibleGpu":
+ /LinkFlexibleGpu:
post:
description: |-
Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
@@ -19088,7 +18131,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkFlexibleGpuRequest"
+ $ref: '#/components/schemas/LinkFlexibleGpuRequest'
examples:
ex1:
value:
@@ -19099,7 +18142,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkFlexibleGpuResponse"
+ $ref: '#/components/schemas/LinkFlexibleGpuResponse'
examples:
ex1:
value:
@@ -19108,7 +18151,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- FlexibleGpu
- "/LinkInternetService":
+ /LinkInternetService:
post:
description: |-
Attaches an internet service to a Net.
@@ -19118,7 +18161,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkInternetServiceRequest"
+ $ref: '#/components/schemas/LinkInternetServiceRequest'
examples:
ex1:
value:
@@ -19129,7 +18172,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkInternetServiceResponse"
+ $ref: '#/components/schemas/LinkInternetServiceResponse'
examples:
ex1:
value:
@@ -19140,23 +18183,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- InternetService
- "/LinkLoadBalancerBackendMachines":
+ /LinkLoadBalancerBackendMachines:
post:
description: |-
Attaches one or more virtual machines (VMs) to a specified load balancer. You need to specify at least the `BackendIps` or the `BackendVmIds` parameter.
@@ -19166,7 +18209,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesRequest"
+ $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesRequest'
examples:
ex1:
summary: Linking VMs to a load balancer
@@ -19187,7 +18230,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkLoadBalancerBackendMachinesResponse"
+ $ref: '#/components/schemas/LinkLoadBalancerBackendMachinesResponse'
examples:
ex1:
summary: Linking VMs to a load balancer
@@ -19202,7 +18245,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/LinkManagedPolicyToUserGroup":
+ /LinkManagedPolicyToUserGroup:
post:
description: |-
Links a managed policy to a specific group. This policy applies to all the users contained in this group.
@@ -19215,7 +18258,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupRequest"
+ $ref: '#/components/schemas/LinkManagedPolicyToUserGroupRequest'
examples:
ex1:
value:
@@ -19226,7 +18269,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkManagedPolicyToUserGroupResponse"
+ $ref: '#/components/schemas/LinkManagedPolicyToUserGroupResponse'
examples:
ex1:
value:
@@ -19235,7 +18278,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/LinkNic":
+ /LinkNic:
post:
description: |-
Attaches a network interface card (NIC) to a virtual machine (VM).
@@ -19245,7 +18288,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkNicRequest"
+ $ref: '#/components/schemas/LinkNicRequest'
examples:
ex1:
value:
@@ -19257,7 +18300,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkNicResponse"
+ $ref: '#/components/schemas/LinkNicResponse'
examples:
ex1:
value:
@@ -19269,23 +18312,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Nic
- "/LinkPolicy":
+ /LinkPolicy:
post:
description: |-
Links a managed policy to a specific user.
@@ -19298,7 +18341,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPolicyRequest"
+ $ref: '#/components/schemas/LinkPolicyRequest'
examples:
ex1:
value:
@@ -19309,7 +18352,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPolicyResponse"
+ $ref: '#/components/schemas/LinkPolicyResponse'
examples:
ex1:
value:
@@ -19318,21 +18361,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/LinkPrivateIps":
+ /LinkPrivateIps:
post:
- description: Assigns one or more secondary private IPs to a specified network
- interface card (NIC). This action is only available in a Net. The private
- IPs to be assigned can be added individually using the `PrivateIps` parameter,
- or you can specify the number of private IPs to be automatically chosen within
- the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify
- only one of these two parameters. If none of these parameters are specified,
- a private IP is chosen within the Subnet range.
+ description: Assigns one or more secondary private IPs to a specified network interface card (NIC). This action is only available in a Net. The private IPs to be assigned can be added individually using the `PrivateIps` parameter, or you can specify the number of private IPs to be automatically chosen within the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP is chosen within the Subnet range.
operationId: LinkPrivateIps
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPrivateIpsRequest"
+ $ref: '#/components/schemas/LinkPrivateIpsRequest'
examples:
ex1:
summary: Linking specific secondary private IPs to a NIC
@@ -19351,7 +18388,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPrivateIpsResponse"
+ $ref: '#/components/schemas/LinkPrivateIpsResponse'
examples:
ex1:
value:
@@ -19362,23 +18399,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Nic
- "/LinkPublicIp":
+ /LinkPublicIp:
post:
description: |-
Associates a public IP with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate a public IP with only one VM or network interface at a time.
@@ -19392,7 +18429,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPublicIpRequest"
+ $ref: '#/components/schemas/LinkPublicIpRequest'
examples:
ex1:
summary: Linking a public IP to a VM
@@ -19409,7 +18446,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkPublicIpResponse"
+ $ref: '#/components/schemas/LinkPublicIpResponse'
examples:
ex1:
summary: Linking a public IP to a VM
@@ -19428,23 +18465,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- PublicIp
- "/LinkRouteTable":
+ /LinkRouteTable:
post:
description: |-
Associates a Subnet with a route table.
@@ -19454,7 +18491,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkRouteTableRequest"
+ $ref: '#/components/schemas/LinkRouteTableRequest'
examples:
ex1:
value:
@@ -19465,7 +18502,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkRouteTableResponse"
+ $ref: '#/components/schemas/LinkRouteTableResponse'
examples:
ex1:
value:
@@ -19477,23 +18514,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- RouteTable
- "/LinkVirtualGateway":
+ /LinkVirtualGateway:
post:
description: |-
Attaches a virtual gateway to a Net.
@@ -19505,7 +18542,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkVirtualGatewayRequest"
+ $ref: '#/components/schemas/LinkVirtualGatewayRequest'
examples:
ex1:
value:
@@ -19516,7 +18553,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkVirtualGatewayResponse"
+ $ref: '#/components/schemas/LinkVirtualGatewayResponse'
examples:
ex1:
value:
@@ -19528,7 +18565,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- VirtualGateway
- "/LinkVolume":
+ /LinkVolume:
post:
description: |-
Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
@@ -19538,19 +18575,19 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkVolumeRequest"
+ $ref: '#/components/schemas/LinkVolumeRequest'
examples:
ex1:
value:
VolumeId: vol-12345678
VmId: i-12345678
- DeviceName: "/dev/sdb"
+ DeviceName: /dev/sdb
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/LinkVolumeResponse"
+ $ref: '#/components/schemas/LinkVolumeResponse'
examples:
ex1:
value:
@@ -19561,23 +18598,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Volume
- "/PutUserGroupPolicy":
+ /PutUserGroupPolicy:
post:
description: |-
Creates or updates an inline policy included in a specified group.
@@ -19591,21 +18628,20 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PutUserGroupPolicyRequest"
+ $ref: '#/components/schemas/PutUserGroupPolicyRequest'
examples:
ex1:
value:
- PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
PolicyName: example-usergroup-policy
UserGroupName: example-usergroup
- UserGroupPath: "/example/"
+ UserGroupPath: /example/
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/PutUserGroupPolicyResponse"
+ $ref: '#/components/schemas/PutUserGroupPolicyResponse'
examples:
ex1:
value:
@@ -19614,7 +18650,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/PutUserPolicy":
+ /PutUserPolicy:
post:
description: |-
Creates or updates an inline policy included in a specified user.
@@ -19628,12 +18664,11 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PutUserPolicyRequest"
+ $ref: '#/components/schemas/PutUserPolicyRequest'
examples:
ex1:
value:
- PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ PolicyDocument: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
PolicyName: example-user-policy
UserName: example-user
responses:
@@ -19641,7 +18676,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/PutUserPolicyResponse"
+ $ref: '#/components/schemas/PutUserPolicyResponse'
examples:
ex1:
value:
@@ -19650,7 +18685,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadAccessKeys":
+ /ReadAccessKeys:
post:
description: Lists the access key IDs of either your root user or an EIM user.
operationId: ReadAccessKeys
@@ -19658,7 +18693,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAccessKeysRequest"
+ $ref: '#/components/schemas/ReadAccessKeysRequest'
examples:
ex1:
value:
@@ -19672,7 +18707,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAccessKeysResponse"
+ $ref: '#/components/schemas/ReadAccessKeysResponse'
examples:
ex1:
value:
@@ -19681,9 +18716,9 @@ paths:
AccessKeys:
- State: ACTIVE
AccessKeyId: ABCDEFGHIJ0123456789
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00
- LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ ExpirationDate: 2063-04-05T00:00:00.000+0000
+ LastModificationDate: 2010-10-01T12:34:56.789+0000
Tag: Group1
description: The HTTP 200 response (OK).
security:
@@ -19691,7 +18726,7 @@ paths:
- BasicAuth: []
tags:
- AccessKey
- "/ReadAccounts":
+ /ReadAccounts:
post:
description: Gets information about the account that sent the request.
operationId: ReadAccounts
@@ -19699,7 +18734,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAccountsRequest"
+ $ref: '#/components/schemas/ReadAccountsRequest'
examples:
ex1:
value: {}
@@ -19708,7 +18743,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAccountsResponse"
+ $ref: '#/components/schemas/ReadAccountsResponse'
examples:
ex1:
value:
@@ -19727,7 +18762,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/ReadAdminPassword":
+ /ReadAdminPassword:
post:
description: |-
Gets the administrator password for a Windows running virtual machine (VM).
@@ -19741,7 +18776,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAdminPasswordRequest"
+ $ref: '#/components/schemas/ReadAdminPasswordRequest'
examples:
ex1:
value:
@@ -19751,36 +18786,36 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadAdminPasswordResponse"
+ $ref: '#/components/schemas/ReadAdminPasswordResponse'
examples:
ex1:
value:
VmId: i-12345678
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
- AdminPassword: "..."
+ AdminPassword: ...
description: The HTTP 200 response (OK).
'400':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Vm
- "/ReadApiAccessPolicy":
+ /ReadApiAccessPolicy:
post:
description: |-
Gets information about the API access policy of your OUTSCALE account.
@@ -19790,7 +18825,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiAccessPolicyRequest"
+ $ref: '#/components/schemas/ReadApiAccessPolicyRequest'
examples:
ex1:
value: {}
@@ -19799,7 +18834,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiAccessPolicyResponse"
+ $ref: '#/components/schemas/ReadApiAccessPolicyResponse'
examples:
ex1:
value:
@@ -19813,26 +18848,26 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
security:
- ApiKeyAuthSec: []
- BasicAuth: []
tags:
- ApiAccessPolicy
- "/ReadApiAccessRules":
+ /ReadApiAccessRules:
post:
description: Lists one or more API access rules.
operationId: ReadApiAccessRules
@@ -19840,7 +18875,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiAccessRulesRequest"
+ $ref: '#/components/schemas/ReadApiAccessRulesRequest'
examples:
ex1:
value:
@@ -19852,7 +18887,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiAccessRulesResponse"
+ $ref: '#/components/schemas/ReadApiAccessRulesResponse'
examples:
ex1:
value:
@@ -19871,7 +18906,7 @@ paths:
- BasicAuth: []
tags:
- ApiAccessRule
- "/ReadApiLogs":
+ /ReadApiLogs:
post:
description: |-
Lists the logs of the API calls you have performed with this OUTSCALE account.
@@ -19885,7 +18920,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiLogsRequest"
+ $ref: '#/components/schemas/ReadApiLogsRequest'
examples:
ex1:
value:
@@ -19900,7 +18935,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadApiLogsResponse"
+ $ref: '#/components/schemas/ReadApiLogsResponse'
examples:
ex1:
value:
@@ -19909,7 +18944,7 @@ paths:
Logs:
- ResponseStatusCode: 200
ResponseSize: 1887
- QueryPayloadRaw: "{}"
+ QueryPayloadRaw: '{}'
QueryApiName: oapi
QueryIpAddress: 192.0.2.0
QueryUserAgent: oAPI CLI v0.1 - 2018-09-28
@@ -19922,24 +18957,19 @@ paths:
QueryAccessKey: ABCDEFGHIJ0123456789
QueryHeaderSize: 287
QueryDate: '2017-05-10T12:34:56.789Z'
- QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection:
- close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date:
- 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization:
- *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For:
- 192.0.2.0'
+ QueryHeaderRaw: 'Host: api.eu-west-2.outscale.com\nAccept: */*\nConnection: close\nUser-Agent: oAPI CLI v0.1 - 2018-09-28\nX-Osc-Date: 20170510T000000Z\nContent-Type: application/json; charset=utf-8\nAuthorization: *****\nContent-Length: 2\nAccept-Encoding: gzip, deflate\nX-Forwarded-For: 192.0.2.0'
description: The HTTP 200 response (OK).
tags:
- ApiLog
- "/ReadCO2EmissionAccount":
+ /ReadCO2EmissionAccount:
post:
- description: Gets information about the estimated carbon footprint of your account
- for the current Region within the specified time period.
+ description: Gets information about the estimated carbon footprint of your account for the current Region within the specified time period.
operationId: ReadCO2EmissionAccount
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCO2EmissionAccountRequest"
+ $ref: '#/components/schemas/ReadCO2EmissionAccountRequest'
examples:
ex1:
value:
@@ -19951,7 +18981,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCO2EmissionAccountResponse"
+ $ref: '#/components/schemas/ReadCO2EmissionAccountResponse'
examples:
ex1:
value:
@@ -19973,16 +19003,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/ReadCas":
+ /ReadCas:
post:
- description: Gets information about one or more of your Client Certificate Authorities
- (CAs).
+ description: Gets information about one or more of your Client Certificate Authorities (CAs).
operationId: ReadCas
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCasRequest"
+ $ref: '#/components/schemas/ReadCasRequest'
examples:
ex1:
value:
@@ -19994,7 +19023,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCasResponse"
+ $ref: '#/components/schemas/ReadCasResponse'
examples:
ex1:
value:
@@ -20010,7 +19039,7 @@ paths:
- BasicAuth: []
tags:
- Ca
- "/ReadCatalog":
+ /ReadCatalog:
post:
description: Returns the price list of OUTSCALE services for the current Region.
operationId: ReadCatalog
@@ -20018,7 +19047,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCatalogRequest"
+ $ref: '#/components/schemas/ReadCatalogRequest'
examples:
ex1:
value: {}
@@ -20027,7 +19056,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCatalogResponse"
+ $ref: '#/components/schemas/ReadCatalogResponse'
examples:
ex1:
value:
@@ -20037,8 +19066,7 @@ paths:
Entries:
- UnitPrice: 0.04
Type: CustomCore:v5-p1
- Title: Instance - On demand - Unite de vCore pour une instance
- Tina v5 CxRy Performance highest - par heure
+ Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure
SubregionName: eu-west-2
Category: compute
Service: TinaOS-FCU
@@ -20046,16 +19074,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Catalog
- "/ReadCatalogs":
+ /ReadCatalogs:
post:
- description: Returns the price list of OUTSCALE services for the current Region
- within a specific time period.
+ description: Returns the price list of OUTSCALE services for the current Region within a specific time period.
operationId: ReadCatalogs
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCatalogsRequest"
+ $ref: '#/components/schemas/ReadCatalogsRequest'
examples:
ex1:
value:
@@ -20068,7 +19095,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadCatalogsResponse"
+ $ref: '#/components/schemas/ReadCatalogsResponse'
examples:
ex1:
value:
@@ -20076,12 +19103,11 @@ paths:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
Catalogs:
- State: CURRENT
- FromDate: 2021-01-01 00:00:00.000000000 +00:00
+ FromDate: 2021-01-01T00:00:00.000+0000
Entries:
- UnitPrice: 0.04
Type: CustomCore:v5-p1
- Title: Instance - On demand - Unite de vCore pour une instance
- Tina v5 CxRy Performance highest - par heure
+ Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure
SubregionName: eu-west-2
Category: compute
Service: TinaOS-FCU
@@ -20089,7 +19115,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Catalog
- "/ReadClientGateways":
+ /ReadClientGateways:
post:
description: Lists one or more of your client gateways.
operationId: ReadClientGateways
@@ -20097,7 +19123,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadClientGatewaysRequest"
+ $ref: '#/components/schemas/ReadClientGatewaysRequest'
examples:
ex1:
value:
@@ -20117,7 +19143,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadClientGatewaysResponse"
+ $ref: '#/components/schemas/ReadClientGatewaysResponse'
examples:
ex1:
value:
@@ -20133,7 +19159,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- ClientGateway
- "/ReadConsoleOutput":
+ /ReadConsoleOutput:
post:
description: |-
Gets the console output for a virtual machine (VM). This console is not in real-time. It is refreshed every two seconds and provides the most recent 64 KiB output.
@@ -20145,7 +19171,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadConsoleOutputRequest"
+ $ref: '#/components/schemas/ReadConsoleOutputRequest'
examples:
ex1:
value:
@@ -20155,45 +19181,44 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadConsoleOutputResponse"
+ $ref: '#/components/schemas/ReadConsoleOutputResponse'
examples:
ex1:
value:
VmId: i-12345678
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
- ConsoleOutput: "..."
+ ConsoleOutput: ...
description: The HTTP 200 response (OK).
'400':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Vm
- "/ReadConsumptionAccount":
+ /ReadConsumptionAccount:
post:
- description: Gets information about the consumption of your OUTSCALE account
- for each billable resource within the specified time period.
+ description: Gets information about the consumption of your OUTSCALE account for each billable resource within the specified time period.
operationId: ReadConsumptionAccount
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadConsumptionAccountRequest"
+ $ref: '#/components/schemas/ReadConsumptionAccountRequest'
examples:
ex1:
value:
@@ -20212,44 +19237,40 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadConsumptionAccountResponse"
+ $ref: '#/components/schemas/ReadConsumptionAccountResponse'
examples:
ex1:
- summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails
- at false
+ summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails at false
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
ConsumptionEntries:
- UnitPrice: 0.18
Type: BoxUsage:tinav5.c4r8p2
- - FromDate: 2023-06-01 00:00:00.000000000 +00:00
+ - FromDate: 2023-06-01T00:00:00.000+0000
SubregionName: eu-west-2a
Value: 1488
- Title: Instance - On demand - tinav5.c4r8 high performance -
- par heure
+ Title: Instance - On demand - tinav5.c4r8 high performance - par heure
Category: compute
- ToDate: 2023-06-30 00:00:00.000000000 +00:00
+ ToDate: 2023-06-30T00:00:00.000+0000
Service: TinaOS-FCU
AccountId: '123456789012'
PayingAccountId: '123456789012'
Operation: RunInstances-OD
Type: BoxUsage:tinav5.c4r8p2
ex2:
- summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails
- at true
+ summary: ReadConsumptionAccount with ShowPrice and ShowResourceDetails at true
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
Currency: EUR
ConsumptionEntries:
- - FromDate: 2023-06-01 00:00:00.000000000 +00:00
+ - FromDate: 2023-06-01T00:00:00.000+0000
SubregionName: eu-west-2a
Value: 720
- Title: Instance - On demand - tinav5.c4r8 high performance -
- par heure
+ Title: Instance - On demand - tinav5.c4r8 high performance - par heure
Category: compute
- ToDate: 2023-06-30 00:00:00.000000000 +00:00
+ ToDate: 2023-06-30T00:00:00.000+0000
Service: TinaOS-FCU
AccountId: '123456789012'
PayingAccountId: '123456789012'
@@ -20258,13 +19279,12 @@ paths:
UnitPrice: 0.18
Price: 267.84
ResourceId: i-12345678
- - FromDate: 2023-06-01 00:00:00.000000000 +00:00
+ - FromDate: 2023-06-01T00:00:00.000+0000
SubregionName: eu-west-2a
Value: 1488
- Title: Instance - On demand - tinav5.c4r8p2 high performance
- - par heure
+ Title: Instance - On demand - tinav5.c4r8p2 high performance - par heure
Category: compute
- ToDate: 2023-06-30 00:00:00.000000000 +00:00
+ ToDate: 2023-06-30T00:00:00.000+0000
Service: TinaOS-FCU
AccountId: '123456789012'
PayingAccountId: '123456789012'
@@ -20276,7 +19296,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/ReadDedicatedGroups":
+ /ReadDedicatedGroups:
post:
description: List one or more dedicated groups of virtual machines (VMs).
operationId: ReadDedicatedGroups
@@ -20284,7 +19304,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDedicatedGroupsRequest"
+ $ref: '#/components/schemas/ReadDedicatedGroupsRequest'
examples:
ex1:
summary: Filtering on a specific dedicated group
@@ -20305,7 +19325,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDedicatedGroupsResponse"
+ $ref: '#/components/schemas/ReadDedicatedGroupsResponse'
examples:
ex1:
value:
@@ -20325,32 +19345,31 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- DedicatedGroup
- "/ReadDhcpOptions":
+ /ReadDhcpOptions:
post:
- description: Gets information about the content of one or more DHCP options
- sets.
+ description: Gets information about the content of one or more DHCP options sets.
operationId: ReadDhcpOptions
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDhcpOptionsRequest"
+ $ref: '#/components/schemas/ReadDhcpOptionsRequest'
examples:
ex1:
value:
@@ -20370,7 +19389,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDhcpOptionsResponse"
+ $ref: '#/components/schemas/ReadDhcpOptionsResponse'
examples:
ex1:
value:
@@ -20390,7 +19409,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DhcpOption
- "/ReadDirectLinkInterfaces":
+ /ReadDirectLinkInterfaces:
post:
description: Lists one or more of your DirectLink interfaces.
operationId: ReadDirectLinkInterfaces
@@ -20398,7 +19417,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDirectLinkInterfacesRequest"
+ $ref: '#/components/schemas/ReadDirectLinkInterfacesRequest'
examples:
ex1:
value:
@@ -20410,7 +19429,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDirectLinkInterfacesResponse"
+ $ref: '#/components/schemas/ReadDirectLinkInterfacesResponse'
examples:
ex1:
value:
@@ -20433,7 +19452,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DirectLinkInterface
- "/ReadDirectLinks":
+ /ReadDirectLinks:
post:
description: Lists all DirectLinks in the Region.
operationId: ReadDirectLinks
@@ -20441,7 +19460,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDirectLinksRequest"
+ $ref: '#/components/schemas/ReadDirectLinksRequest'
examples:
ex1:
value:
@@ -20453,7 +19472,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadDirectLinksResponse"
+ $ref: '#/components/schemas/ReadDirectLinksResponse'
examples:
ex1:
value:
@@ -20470,16 +19489,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- DirectLink
- "/ReadEntitiesLinkedToPolicy":
+ /ReadEntitiesLinkedToPolicy:
post:
- description: Lists all entities (account, users, or user groups) linked to a
- specific managed policy.
+ description: Lists all entities (account, users, or user groups) linked to a specific managed policy.
operationId: ReadEntitiesLinkedToPolicy
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyRequest"
+ $ref: '#/components/schemas/ReadEntitiesLinkedToPolicyRequest'
examples:
ex1:
summary: Reading all entities linked to a specific policy
@@ -20497,7 +19515,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadEntitiesLinkedToPolicyResponse"
+ $ref: '#/components/schemas/ReadEntitiesLinkedToPolicyResponse'
examples:
ex1:
summary: Reading all entities linked to a specific policy
@@ -20530,7 +19548,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadFlexibleGpuCatalog":
+ /ReadFlexibleGpuCatalog:
post:
description: Lists all flexible GPUs available in the public catalog.
operationId: ReadFlexibleGpuCatalog
@@ -20538,7 +19556,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadFlexibleGpuCatalogRequest"
+ $ref: '#/components/schemas/ReadFlexibleGpuCatalogRequest'
examples:
ex1:
value: {}
@@ -20547,7 +19565,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadFlexibleGpuCatalogResponse"
+ $ref: '#/components/schemas/ReadFlexibleGpuCatalogResponse'
examples:
ex1:
value:
@@ -20564,16 +19582,15 @@ paths:
security: []
tags:
- FlexibleGpu
- "/ReadFlexibleGpus":
+ /ReadFlexibleGpus:
post:
- description: Lists one or more flexible GPUs (fGPUs) allocated to your OUTSCALE
- account.
+ description: Lists one or more flexible GPUs (fGPUs) allocated to your OUTSCALE account.
operationId: ReadFlexibleGpus
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadFlexibleGpusRequest"
+ $ref: '#/components/schemas/ReadFlexibleGpusRequest'
examples:
ex1:
value:
@@ -20593,7 +19610,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadFlexibleGpusResponse"
+ $ref: '#/components/schemas/ReadFlexibleGpusResponse'
examples:
ex1:
value:
@@ -20611,7 +19628,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- FlexibleGpu
- "/ReadImageExportTasks":
+ /ReadImageExportTasks:
post:
description: Lists one or more image export tasks.
operationId: ReadImageExportTasks
@@ -20619,7 +19636,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadImageExportTasksRequest"
+ $ref: '#/components/schemas/ReadImageExportTasksRequest'
examples:
ex1:
value:
@@ -20631,7 +19648,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadImageExportTasksResponse"
+ $ref: '#/components/schemas/ReadImageExportTasksResponse'
examples:
ex1:
value:
@@ -20651,7 +19668,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Image
- "/ReadImages":
+ /ReadImages:
post:
description: Lists one or more OUTSCALE machine images (OMIs) you can use.
operationId: ReadImages
@@ -20659,7 +19676,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadImagesRequest"
+ $ref: '#/components/schemas/ReadImagesRequest'
examples:
ex1:
summary: Reading a specific image
@@ -20681,7 +19698,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadImagesResponse"
+ $ref: '#/components/schemas/ReadImagesResponse'
examples:
ex1:
summary: Reading a specific image
@@ -20693,7 +19710,7 @@ paths:
StateComment: {}
State: available
RootDeviceType: bsu
- RootDeviceName: "/dev/sda1"
+ RootDeviceName: /dev/sda1
ProductCodes:
- '0001'
PermissionsToLaunch:
@@ -20704,7 +19721,7 @@ paths:
Description: ''
ImageId: ami-12345678
BlockDeviceMappings:
- - DeviceName: "/dev/sda1"
+ - DeviceName: /dev/sda1
Bsu:
VolumeType: standard
DeleteOnVmDeletion: true
@@ -20728,7 +19745,7 @@ paths:
StateComment: {}
State: available
RootDeviceType: bsu
- RootDeviceName: "/dev/sda1"
+ RootDeviceName: /dev/sda1
ProductCodes:
- '0001'
PermissionsToLaunch:
@@ -20739,7 +19756,7 @@ paths:
Description: ''
ImageId: ami-12345678
BlockDeviceMappings:
- - DeviceName: "/dev/sda1"
+ - DeviceName: /dev/sda1
Bsu:
VolumeType: standard
DeleteOnVmDeletion: true
@@ -20755,7 +19772,7 @@ paths:
StateComment: {}
State: available
RootDeviceType: bsu
- RootDeviceName: "/dev/sda1"
+ RootDeviceName: /dev/sda1
ProductCodes:
- '0001'
PermissionsToLaunch:
@@ -20766,7 +19783,7 @@ paths:
Description: ''
ImageId: ami-12345678
BlockDeviceMappings:
- - DeviceName: "/dev/sda1"
+ - DeviceName: /dev/sda1
Bsu:
VolumeType: standard
DeleteOnVmDeletion: true
@@ -20786,23 +19803,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Image
- "/ReadInternetServices":
+ /ReadInternetServices:
post:
description: |-
Lists one or more of your internet services.
@@ -20812,7 +19829,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadInternetServicesRequest"
+ $ref: '#/components/schemas/ReadInternetServicesRequest'
examples:
ex1:
value:
@@ -20832,7 +19849,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadInternetServicesResponse"
+ $ref: '#/components/schemas/ReadInternetServicesResponse'
examples:
ex1:
value:
@@ -20850,23 +19867,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- InternetService
- "/ReadKeypairs":
+ /ReadKeypairs:
post:
description: Lists one or more of your keypairs.
operationId: ReadKeypairs
@@ -20874,7 +19891,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadKeypairsRequest"
+ $ref: '#/components/schemas/ReadKeypairsRequest'
examples:
ex1:
value:
@@ -20886,7 +19903,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadKeypairsResponse"
+ $ref: '#/components/schemas/ReadKeypairsResponse'
examples:
ex1:
value:
@@ -20902,23 +19919,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Keypair
- "/ReadLinkedPolicies":
+ /ReadLinkedPolicies:
post:
description: Lists the managed policies linked to a specified user.
operationId: ReadLinkedPolicies
@@ -20926,12 +19943,12 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLinkedPoliciesRequest"
+ $ref: '#/components/schemas/ReadLinkedPoliciesRequest'
examples:
ex1:
value:
Filters:
- PathPrefix: "/example/"
+ PathPrefix: /example/
FirstItem: 1
ResultsPerPage: 30
UserName: example-user
@@ -20940,7 +19957,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLinkedPoliciesResponse"
+ $ref: '#/components/schemas/ReadLinkedPoliciesResponse'
examples:
ex1:
value:
@@ -20949,8 +19966,8 @@ paths:
HasMoreItems: true
Policies:
- PolicyName: example-user-policy
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ LastModificationDate: 2010-10-01T12:34:56.789+0000
Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy
PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234
MaxResultsLimit: 30
@@ -20958,16 +19975,15 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadListenerRules":
+ /ReadListenerRules:
post:
- description: Lists one or more listener rules. By default, this action returns
- the full list of listener rules for the OUTSCALE account.
+ description: Lists one or more listener rules. By default, this action returns the full list of listener rules for the OUTSCALE account.
operationId: ReadListenerRules
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadListenerRulesRequest"
+ $ref: '#/components/schemas/ReadListenerRulesRequest'
examples:
ex1:
value:
@@ -20979,7 +19995,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadListenerRulesResponse"
+ $ref: '#/components/schemas/ReadListenerRulesResponse'
examples:
ex1:
value:
@@ -20992,12 +20008,12 @@ paths:
ListenerRuleName: example-listener-rule
Action: forward
ListenerId: 123456
- HostNamePattern: "*.example.com"
+ HostNamePattern: '*.example.com'
ListenerRuleId: 1234
description: The HTTP 200 response (OK).
tags:
- Listener
- "/ReadLoadBalancerTags":
+ /ReadLoadBalancerTags:
post:
description: Lists the tags associated with one or more specified load balancers.
operationId: ReadLoadBalancerTags
@@ -21005,7 +20021,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLoadBalancerTagsRequest"
+ $ref: '#/components/schemas/ReadLoadBalancerTagsRequest'
examples:
ex1:
value:
@@ -21016,7 +20032,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLoadBalancerTagsResponse"
+ $ref: '#/components/schemas/ReadLoadBalancerTagsResponse'
examples:
ex1:
value:
@@ -21029,7 +20045,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/ReadLoadBalancers":
+ /ReadLoadBalancers:
post:
description: Lists one or more load balancers and their attributes.
operationId: ReadLoadBalancers
@@ -21037,7 +20053,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLoadBalancersRequest"
+ $ref: '#/components/schemas/ReadLoadBalancersRequest'
examples:
ex1:
value:
@@ -21049,7 +20065,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLoadBalancersResponse"
+ $ref: '#/components/schemas/ReadLoadBalancersResponse'
examples:
ex1:
value:
@@ -21094,7 +20110,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- LoadBalancer
- "/ReadLocations":
+ /ReadLocations:
post:
description: |-
Lists the locations, corresponding to datacenters, where you can set up a DirectLink.
@@ -21104,7 +20120,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLocationsRequest"
+ $ref: '#/components/schemas/ReadLocationsRequest'
examples:
ex1:
value: {}
@@ -21113,7 +20129,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadLocationsResponse"
+ $ref: '#/components/schemas/ReadLocationsResponse'
examples:
ex1:
value:
@@ -21128,7 +20144,7 @@ paths:
security: []
tags:
- Location
- "/ReadManagedPoliciesLinkedToUserGroup":
+ /ReadManagedPoliciesLinkedToUserGroup:
post:
description: Lists the managed policies linked to a specified group.
operationId: ReadManagedPoliciesLinkedToUserGroup
@@ -21136,12 +20152,12 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest"
+ $ref: '#/components/schemas/ReadManagedPoliciesLinkedToUserGroupRequest'
examples:
ex1:
value:
Filters:
- PathPrefix: "/ex"
+ PathPrefix: /ex
UserGroupIds:
- ug-12345678
FirstItem: 1
@@ -21152,7 +20168,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse"
+ $ref: '#/components/schemas/ReadManagedPoliciesLinkedToUserGroupResponse'
examples:
ex1:
value:
@@ -21170,7 +20186,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadNatServices":
+ /ReadNatServices:
post:
description: Lists one or more network address translation (NAT) services.
operationId: ReadNatServices
@@ -21178,7 +20194,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNatServicesRequest"
+ $ref: '#/components/schemas/ReadNatServicesRequest'
examples:
ex1:
value:
@@ -21198,7 +20214,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNatServicesResponse"
+ $ref: '#/components/schemas/ReadNatServicesResponse'
examples:
ex1:
value:
@@ -21218,23 +20234,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NatService
- "/ReadNetAccessPointServices":
+ /ReadNetAccessPointServices:
post:
description: |-
Lists OUTSCALE services available to create Net access points.
@@ -21244,7 +20260,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetAccessPointServicesRequest"
+ $ref: '#/components/schemas/ReadNetAccessPointServicesRequest'
examples:
ex1:
summary: Listing one or more services according to their service IDs
@@ -21264,11 +20280,10 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetAccessPointServicesResponse"
+ $ref: '#/components/schemas/ReadNetAccessPointServicesResponse'
examples:
ex1:
- summary: Listing one or more services according to their service
- IDs
+ summary: Listing one or more services according to their service IDs
value:
Services:
- ServiceName: com.outscale.eu-west-2.api
@@ -21284,8 +20299,7 @@ paths:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
ex2:
- summary: Listing one or more services according to their service
- names
+ summary: Listing one or more services according to their service names
value:
Services:
- ServiceName: com.outscale.eu-west-2.api
@@ -21298,7 +20312,7 @@ paths:
security: []
tags:
- NetAccessPoint
- "/ReadNetAccessPoints":
+ /ReadNetAccessPoints:
post:
description: Lists one or more Net access points.
operationId: ReadNetAccessPoints
@@ -21306,7 +20320,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetAccessPointsRequest"
+ $ref: '#/components/schemas/ReadNetAccessPointsRequest'
examples:
ex1:
value:
@@ -21325,7 +20339,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetAccessPointsResponse"
+ $ref: '#/components/schemas/ReadNetAccessPointsResponse'
examples:
ex1:
value:
@@ -21342,7 +20356,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- NetAccessPoint
- "/ReadNetPeerings":
+ /ReadNetPeerings:
post:
description: Lists one or more peering connections between two Nets.
operationId: ReadNetPeerings
@@ -21350,7 +20364,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetPeeringsRequest"
+ $ref: '#/components/schemas/ReadNetPeeringsRequest'
examples:
ex1:
value:
@@ -21370,7 +20384,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetPeeringsResponse"
+ $ref: '#/components/schemas/ReadNetPeeringsResponse'
examples:
ex1:
value:
@@ -21395,23 +20409,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- NetPeering
- "/ReadNets":
+ /ReadNets:
post:
description: Lists one or more Nets.
operationId: ReadNets
@@ -21419,7 +20433,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetsRequest"
+ $ref: '#/components/schemas/ReadNetsRequest'
examples:
ex1:
value:
@@ -21436,7 +20450,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNetsResponse"
+ $ref: '#/components/schemas/ReadNetsResponse'
examples:
ex1:
value:
@@ -21454,23 +20468,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Net
- "/ReadNics":
+ /ReadNics:
post:
description: |-
Lists one or more network interface cards (NICs).
@@ -21480,7 +20494,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNicsRequest"
+ $ref: '#/components/schemas/ReadNicsRequest'
examples:
ex1:
value:
@@ -21497,7 +20511,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadNicsResponse"
+ $ref: '#/components/schemas/ReadNicsResponse'
examples:
ex1:
value:
@@ -21534,23 +20548,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Nic
- "/ReadPolicies":
+ /ReadPolicies:
post:
description: Lists all the managed policies available for your OUTSCALE account.
operationId: ReadPolicies
@@ -21558,13 +20572,13 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPoliciesRequest"
+ $ref: '#/components/schemas/ReadPoliciesRequest'
examples:
ex1:
value:
Filters:
OnlyLinked: true
- PathPrefix: "/"
+ PathPrefix: /
Scope: OWS
FirstItem: 1
ResultsPerPage: 30
@@ -21573,7 +20587,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPoliciesResponse"
+ $ref: '#/components/schemas/ReadPoliciesResponse'
examples:
ex1:
value:
@@ -21584,19 +20598,19 @@ paths:
- ResourcesCount: 1
PolicyName: example-user-policy
PolicyDefaultVersionId: v1
- Path: "/example/"
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
+ Path: /example/
+ CreationDate: 2010-10-01T12:34:56.789+0000
Description: Example of description
PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234
Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy
IsLinkable: true
- LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ LastModificationDate: 2010-10-01T12:34:56.789+0000
MaxResultsLimit: 30
MaxResultsTruncated: false
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadPolicy":
+ /ReadPolicy:
post:
description: Lists information about a specified managed policy.
operationId: ReadPolicy
@@ -21604,7 +20618,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyRequest"
+ $ref: '#/components/schemas/ReadPolicyRequest'
examples:
ex1:
value:
@@ -21614,7 +20628,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyResponse"
+ $ref: '#/components/schemas/ReadPolicyResponse'
examples:
ex1:
value:
@@ -21622,19 +20636,19 @@ paths:
ResourcesCount: 0
PolicyName: example-user-policy
PolicyDefaultVersionId: v1
- Path: "/example/"
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
+ Path: /example/
+ CreationDate: 2010-10-01T12:34:56.789+0000
Description: Example of description
PolicyId: ABCDEFGHIJKLMNOPQRSTUVWXYZ01234
Orn: orn:ows:idauth::012345678910:policy/example/example-user-policy
IsLinkable: true
- LastModificationDate: 2010-10-01 12:34:56.789000000 +00:00
+ LastModificationDate: 2010-10-01T12:34:56.789+0000
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadPolicyVersion":
+ /ReadPolicyVersion:
post:
description: Lists information about a specified version of a managed policy.
operationId: ReadPolicyVersion
@@ -21642,7 +20656,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyVersionRequest"
+ $ref: '#/components/schemas/ReadPolicyVersionRequest'
examples:
ex1:
value:
@@ -21653,7 +20667,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyVersionResponse"
+ $ref: '#/components/schemas/ReadPolicyVersionResponse'
examples:
ex1:
value:
@@ -21662,22 +20676,20 @@ paths:
PolicyVersion:
VersionId: v1
DefaultVersion: true
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadPolicyVersions":
+ /ReadPolicyVersions:
post:
- description: Lists information about all the policy versions of a specified
- managed policy.
+ description: Lists information about all the policy versions of a specified managed policy.
operationId: ReadPolicyVersions
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyVersionsRequest"
+ $ref: '#/components/schemas/ReadPolicyVersionsRequest'
examples:
ex1:
value:
@@ -21689,7 +20701,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPolicyVersionsResponse"
+ $ref: '#/components/schemas/ReadPolicyVersionsResponse'
examples:
ex1:
value:
@@ -21699,14 +20711,13 @@ paths:
PolicyVersions:
- VersionId: v1
DefaultVersion: true
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"],
- "Resource": ["*"]} ]}'
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ Body: '{"Statement": [ {"Effect": "Allow", "Action": ["*"], "Resource": ["*"]} ]}'
HasMoreItems: true
description: The HTTP 200 response (OK).
tags:
- Policy
- "/ReadProductTypes":
+ /ReadProductTypes:
post:
description: Lists one or more product types.
operationId: ReadProductTypes
@@ -21714,7 +20725,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadProductTypesRequest"
+ $ref: '#/components/schemas/ReadProductTypesRequest'
examples:
ex1:
value:
@@ -21726,7 +20737,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadProductTypesResponse"
+ $ref: '#/components/schemas/ReadProductTypesResponse'
examples:
ex1:
value:
@@ -21739,17 +20750,15 @@ paths:
security: []
tags:
- ProductType
- "/ReadPublicCatalog":
+ /ReadPublicCatalog:
post:
- description: Returns the price list of OUTSCALE products and services for the
- Region specified in the endpoint of the request. For more information, see
- [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html).
+ description: Returns the price list of OUTSCALE products and services for the Region specified in the endpoint of the request. For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html).
operationId: ReadPublicCatalog
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicCatalogRequest"
+ $ref: '#/components/schemas/ReadPublicCatalogRequest'
examples:
ex1:
value: {}
@@ -21758,7 +20767,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicCatalogResponse"
+ $ref: '#/components/schemas/ReadPublicCatalogResponse'
examples:
ex1:
value:
@@ -21768,8 +20777,7 @@ paths:
Entries:
- UnitPrice: 0.04
Type: CustomCore:v5-p1
- Title: Instance - On demand - Unite de vCore pour une instance
- Tina v5 CxRy Performance highest - par heure
+ Title: Instance - On demand - Unite de vCore pour une instance Tina v5 CxRy Performance highest - par heure
SubregionName: eu-west-2
Category: compute
Service: TinaOS-FCU
@@ -21778,17 +20786,15 @@ paths:
security: []
tags:
- PublicCatalog
- "/ReadPublicIpRanges":
+ /ReadPublicIpRanges:
post:
- description: Gets the public IPv4 addresses in CIDR notation for the Region
- specified in the endpoint of the request. For more information, see [About
- Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html).
+ description: Gets the public IPv4 addresses in CIDR notation for the Region specified in the endpoint of the request. For more information, see [About Regions and Subregions](https://docs.outscale.com/en/userguide/About-Regions-and-Subregions.html).
operationId: ReadPublicIpRanges
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicIpRangesRequest"
+ $ref: '#/components/schemas/ReadPublicIpRangesRequest'
examples:
ex1:
value: {}
@@ -21797,7 +20803,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicIpRangesResponse"
+ $ref: '#/components/schemas/ReadPublicIpRangesResponse'
examples:
ex1:
value:
@@ -21810,7 +20816,7 @@ paths:
security: []
tags:
- PublicIp
- "/ReadPublicIps":
+ /ReadPublicIps:
post:
description: |-
Lists one or more public IPs allocated to your OUTSCALE account.
@@ -21820,7 +20826,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicIpsRequest"
+ $ref: '#/components/schemas/ReadPublicIpsRequest'
examples:
ex1:
value:
@@ -21837,7 +20843,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadPublicIpsResponse"
+ $ref: '#/components/schemas/ReadPublicIpsResponse'
examples:
ex1:
value:
@@ -21857,23 +20863,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- PublicIp
- "/ReadQuotas":
+ /ReadQuotas:
post:
description: |-
Lists one or more of your quotas.
@@ -21883,7 +20889,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadQuotasRequest"
+ $ref: '#/components/schemas/ReadQuotasRequest'
examples:
ex1:
summary: Reading specific quota
@@ -21902,7 +20908,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadQuotasResponse"
+ $ref: '#/components/schemas/ReadQuotasResponse'
examples:
ex1:
summary: Reading specific quota
@@ -21946,7 +20952,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Quota
- "/ReadRegions":
+ /ReadRegions:
post:
description: |-
Lists one or more Regions of the OUTSCALE Cloud.
@@ -21956,7 +20962,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadRegionsRequest"
+ $ref: '#/components/schemas/ReadRegionsRequest'
examples:
ex1:
value: {}
@@ -21965,7 +20971,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadRegionsResponse"
+ $ref: '#/components/schemas/ReadRegionsResponse'
examples:
ex1:
value:
@@ -21982,7 +20988,7 @@ paths:
security: []
tags:
- Region
- "/ReadRouteTables":
+ /ReadRouteTables:
post:
description: |-
Lists one or more of your route tables.
@@ -21992,7 +20998,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadRouteTablesRequest"
+ $ref: '#/components/schemas/ReadRouteTablesRequest'
examples:
ex1:
value:
@@ -22011,7 +21017,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadRouteTablesResponse"
+ $ref: '#/components/schemas/ReadRouteTablesResponse'
examples:
ex1:
value:
@@ -22036,23 +21042,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- RouteTable
- "/ReadSecurityGroups":
+ /ReadSecurityGroups:
post:
description: |-
Lists one or more security groups.
@@ -22062,7 +21068,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSecurityGroupsRequest"
+ $ref: '#/components/schemas/ReadSecurityGroupsRequest'
examples:
ex1:
value:
@@ -22079,7 +21085,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSecurityGroupsResponse"
+ $ref: '#/components/schemas/ReadSecurityGroupsResponse'
examples:
ex1:
value:
@@ -22088,7 +21094,7 @@ paths:
SecurityGroupName: security-group-example
OutboundRules:
- FromPortRange: -1
- IpProtocol: "-1"
+ IpProtocol: '-1'
ToPortRange: -1
IpRanges:
- 0.0.0.0/0
@@ -22110,23 +21116,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- SecurityGroup
- "/ReadServerCertificates":
+ /ReadServerCertificates:
post:
description: Lists your server certificates.
operationId: ReadServerCertificates
@@ -22134,24 +21140,24 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadServerCertificatesRequest"
+ $ref: '#/components/schemas/ReadServerCertificatesRequest'
examples:
ex1:
value:
Filters:
Paths:
- - "/example/"
+ - /example/
responses:
'200':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadServerCertificatesResponse"
+ $ref: '#/components/schemas/ReadServerCertificatesResponse'
examples:
ex1:
value:
ServerCertificates:
- - Path: "/example/"
+ - Path: /example/
Id: ABCDEFGHIJKLMNOPQRSTUVWXYZ1234
Orn: orn:ows:idauth::012345678910:server-certificate/example/server-cert-example
Name: server-cert-example
@@ -22160,7 +21166,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- ServerCertificate
- "/ReadSnapshotExportTasks":
+ /ReadSnapshotExportTasks:
post:
description: Lists one or more snapshot export tasks.
operationId: ReadSnapshotExportTasks
@@ -22168,7 +21174,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSnapshotExportTasksRequest"
+ $ref: '#/components/schemas/ReadSnapshotExportTasksRequest'
examples:
ex1:
value:
@@ -22180,7 +21186,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSnapshotExportTasksResponse"
+ $ref: '#/components/schemas/ReadSnapshotExportTasksResponse'
examples:
ex1:
value:
@@ -22194,22 +21200,21 @@ paths:
DiskImageFormat: qcow2
State: pending
SnapshotId: snap-12345678
- Progress: 99
+ Progress: 13
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
description: The HTTP 200 response (OK).
tags:
- Snapshot
- "/ReadSnapshots":
+ /ReadSnapshots:
post:
- description: Lists one or more snapshots that are available to you and the permissions
- to create volumes from them.
+ description: Lists one or more snapshots that are available to you and the permissions to create volumes from them.
operationId: ReadSnapshots
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSnapshotsRequest"
+ $ref: '#/components/schemas/ReadSnapshotsRequest'
examples:
ex1:
value:
@@ -22229,7 +21234,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSnapshotsResponse"
+ $ref: '#/components/schemas/ReadSnapshotsResponse'
examples:
ex1:
value:
@@ -22272,23 +21277,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Snapshot
- "/ReadSubnets":
+ /ReadSubnets:
post:
description: |-
Lists one or more of your Subnets.
@@ -22298,7 +21303,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSubnetsRequest"
+ $ref: '#/components/schemas/ReadSubnetsRequest'
examples:
ex1:
value:
@@ -22318,7 +21323,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ReadSubnetsResponse"
+ $ref: '#/components/schemas/ReadSubnetsResponse'
examples:
ex1:
value:
@@ -22338,23 +21343,23 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
tags:
- Subnet
- "/ReadSubregions":
+ /ReadSubregions:
post:
description: |-
Lists one or more of the enabled Subregions that you can access in the current Region.
@@ -24297,7 +23344,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateAccessKeyRequest"
+ $ref: '#/components/schemas/UpdateAccessKeyRequest'
examples:
ex1:
summary: Updating the expiration date of the access key
@@ -24306,8 +23353,7 @@ paths:
State: ACTIVE
ExpirationDate: '2063-04-05'
ex2:
- summary: Updating the state of one of your own access keys (if you
- are the root user or an EIM user)
+ summary: Updating the state of one of your own access keys (if you are the root user or an EIM user)
value:
AccessKeyId: ABCDEFGHIJ0123456789
State: ACTIVE
@@ -24322,7 +23368,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateAccessKeyResponse"
+ $ref: '#/components/schemas/UpdateAccessKeyResponse'
examples:
ex1:
summary: Updating an access key when using the parameter ExpirationDate
@@ -24332,9 +23378,9 @@ paths:
AccessKey:
State: ACTIVE
AccessKeyId: ABCDEFGHIJ0123456789
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- ExpirationDate: 2063-04-05 00:00:00.000000000 +00:00
- LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ ExpirationDate: 2063-04-05T00:00:00.000+0000
+ LastModificationDate: 2017-05-10T12:34:56.789+0000
Tag: Group1
ex2:
summary: Updating an access key when not using the parameter ExpirationDate
@@ -24344,8 +23390,8 @@ paths:
AccessKey:
State: ACTIVE
AccessKeyId: ABCDEFGHIJ0123456789
- CreationDate: 2010-10-01 12:34:56.789000000 +00:00
- LastModificationDate: 2017-05-10 12:34:56.789000000 +00:00
+ CreationDate: 2010-10-01T12:34:56.789+0000
+ LastModificationDate: 2017-05-10T12:34:56.789+0000
Tag: Group1
description: The HTTP 200 response (OK).
security:
@@ -24353,16 +23399,15 @@ paths:
- BasicAuth: []
tags:
- AccessKey
- "/UpdateAccount":
+ /UpdateAccount:
post:
- description: Updates the OUTSCALE account information for the account that sends
- the request.
+ description: Updates the OUTSCALE account information for the account that sends the request.
operationId: UpdateAccount
requestBody:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateAccountRequest"
+ $ref: '#/components/schemas/UpdateAccountRequest'
examples:
ex1:
value:
@@ -24374,7 +23419,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateAccountResponse"
+ $ref: '#/components/schemas/UpdateAccountResponse'
examples:
ex1:
value:
@@ -24396,7 +23441,7 @@ paths:
description: The HTTP 200 response (OK).
tags:
- Account
- "/UpdateApiAccessPolicy":
+ /UpdateApiAccessPolicy:
post:
description: |-
Updates the API access policy of your OUTSCALE account.
@@ -24408,7 +23453,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateApiAccessPolicyRequest"
+ $ref: '#/components/schemas/UpdateApiAccessPolicyRequest'
examples:
ex1:
summary: Require expiration dates of maximum 1 year
@@ -24416,14 +23461,12 @@ paths:
MaxAccessKeyExpirationSeconds: 31536000
RequireTrustedEnv: false
ex2:
- summary: Require expiration dates of maximum 100 years and activate
- a trusted session
+ summary: Require expiration dates of maximum 100 years and activate a trusted session
value:
MaxAccessKeyExpirationSeconds: 3153600000
RequireTrustedEnv: true
ex3:
- summary: Do not require expiration dates and deactivate a trusted
- session
+ summary: Do not require expiration dates and deactivate a trusted session
value:
MaxAccessKeyExpirationSeconds: 0
RequireTrustedEnv: false
@@ -24432,7 +23475,7 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/UpdateApiAccessPolicyResponse"
+ $ref: '#/components/schemas/UpdateApiAccessPolicyResponse'
examples:
ex1:
summary: Require expiration dates of maximum 1 year
@@ -24443,8 +23486,7 @@ paths:
RequireTrustedEnv: false
MaxAccessKeyExpirationSeconds: 31536000
ex2:
- summary: Require expiration dates of maximum 100 years and activate
- a trusted session
+ summary: Require expiration dates of maximum 100 years and activate a trusted session
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
@@ -24452,8 +23494,7 @@ paths:
RequireTrustedEnv: true
MaxAccessKeyExpirationSeconds: 3153600000
ex3:
- summary: Do not require expiration dates and deactivate a trusted
- session
+ summary: Do not require expiration dates and deactivate a trusted session
value:
ResponseContext:
RequestId: 0475ca1e-d0c5-441d-712a-da55a4175157
@@ -24465,26 +23506,26 @@ paths:
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 400 response (Bad Request).
'401':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 401 response (Unauthorized).
'500':
content:
application/json:
schema:
- "$ref": "#/components/schemas/ErrorResponse"
+ $ref: '#/components/schemas/ErrorResponse'
description: The HTTP 500 response (Internal Server Error).
security:
- ApiKeyAuthSec: []
- BasicAuth: []
tags:
- ApiAccessPolicy
- "/UpdateApiAccessRule":
+ /UpdateApiAccessRule:
post:
description: |-
Modifies a specified API access rule.