yicloud-sdk-python 0.4.0__tar.gz → 0.4.1__tar.gz

{yicloud_sdk_python-0.4.0/yicloud_sdk_python.egg-info → yicloud_sdk_python-0.4.1}/PKG-INFO

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

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/pyproject.toml

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

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/version.py

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

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/yicloud/__init__.py

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

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/yicloud/services/job/__init__.py

@@ -12,6 +12,7 @@ from .actions import (
     edit_job,
     batch_delete_jobs,
     batch_stop_jobs,
+    stop_job,
     stop_replica,
     get_logs,
     get_logs_volume,
@@ -25,6 +26,7 @@ from .actions import (
     edit_job_async,
     batch_delete_jobs_async,
     batch_stop_jobs_async,
+    stop_job_async,
     stop_replica_async,
     get_logs_async,
     get_logs_volume_async,
@@ -75,6 +77,7 @@ from .models import (
     S3Config,
     CreateJobReqS3Config,
     CreateJobReqSelfHealConfig,
+    StopJobReq,
     StopReplicaReq,
     CreateJobReqTaskSpec,
     TaskSpecResponse,

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/yicloud/services/job/actions.py

@@ -109,7 +109,7 @@ JobUid 可从 ListJobs / GetJob 接口返回的 Uid 字段获取。
 
 def create_job(ctx: Optional[dict], req: models.CreateJobReq) -> models.CreateJobData:
     """创建 Job
-    创建新的训练任务，支持配置自愈选项、多任务规格和调度策略
+    创建新的训练任务，支持配置自愈选项、多任务规格和调度策略。创建前会校验租户状态与 SKU 余额，可能返回 1001012、1001013、1001014。
     POST /job/v1alpha1/CreateJob
     Action: CreateJob
 
@@ -124,7 +124,7 @@ def create_job(ctx: Optional[dict], req: models.CreateJobReq) -> models.CreateJo
 
 async def create_job_async(ctx: Optional[dict], req: models.CreateJobReq) -> models.CreateJobData:
     """创建 Job（异步）
-    创建新的训练任务，支持配置自愈选项、多任务规格和调度策略
+    创建新的训练任务，支持配置自愈选项、多任务规格和调度策略。创建前会校验租户状态与 SKU 余额，可能返回 1001012、1001013、1001014。
     POST /job/v1alpha1/CreateJob
     Action: CreateJob
 
@@ -223,6 +223,34 @@ async def batch_stop_jobs_async(ctx: Optional[dict], req: models.BatchStopJobsRe
     return rsp.get_typed_data()
 
 
+def stop_job(ctx: Optional[dict], req: models.StopJobReq):
+    """停止 Job
+    停止运行中的 Job
+    POST /job/v1alpha1/StopJob
+    Action: StopJob
+
+    
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/StopJob"
+    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)
+
+
+async def stop_job_async(ctx: Optional[dict], req: models.StopJobReq):
+    """停止 Job（异步）
+    停止运行中的 Job
+    POST /job/v1alpha1/StopJob
+    Action: StopJob
+
+    
+    Raises YiCloudException on error.
+    """
+    path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/StopJob"
+    rsp = msgs.Rsp[None].empty()
+    await client.base.post_async(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+
+
 def stop_replica(ctx: Optional[dict], req: models.StopReplicaReq):
     """停止单个副本
     停止指定的 Replica，参考 StopWorkspace 实现模式，通过 apiserver subresource 调用。
@@ -313,7 +341,7 @@ async def get_logs_volume_async(ctx: Optional[dict], req: models.GetLogsVolumeRe
 
 def list_job_replicas(ctx: Optional[dict], req: models.ListJobReplicasReq) -> models.ListJobReplicasData:
     """获取副本列表
-    获取指定 Job 的所有副本列表
+    获取指定 Job 的副本列表，支持按副本状态过滤
     GET /job/v1alpha1/ListJobReplicas
     Action: ListJobReplicas
 
@@ -328,7 +356,7 @@ def list_job_replicas(ctx: Optional[dict], req: models.ListJobReplicasReq) -> mo
 
 async def list_job_replicas_async(ctx: Optional[dict], req: models.ListJobReplicasReq) -> models.ListJobReplicasData:
     """获取副本列表（异步）
-    获取指定 Job 的所有副本列表
+    获取指定 Job 的副本列表，支持按副本状态过滤
     GET /job/v1alpha1/ListJobReplicas
     Action: ListJobReplicas
 

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/yicloud/services/job/models.py

@@ -90,6 +90,7 @@ class CreateJobReq:
     Name: str    # Job 显示名称  json:"Name"
     Project: str    # 项目名称  json:"Project"
     TaskSpecs: Dict[str, CreateJobReqTaskSpec]    # 任务规格映射，key 为任务名（如 t0），value 为任务规格  json:"TaskSpecs"
+    ZoneId: str    # 可用区（AZ），必填；RegionId 由网关通过 X-OGW-REGION-ID 请求头注入  json:"ZoneId"
     AutoDeleteDuration: Optional[str] = None    # 自动删除时间，如 24h  json:"AutoDeleteDuration,omitempty"
     BackoffLimit: Optional[int] = None    # 重试次数限制  json:"BackoffLimit,omitempty"
     Creator: Optional[str] = None    # 创建者用户名  json:"Creator,omitempty"
@@ -168,6 +169,7 @@ class GetJobData:
     Rank: Optional[int] = 0    # 排序排名（从 1 开始），仅 List 接口返回  json:"Rank,omitempty"
     RealCreator: Optional[str] = ""    # 实际创建者用户名（共享场景下与 Creator 不同）  json:"RealCreator,omitempty"
     RealCreatorId: Optional[str] = ""    # 实际创建者用户 ID（共享场景下与 CreatorId 不同）  json:"RealCreatorId,omitempty"
+    RegionId: Optional[str] = ""    # 地域，从 RJob topology labels 读取；存量数据缺失时回填默认值 cn-shanghai  json:"RegionId,omitempty"
     S3Config: Optional[S3Config] = None    # json:"S3Config,omitempty"
     SKUPrivate: Optional[bool] = False    # 是否使用私有机器 SKU  json:"SKUPrivate,omitempty"
     SKUPrivateProject: Optional[bool] = False    # 是否为项目级私有 SKU  json:"SKUPrivateProject,omitempty"
@@ -187,6 +189,7 @@ class GetJobData:
     Uid: Optional[str] = ""    # Job 唯一标识（UID）  json:"Uid,omitempty"
     UsePrivateMachine: Optional[bool] = False    # 是否使用私有机器  json:"UsePrivateMachine,omitempty"
     WaitTime: Optional[int] = 0    # 等待时间（秒），仅 List 接口返回  json:"WaitTime,omitempty"
+    ZoneId: Optional[str] = ""    # 可用区，从 RJob topology labels 读取；存量数据缺失时回填默认值 cn-shanghai-b  json:"ZoneId,omitempty"
 
 @dataclass
 class LogEntry:
@@ -269,8 +272,10 @@ class GetJobReplicaData:
     NodeName: Optional[str] = ""    # 运行节点名称  json:"NodeName,omitempty"
     Phase: Optional[str] = None    # SDK常量: PhasePending, PhaseStarting, PhaseRunning, PhaseScanning, PhaseSucceeded, PhaseFailed, PhaseRestarting, PhaseStopped, PhaseInqueue, PhaseSelfHealTriggered, PhaseSelfHealRunning, PhaseSelfHealSucceeded, PhaseSelfHealFailed  json:"Phase,omitempty"
     PodIP: Optional[str] = ""    # Pod IP 地址  json:"PodIP,omitempty"
+    RegionId: Optional[str] = ""    # 地域，从 Replica topology labels 读取；存量数据缺失时回填默认值 cn-shanghai  json:"RegionId,omitempty"
     ReplicaIndex: Optional[int] = 0    # 副本序号  json:"ReplicaIndex,omitempty"
     TaskType: Optional[str] = ""    # 副本任务类型（如 worker）  json:"TaskType,omitempty"
+    ZoneId: Optional[str] = ""    # 可用区，从 Replica topology labels 读取；存量数据缺失时回填默认值 cn-shanghai-b  json:"ZoneId,omitempty"
 
 @dataclass
 class BatchDeleteJobsReqResourceIdentifier:
@@ -312,13 +317,19 @@ class CreateJobReqS3Config:
 
 @dataclass
 class CreateJobReqSelfHealConfig:
-    AutoReplaceNode: Optional[bool] = None    # 是否开启节点自愈（故障节点自动替换）  json:"AutoReplaceNode,omitempty"
-    GracePeriodMinutes: Optional[int] = None    # 介入等待时间（分钟），故障发生后等待多久开始自愈  json:"GracePeriodMinutes,omitempty"
-    LimitCount: Optional[int] = None    # 最大重试次数  json:"LimitCount,omitempty"
+    AutoReplaceNode: Optional[bool] = None    # 是否开启节点自愈（故障节点自动替换），默认关闭  json:"AutoReplaceNode,omitempty"
+    GracePeriodMinutes: Optional[int] = None    # 介入等待时间（分钟），默认 15 分钟  json:"GracePeriodMinutes,omitempty"
+    LimitCount: Optional[int] = None    # 最大重试次数，默认 5 次  json:"LimitCount,omitempty"
     NotifyWebhook: Optional[str] = None    # 自愈事件通知 Webhook URL（如飞书机器人）  json:"NotifyWebhook,omitempty"
     RetryScope: Optional[str] = None    # SDK常量: RetryScopeRjob, RetryScopeTask  json:"RetryScope,omitempty"
     SelfHealEnabled: Optional[bool] = None    # 是否开启自愈  json:"SelfHealEnabled,omitempty"
-    TerminationGracePeriodSeconds: Optional[int] = None    # 优雅终止等待时间（秒），自愈重启前等待任务退出的时间  json:"TerminationGracePeriodSeconds,omitempty"
+    TerminationGracePeriodSeconds: Optional[int] = None    # 数据回收时间（秒），默认 300 秒  json:"TerminationGracePeriodSeconds,omitempty"
+
+@dataclass
+class StopJobReq:
+    JobId: str    # Job 唯一标识  json:"JobId"
+    Project: str    # 项目名称  json:"Project"
+    ZoneId: Optional[str] = None    # 可用区（可选，当前服务端仅接收）；RegionId 由网关通过 X-OGW-REGION-ID 请求头注入  json:"ZoneId,omitempty"
 
 @dataclass
 class StopReplicaReq:
@@ -367,11 +378,13 @@ class TaskSpecResponse:
     MountGpfsVolumes: Optional[List[MountGpfsVolume]] = None    # GPFS 挂载卷列表（结构化），由 MountGPFS 字符串解析而来  json:"MountGpfsVolumes,omitempty"
     NegativeTags: Optional[List[str]] = None    # 节点反亲和标签列表  json:"NegativeTags,omitempty"
     PositiveTags: Optional[List[str]] = None    # 节点亲和标签列表  json:"PositiveTags,omitempty"
+    RegionId: Optional[str] = ""    # 地域，从 TaskSpec template labels 读取；缺失时回填默认值 cn-shanghai  json:"RegionId,omitempty"
     Replicas: Optional[int] = 0    # 副本数  json:"Replicas,omitempty"
     RootfsSource: Optional[RootfsSourceResponse] = None    # Rootfs 数据源配置  json:"RootfsSource,omitempty"
     SKUId: Optional[str] = ""    # SKU 规格标识，如 ai.c3m42.r1ir5  json:"SKUId,omitempty"
     UpdatePolicy: Optional[str] = None    # SDK常量: UpdatePolicyActive, UpdatePolicyBeforeRunning, UpdatePolicyNone  json:"UpdatePolicy,omitempty"
     Volumes: Optional[List[VolumeMount]] = None    # 挂载存储卷列表  json:"Volumes,omitempty"
+    ZoneId: Optional[str] = ""    # 可用区，从 TaskSpec template labels 读取；缺失时回填默认值 cn-shanghai-b  json:"ZoneId,omitempty"
 
 @dataclass
 class TaskStatusCount:
@@ -445,10 +458,12 @@ class GetPrecheckStatusReq:
 class ListJobReplicasReq:
     JobId: str    # Job 唯一标识  query:"JobId"
     Project: str    # 项目名称  query:"Project"
+    Phases: Optional[str] = None    # 按副本状态过滤，多个状态使用逗号分隔；可选值为 Pending、Starting、Running、Stopped、Succeeded、Failed、Unknown  query:"Phases,omitempty"
 
 @dataclass
 class ListJobsReq:
     Project: str    # 项目名称  query:"Project"
+    ZoneId: str    # 可用区（AZ）过滤，如 cn-shanghai-b；RegionId 由网关通过 X-OGW-REGION-ID 请求头注入  query:"ZoneId"
     Creators: Optional[str] = None    # 创建者用户名，逗号分隔  query:"Creators,omitempty"
     JobIds: Optional[str] = None    # Job ID 列表，逗号分隔  query:"JobIds,omitempty"
     JobNames: Optional[str] = None    # Job 名称过滤（逗号分隔，支持模糊匹配）  query:"JobNames,omitempty"

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1}/yicloud/services/workspace/actions.py

@@ -71,7 +71,9 @@ async def get_workspace_async(ctx: Optional[dict], req: models.GetWorkspaceReq)
 
 def create_workspace(ctx: Optional[dict], req: models.CreateWorkspaceReq) -> models.CreateWorkspaceData:
     """创建开发机
-    支持两种模式：
+    创建前会校验租户状态与 SKU 余额，可能返回 1006012、1006013、1006014。
+
+支持两种模式：
 - **配额组模式**（默认）：设置 QuotaGroup + RuntimeMode + CPU/Memory/GPU
 - **SKU 模式**：设置 SkuId + SkuPublic 或 SkuPrivate（及 SkuTenant/SkuProject），不需要设置 RuntimeMode、QuotaGroup、CPU/Memory/GPU
 
@@ -93,7 +95,9 @@ def create_workspace(ctx: Optional[dict], req: models.CreateWorkspaceReq) -> mod
 
 async def create_workspace_async(ctx: Optional[dict], req: models.CreateWorkspaceReq) -> models.CreateWorkspaceData:
     """创建开发机（异步）
-    支持两种模式：
+    创建前会校验租户状态与 SKU 余额，可能返回 1006012、1006013、1006014。
+
+支持两种模式：
 - **配额组模式**（默认）：设置 QuotaGroup + RuntimeMode + CPU/Memory/GPU
 - **SKU 模式**：设置 SkuId + SkuPublic 或 SkuPrivate（及 SkuTenant/SkuProject），不需要设置 RuntimeMode、QuotaGroup、CPU/Memory/GPU
 
@@ -143,7 +147,7 @@ async def delete_workspace_async(ctx: Optional[dict], req: models.DeleteWorkspac
 
 def start_workspace(ctx: Optional[dict], req: models.StartWorkspaceReq):
     """启动开发机
-    启动已停止的开发机
+    启动已停止的开发机。启动前会校验租户状态与 SKU 余额，可能返回 1006012、1006013、1006014。
     POST /workspace/v1alpha1/StartWorkspace
     Action: StartWorkspace
 
@@ -157,7 +161,7 @@ def start_workspace(ctx: Optional[dict], req: models.StartWorkspaceReq):
 
 async def start_workspace_async(ctx: Optional[dict], req: models.StartWorkspaceReq):
     """启动开发机（异步）
-    启动已停止的开发机
+    启动已停止的开发机。启动前会校验租户状态与 SKU 余额，可能返回 1006012、1006013、1006014。
     POST /workspace/v1alpha1/StartWorkspace
     Action: StartWorkspace
 
@@ -416,7 +420,7 @@ def delete_process(ctx: Optional[dict], req: models.DeleteProcessReq):
     """
     path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/DeleteProcess"
     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)
+    client.base.post(ctx, path, req, rsp)
 
 
 async def delete_process_async(ctx: Optional[dict], req: models.DeleteProcessReq):
@@ -430,7 +434,7 @@ async def delete_process_async(ctx: Optional[dict], req: models.DeleteProcessReq
     """
     path = f"/{_PRODUCT_CODE}/{_LAST_VERSION}/DeleteProcess"
     rsp = msgs.Rsp[None].empty()
-    await client.base.post_async(ctx, path, {k: v for k, v in req.__dict__.items() if v is not None}, rsp)
+    await client.base.post_async(ctx, path, req, rsp)
 
 
 def get_process_pids(ctx: Optional[dict], req: models.GetProcessPidsReq) -> models.GetProcessPidsData:

{yicloud_sdk_python-0.4.0 → yicloud_sdk_python-0.4.1/yicloud_sdk_python.egg-info}/PKG-INFO

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