feat(instance): add endpoints to attach/detach server volumes (#370)

Author: scaleway-bot

scaleway-async/scaleway_async/instance/v1/__init__.py

@@ -1,6 +1,7 @@
 # This file was automatically generated. DO NOT EDIT.
 # If you have any remark or suggestion do not hesitate to open an issue.
 from .types import Arch
+from .types import AttachServerVolumeRequestVolumeType
 from .types import BootType
 from .types import ImageState
 from .types import IpState
@@ -27,6 +28,7 @@
 from .types import VolumeServerVolumeType
 from .types import VolumeState
 from .types import VolumeVolumeType
+from .types import AttachServerVolumeResponse
 from .types import Bootscript
 from .types import CreateImageResponse
 from .types import CreateIpResponse
@@ -38,6 +40,7 @@
 from .types import CreateSnapshotResponse
 from .types import CreateVolumeResponse
 from .types import Dashboard
+from .types import DetachServerVolumeResponse
 from .types import ExportSnapshotResponse
 from .types import GetBootscriptResponse
 from .types import GetDashboardResponse
@@ -125,6 +128,7 @@
 
 __all__ = [
     "Arch",
+    "AttachServerVolumeRequestVolumeType",
     "BootType",
     "ImageState",
     "IpState",
@@ -151,6 +155,7 @@
     "VolumeServerVolumeType",
     "VolumeState",
     "VolumeVolumeType",
+    "AttachServerVolumeResponse",
     "Bootscript",
     "CreateImageResponse",
     "CreateIpResponse",
@@ -162,6 +167,7 @@
     "CreateSnapshotResponse",
     "CreateVolumeResponse",
     "Dashboard",
+    "DetachServerVolumeResponse",
     "ExportSnapshotResponse",
     "GetBootscriptResponse",
     "GetDashboardResponse",

scaleway-async/scaleway_async/instance/v1/api.py

@@ -15,6 +15,7 @@
 )
 from .types import (
     Arch,
+    AttachServerVolumeRequestVolumeType,
     BootType,
     ImageState,
     IpType,
@@ -30,6 +31,7 @@
     SnapshotState,
     SnapshotVolumeType,
     VolumeVolumeType,
+    AttachServerVolumeResponse,
     Bootscript,
     CreateImageResponse,
     CreateIpResponse,
@@ -40,6 +42,7 @@
     CreateServerResponse,
     CreateSnapshotResponse,
     CreateVolumeResponse,
+    DetachServerVolumeResponse,
     ExportSnapshotResponse,
     GetBootscriptResponse,
     GetDashboardResponse,
@@ -101,6 +104,8 @@
     VolumeSummary,
     VolumeTemplate,
     ServerActionRequest,
+    AttachServerVolumeRequest,
+    DetachServerVolumeRequest,
     CreateImageRequest,
     CreateSnapshotRequest,
     ExportSnapshotRequest,
@@ -137,6 +142,7 @@
 )
 from .marshalling import (
     marshal_ApplyBlockMigrationRequest,
+    marshal_AttachServerVolumeRequest,
     marshal_CreateImageRequest,
     marshal_CreateIpRequest,
     marshal_CreatePlacementGroupRequest,
@@ -145,6 +151,7 @@
     marshal_CreateSecurityGroupRuleRequest,
     marshal_CreateSnapshotRequest,
     marshal_CreateVolumeRequest,
+    marshal_DetachServerVolumeRequest,
     marshal_ExportSnapshotRequest,
     marshal_PlanBlockMigrationRequest,
     marshal_ServerActionRequest,
@@ -164,6 +171,7 @@
     marshal__SetSnapshotRequest,
     marshal__UpdateServerRequest,
     unmarshal_PrivateNIC,
+    unmarshal_AttachServerVolumeResponse,
     unmarshal_CreateImageResponse,
     unmarshal_CreateIpResponse,
     unmarshal_CreatePlacementGroupResponse,
@@ -173,6 +181,7 @@
     unmarshal_CreateServerResponse,
     unmarshal_CreateSnapshotResponse,
     unmarshal_CreateVolumeResponse,
+    unmarshal_DetachServerVolumeResponse,
     unmarshal_ExportSnapshotResponse,
     unmarshal_GetBootscriptResponse,
     unmarshal_GetDashboardResponse,
@@ -972,6 +981,97 @@ async def delete_server_user_data(
         self._throw_on_error(res)
         return None
 
+    async def attach_server_volume(
+        self,
+        *,
+        server_id: str,
+        volume_id: str,
+        volume_type: AttachServerVolumeRequestVolumeType,
+        zone: Optional[Zone] = None,
+        boot: Optional[bool] = None,
+    ) -> AttachServerVolumeResponse:
+        """
+        Attach a volume to a server.
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param server_id: UUID of the Instance.
+        :param volume_id: UUID of the Volume to attach.
+        :param volume_type: Type of the volume to attach.
+        :param boot: Force the Instance to boot on this volume.
+        :return: :class:`AttachServerVolumeResponse <AttachServerVolumeResponse>`
+
+        Usage:
+        ::
+
+            result = await api.attach_server_volume(
+                server_id="example",
+                volume_id="example",
+                volume_type=unknown_volume_type,
+            )
+        """
+
+        param_zone = validate_path_param("zone", zone or self.client.default_zone)
+        param_server_id = validate_path_param("server_id", server_id)
+
+        res = self._request(
+            "POST",
+            f"/instance/v1/zones/{param_zone}/servers/{param_server_id}/attach-volume",
+            body=marshal_AttachServerVolumeRequest(
+                AttachServerVolumeRequest(
+                    server_id=server_id,
+                    volume_id=volume_id,
+                    volume_type=volume_type,
+                    zone=zone,
+                    boot=boot,
+                ),
+                self.client,
+            ),
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_AttachServerVolumeResponse(res.json())
+
+    async def detach_server_volume(
+        self,
+        *,
+        server_id: str,
+        volume_id: str,
+        zone: Optional[Zone] = None,
+    ) -> DetachServerVolumeResponse:
+        """
+        Detach a volume from a server.
+        :param zone: Zone to target. If none is passed will use default zone from the config.
+        :param server_id: UUID of the Instance.
+        :param volume_id: UUID of the Volume to detach.
+        :return: :class:`DetachServerVolumeResponse <DetachServerVolumeResponse>`
+
+        Usage:
+        ::
+
+            result = await api.detach_server_volume(
+                server_id="example",
+                volume_id="example",
+            )
+        """
+
+        param_zone = validate_path_param("zone", zone or self.client.default_zone)
+        param_server_id = validate_path_param("server_id", server_id)
+
+        res = self._request(
+            "POST",
+            f"/instance/v1/zones/{param_zone}/servers/{param_server_id}/detach-volume",
+            body=marshal_DetachServerVolumeRequest(
+                DetachServerVolumeRequest(
+                    server_id=server_id,
+                    volume_id=volume_id,
+                    zone=zone,
+                ),
+                self.client,
+            ),
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_DetachServerVolumeResponse(res.json())
+
     async def list_images(
         self,
         *,

scaleway-async/scaleway_async/instance/v1/marshalling.py

@@ -11,6 +11,7 @@
 from dateutil import parser
 from .types import (
     Arch,
+    AttachServerVolumeRequestVolumeType,
     BootType,
     ImageState,
     IpType,
@@ -30,6 +31,7 @@
     SnapshotVolumeType,
     VolumeState,
     VolumeVolumeType,
+    AttachServerVolumeResponse,
     Bootscript,
     CreateImageResponse,
     CreateIpResponse,
@@ -41,6 +43,7 @@
     CreateSnapshotResponse,
     CreateVolumeResponse,
     Dashboard,
+    DetachServerVolumeResponse,
     ExportSnapshotResponse,
     GetBootscriptResponse,
     GetDashboardResponse,
@@ -115,6 +118,8 @@
     VolumeTypeCapabilities,
     VolumeTypeConstraints,
     ServerActionRequest,
+    AttachServerVolumeRequest,
+    DetachServerVolumeRequest,
     CreateImageRequest,
     CreateSnapshotRequest,
     ExportSnapshotRequest,
@@ -1262,6 +1267,20 @@ def unmarshal_VolumeType(data: Any) -> VolumeType:
     return VolumeType(**args)
 
 
+def unmarshal_AttachServerVolumeResponse(data: Any) -> AttachServerVolumeResponse:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'AttachServerVolumeResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("server", None)
+    args["server"] = unmarshal_Server(field) if field is not None else None
+
+    return AttachServerVolumeResponse(**args)
+
+
 def unmarshal_CreateImageResponse(data: Any) -> CreateImageResponse:
     if type(data) is not dict:
         raise TypeError(
@@ -1397,6 +1416,20 @@ def unmarshal_CreateVolumeResponse(data: Any) -> CreateVolumeResponse:
     return CreateVolumeResponse(**args)
 
 
+def unmarshal_DetachServerVolumeResponse(data: Any) -> DetachServerVolumeResponse:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'DetachServerVolumeResponse' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("server", None)
+    args["server"] = unmarshal_Server(field) if field is not None else None
+
+    return DetachServerVolumeResponse(**args)
+
+
 def unmarshal_ExportSnapshotResponse(data: Any) -> ExportSnapshotResponse:
     if type(data) is not dict:
         raise TypeError(
@@ -2645,6 +2678,24 @@ def marshal_ApplyBlockMigrationRequest(
     return output
 
 
+def marshal_AttachServerVolumeRequest(
+    request: AttachServerVolumeRequest,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    output: Dict[str, Any] = {}
+
+    if request.boot is not None:
+        output["boot"] = request.boot
+
+    if request.volume_id is not None:
+        output["volume_id"] = request.volume_id
+
+    if request.volume_type is not None:
+        output["volume_type"] = AttachServerVolumeRequestVolumeType(request.volume_type)
+
+    return output
+
+
 def marshal_CreateImageRequest(
     request: CreateImageRequest,
     defaults: ProfileDefaults,
@@ -3007,6 +3058,18 @@ def marshal_CreateVolumeRequest(
     return output
 
 
+def marshal_DetachServerVolumeRequest(
+    request: DetachServerVolumeRequest,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    output: Dict[str, Any] = {}
+
+    if request.volume_id is not None:
+        output["volume_id"] = request.volume_id
+
+    return output
+
+
 def marshal_ExportSnapshotRequest(
     request: ExportSnapshotRequest,
     defaults: ProfileDefaults,