yicloud-sdk-python 0.3.0__tar.gz → 0.3.1__tar.gz

{yicloud_sdk_python-0.3.0 → yicloud_sdk_python-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yicloud-sdk-python
-Version: 0.3.0
+Version: 0.3.1
 Summary: YiCloud OpenAPI SDK for Python
 Author: YiCloud
 Project-URL: Homepage, https://gitee.com/yicloud-team/openapi-sdk-python

{yicloud_sdk_python-0.3.0 → yicloud_sdk_python-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "yicloud-sdk-python"
-version = "0.3.0"
+version = "0.3.1"
 description = "YiCloud OpenAPI SDK for Python"
 readme = "README.md"
 requires-python = ">=3.7"

{yicloud_sdk_python-0.3.0 → yicloud_sdk_python-0.3.1}/version.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 
 def Version() -> str:

{yicloud_sdk_python-0.3.0 → yicloud_sdk_python-0.3.1}/yicloud/__init__.py

@@ -4,4 +4,4 @@ YiCloud Python SDK
 A Python SDK for the YiCloud OpenAPI service.
 """
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"

{yicloud_sdk_python-0.3.0 → yicloud_sdk_python-0.3.1}/yicloud/services/__init__.py

@@ -13,6 +13,7 @@ from . import monitor
 from . import oss
 from . import ray
 from . import registry
+from . import sandbox
 from . import volume
 from . import workspace
 
@@ -29,6 +30,7 @@ __all__ = [
     "oss",
     "ray",
     "registry",
+    "sandbox",
     "volume",
     "workspace",
 ]

yicloud_sdk_python-0.3.1/yicloud/services/sandbox/__init__.py

@@ -0,0 +1,111 @@
+# Code generated by generate_openapi.py. DO NOT EDIT.
+
+from yicloud.services.sandbox.client import SandboxClient as Client, client, use_client
+from . import actions, models
+
+# Re-export action functions
+from .actions import (
+    batch_delete_sandboxes,
+    create_sandbox,
+    create_sandbox_environment,
+    delete_sandbox,
+    delete_sandbox_environment,
+    get_instance_state_stats,
+    get_prewarm_pool,
+    get_resource_stats,
+    get_sandbox,
+    get_sandbox_environment,
+    list_prewarm_pool_events,
+    list_prewarm_pool_pods,
+    list_sandbox_environments,
+    list_sandbox_projects,
+    list_sandboxes,
+    stop_sandbox,
+    update_instance_capacity,
+    update_prewarm_size,
+    update_sandbox_lifecycle,
+)
+
+# Re-export models
+from .models import (
+    ActualMode,
+    AllocationMode,
+    Kind,
+    Level,
+    Mode,
+    PoolPodState,
+    Protocol,
+    RunState,
+    State,
+    TerminatedReason,
+    Type,
+    BatchDeleteResultItem,
+    BatchDeleteSandboxesData,
+    BatchDeleteSandboxesReq,
+    CreateSandboxData,
+    CreateSandboxEnvironmentReq,
+    CreateSandboxReq,
+    EnvironmentInstanceCounts,
+    EnvironmentResourceUsage,
+    Image,
+    ImageAuth,
+    CreateSandboxReqImageAuth,
+    CreateSandboxEnvironmentReqImageAuth,
+    CreateSandboxReqImageInput,
+    CreateSandboxEnvironmentReqImageInput,
+    GetInstanceStateStatsData,
+    ListPrewarmPoolEventsData,
+    ListPrewarmPoolPodsData,
+    ListSandboxEnvironmentsData,
+    ListSandboxProjectsData,
+    ListSandboxesData,
+    ModeInstanceStateCluster,
+    Port,
+    CreateSandboxReqPort,
+    CreateSandboxEnvironmentReqPort,
+    GetPrewarmPoolData,
+    PrewarmPoolEvent,
+    PrewarmPoolPod,
+    PrewarmPoolStatus,
+    GetResourceStatsData,
+    Resources,
+    CreateSandboxReqResources,
+    CreateSandboxEnvironmentReqResources,
+    SandboxEndpointInfo,
+    SandboxEndpoints,
+    DeleteSandboxEnvironmentReq,
+    CreateSandboxEnvironmentData,
+    DeleteSandboxReq,
+    StopSandboxReq,
+    GetSandboxData,
+    StateStatus,
+    UpdateInstanceCapacityReq,
+    UpdatePrewarmSizeReq,
+    UpdateSandboxLifecycleData,
+    UpdateSandboxLifecycleReq,
+    Volume,
+    CreateSandboxReqVolume,
+    CreateSandboxEnvironmentReqVolume,
+    VolumeHost,
+    CreateSandboxReqVolumeHost,
+    CreateSandboxEnvironmentReqVolumeHost,
+    VolumeOSSFS,
+    CreateSandboxReqVolumeOSSFS,
+    CreateSandboxEnvironmentReqVolumeOSSFS,
+    VolumePVC,
+    CreateSandboxReqVolumePVC,
+    CreateSandboxEnvironmentReqVolumePVC,
+    GetInstanceStateStatsReq,
+    GetPrewarmPoolReq,
+    GetResourceStatsReq,
+    GetSandboxReq,
+    GetSandboxEnvironmentReq,
+    ListPrewarmPoolEventsReq,
+    ListPrewarmPoolPodsReq,
+    ListSandboxEnvironmentsReq,
+    ListSandboxesReq,
+    ListSandboxProjectsReq,
+    GetSandboxEnvironmentData,
+    UpdateInstanceCapacityData,
+    UpdatePrewarmSizeData,
+)

yicloud_sdk_python-0.3.1/yicloud/services/sandbox/actions.py

@@ -0,0 +1,273 @@
+# Code generated by generate_openapi.py. DO NOT EDIT.
+
+from typing import Optional
+from yicloud.base import msgs
+from yicloud.services.sandbox import models
+from yicloud.services.sandbox.client import client
+
+_PRODUCT_CODE = "sandbox"
+_LAST_VERSION = "v1alpha1"
+
+
+def batch_delete_sandboxes(ctx: Optional[dict], req: models.BatchDeleteSandboxesReq) -> models.BatchDeleteSandboxesData:
+    """批量删除
+    批量删除沙盒实例。
+    POST /sandbox/v1alpha1/BatchDeleteSandboxes
+    Action: BatchDeleteSandboxes
+
+    Returns BatchDeleteSandboxesData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/BatchDeleteSandboxes"
+    rsp = msgs.Rsp[models.BatchDeleteSandboxesData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()
+
+def create_sandbox(ctx: Optional[dict], req: models.CreateSandboxReq) -> models.CreateSandboxData:
+    """创建实例
+    创建一个沙盒实例。
+    POST /sandbox/v1alpha1/CreateSandbox
+    Action: CreateSandbox
+
+    Returns CreateSandboxData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/CreateSandbox"
+    rsp = msgs.Rsp[models.CreateSandboxData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()
+
+def create_sandbox_environment(ctx: Optional[dict], req: models.CreateSandboxEnvironmentReq) -> models.CreateSandboxEnvironmentData:
+    """创建环境
+    创建沙盒环境模板，并在 brainbox 侧创建对应预热池。
+    POST /sandbox/v1alpha1/CreateSandboxEnvironment
+    Action: CreateSandboxEnvironment
+
+    Returns CreateSandboxEnvironmentData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/CreateSandboxEnvironment"
+    rsp = msgs.Rsp[models.CreateSandboxEnvironmentData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()
+
+def delete_sandbox(ctx: Optional[dict], req: models.DeleteSandboxReq):
+    """删除实例
+    删除单个沙盒实例。OpenAPI 使用 POST，adapter 内部转发为 brainbox DELETE。
+    POST /sandbox/v1alpha1/DeleteSandbox
+    Action: DeleteSandbox
+
+    
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/DeleteSandbox"
+    rsp = msgs.Rsp[None].empty()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+
+def delete_sandbox_environment(ctx: Optional[dict], req: models.DeleteSandboxEnvironmentReq):
+    """删除环境
+    删除指定沙盒环境。OpenAPI 使用 POST，adapter 内部转发为 brainbox DELETE。
+    POST /sandbox/v1alpha1/DeleteSandboxEnvironment
+    Action: DeleteSandboxEnvironment
+
+    
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/DeleteSandboxEnvironment"
+    rsp = msgs.Rsp[None].empty()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+
+def get_instance_state_stats(ctx: Optional[dict], req: models.GetInstanceStateStatsReq) -> models.GetInstanceStateStatsData:
+    """实例统计
+    查询指定沙盒环境下预热实例和手动实例的状态统计。
+    GET /sandbox/v1alpha1/GetInstanceStateStats
+    Action: GetInstanceStateStats
+
+    Returns GetInstanceStateStatsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/GetInstanceStateStats"
+    rsp = msgs.Rsp[models.GetInstanceStateStatsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def get_prewarm_pool(ctx: Optional[dict], req: models.GetPrewarmPoolReq) -> models.GetPrewarmPoolData:
+    """预热池
+    查询指定沙盒环境的预热池目标数量、实例容量和当前状态。
+    GET /sandbox/v1alpha1/GetPrewarmPool
+    Action: GetPrewarmPool
+
+    Returns GetPrewarmPoolData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/GetPrewarmPool"
+    rsp = msgs.Rsp[models.GetPrewarmPoolData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def get_resource_stats(ctx: Optional[dict], req: models.GetResourceStatsReq) -> models.GetResourceStatsData:
+    """资源统计
+    查询指定沙盒环境下沙盒实例使用的 CPU 和内存资源。
+    GET /sandbox/v1alpha1/GetResourceStats
+    Action: GetResourceStats
+
+    Returns GetResourceStatsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/GetResourceStats"
+    rsp = msgs.Rsp[models.GetResourceStatsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def get_sandbox(ctx: Optional[dict], req: models.GetSandboxReq) -> models.GetSandboxData:
+    """实例详情
+    查询单个沙盒实例详情。
+    GET /sandbox/v1alpha1/GetSandbox
+    Action: GetSandbox
+
+    Returns GetSandboxData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/GetSandbox"
+    rsp = msgs.Rsp[models.GetSandboxData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def get_sandbox_environment(ctx: Optional[dict], req: models.GetSandboxEnvironmentReq) -> models.GetSandboxEnvironmentData:
+    """环境详情
+    查询单个沙盒环境详情。
+    GET /sandbox/v1alpha1/GetSandboxEnvironment
+    Action: GetSandboxEnvironment
+
+    Returns GetSandboxEnvironmentData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/GetSandboxEnvironment"
+    rsp = msgs.Rsp[models.GetSandboxEnvironmentData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def list_prewarm_pool_events(ctx: Optional[dict], req: models.ListPrewarmPoolEventsReq) -> models.ListPrewarmPoolEventsData:
+    """预热事件
+    查询指定沙盒环境的预热池事件历史。
+    GET /sandbox/v1alpha1/ListPrewarmPoolEvents
+    Action: ListPrewarmPoolEvents
+
+    Returns ListPrewarmPoolEventsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/ListPrewarmPoolEvents"
+    rsp = msgs.Rsp[models.ListPrewarmPoolEventsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def list_prewarm_pool_pods(ctx: Optional[dict], req: models.ListPrewarmPoolPodsReq) -> models.ListPrewarmPoolPodsData:
+    """预热Pod
+    查询指定沙盒环境的预热池 Pod 列表。
+    GET /sandbox/v1alpha1/ListPrewarmPoolPods
+    Action: ListPrewarmPoolPods
+
+    Returns ListPrewarmPoolPodsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/ListPrewarmPoolPods"
+    rsp = msgs.Rsp[models.ListPrewarmPoolPodsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def list_sandbox_environments(ctx: Optional[dict], req: models.ListSandboxEnvironmentsReq) -> models.ListSandboxEnvironmentsData:
+    """环境列表
+    查询指定项目下的沙盒环境列表。
+    GET /sandbox/v1alpha1/ListSandboxEnvironments
+    Action: ListSandboxEnvironments
+
+    Returns ListSandboxEnvironmentsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/ListSandboxEnvironments"
+    rsp = msgs.Rsp[models.ListSandboxEnvironmentsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def list_sandbox_projects(ctx: Optional[dict], req: models.ListSandboxProjectsReq) -> models.ListSandboxProjectsData:
+    """项目白名单
+    获取当前租户下允许访问沙盒的项目列表。
+    GET /sandbox/v1alpha1/ListSandboxProjects
+    Action: ListSandboxProjects
+
+    Returns ListSandboxProjectsData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/ListSandboxProjects"
+    rsp = msgs.Rsp[models.ListSandboxProjectsData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def list_sandboxes(ctx: Optional[dict], req: models.ListSandboxesReq) -> models.ListSandboxesData:
+    """实例列表
+    查询指定项目下的沙盒实例列表。
+    GET /sandbox/v1alpha1/ListSandboxes
+    Action: ListSandboxes
+
+    Returns ListSandboxesData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/ListSandboxes"
+    rsp = msgs.Rsp[models.ListSandboxesData]()
+    client.base.get(ctx, path, req, rsp)
+    return rsp.get_typed_data()
+
+def stop_sandbox(ctx: Optional[dict], req: models.StopSandboxReq):
+    """关闭实例
+    关闭单个沙盒实例。
+    POST /sandbox/v1alpha1/StopSandbox
+    Action: StopSandbox
+
+    
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/StopSandbox"
+    rsp = msgs.Rsp[None].empty()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+
+def update_instance_capacity(ctx: Optional[dict], req: models.UpdateInstanceCapacityReq) -> models.UpdateInstanceCapacityData:
+    """修改容量
+    修改指定沙盒环境可创建实例总数上限。OpenAPI 使用 POST，adapter 内部转发为 brainbox PATCH。
+    POST /sandbox/v1alpha1/UpdateInstanceCapacity
+    Action: UpdateInstanceCapacity
+
+    Returns UpdateInstanceCapacityData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/UpdateInstanceCapacity"
+    rsp = msgs.Rsp[models.UpdateInstanceCapacityData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()
+
+def update_prewarm_size(ctx: Optional[dict], req: models.UpdatePrewarmSizeReq) -> models.UpdatePrewarmSizeData:
+    """修改预热
+    修改指定沙盒环境的预热池目标空闲实例数。OpenAPI 使用 POST，adapter 内部转发为 brainbox PATCH。
+    POST /sandbox/v1alpha1/UpdatePrewarmSize
+    Action: UpdatePrewarmSize
+
+    Returns UpdatePrewarmSizeData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/UpdatePrewarmSize"
+    rsp = msgs.Rsp[models.UpdatePrewarmSizeData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()
+
+def update_sandbox_lifecycle(ctx: Optional[dict], req: models.UpdateSandboxLifecycleReq) -> models.UpdateSandboxLifecycleData:
+    """修改周期
+    修改单个沙盒实例生命周期。OpenAPI 使用 LifecycleMinutes，adapter 内部转发为 brainbox lifecycleMinutes。
+    POST /sandbox/v1alpha1/UpdateSandboxLifecycle
+    Action: UpdateSandboxLifecycle
+
+    Returns UpdateSandboxLifecycleData on success. 
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/UpdateSandboxLifecycle"
+    rsp = msgs.Rsp[models.UpdateSandboxLifecycleData]()
+    client.base.post(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    return rsp.get_typed_data()

yicloud_sdk_python-0.3.1/yicloud/services/sandbox/client.py

@@ -0,0 +1,21 @@
+# Code generated by generate_openapi.py. DO NOT EDIT.
+
+from yicloud.base import Client
+
+
+class SandboxClient:
+    """Sandbox service client."""
+
+    def __init__(self, base_client: Client = None):
+        self.base = base_client
+        self.product_code = "sandbox"
+        self.last_version = "v1alpha1"
+
+
+# Singleton
+client: SandboxClient = SandboxClient()
+
+
+def use_client(cli: Client) -> None:
+    """Set the base client for Sandbox service."""
+    client.base = cli