Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
使用人工智能平台 Python SDK 创建、查询、更新、启停 VSCS 开发环境，并配置 SSH 公钥、定时策略和弹性策略。
from siflow import SiFlow
from siflow.types.vscs import (
CreateVscsRequest,
DevToolsInfo,
Instance,
SSHToolConfig,
VSCodeToolConfig,
VolumeMount,
)
client = SiFlow(region="cn-beijing", cluster="auriga")
images = client.images.list_for_workload(use_case="vscs")
if not images.rows:
raise RuntimeError("当前区域和集群没有可用于 VSCS 的镜像")
picked = images.rows[0]
res = client.vscs.create(
request=CreateVscsRequest(
region="cn-beijing",
cluster="auriga",
name="sdk-vscs-demo",
image=picked.image,
imageUrl=picked.imageUrl,
resourcePool="<RESOURCE_POOL>",
instances=[
Instance(name="sci.c22-2", countPerPod=1),
],
selectedInstance="sci.c22-2",
devToolsInfo=DevToolsInfo(
workspaceDir="/workspace",
ssh=SSHToolConfig(enabled=True),
vscode=VSCodeToolConfig(enabled=True),
),
sshPubKeys=[
"ssh-ed25519 AAAA... user@workstation",
],
volumeMounts=[
VolumeMount(
volumeId=123,
mountDir="/workspace",
),
VolumeMount(
volumeId=124,
mountDir="/workspace/data",
subPath="data",
readOnly=False,
),
],
)
)
print(res)
| 参数 | 说明 |
|---|---|
region / cluster | 区域和集群。 |
name | 开发环境名称。 |
image / imageUrl | 镜像信息。imageUrl 是实际下发到容器的完整镜像地址，建议从 client.images.list_for_workload(use_case="vscs") 的返回结果中获取，不要自行拼接。 |
resourcePool | 资源池 ID 或名称。 |
instances / selectedInstance | 实例规格和当前选中的规格。 |
devToolsInfo | 开发工具配置，可配置 VS Code Web、SSH 和工作目录。 |
sshPubKeys | SSH 公钥列表。启用 SSH 访问时需要配置。 |
volumeMounts | Volume 挂载配置。开启目录级权限的 Volume 需要配置 subPath；只读目录应设置 readOnly=True。 |
envVars | 环境变量。 |
datasets / models | 数据集或模型挂载配置。 |
timezone | 容器时区。 |
page = client.vscs.list(
page=1,
page_size=10,
name="sdk-vscs-demo",
status=["Ready"],
resource_pool=["<RESOURCE_POOL>"],
access_type=["ssh"],
dev_tools_info=["ssh"],
sort_by="createTime",
sort_order="desc",
)
for item in page.rows:
print(item.id, item.name, item.status)
detail = client.vscs.get(id=123)
print(detail.status, detail.url, detail.sshAddr)
name、status、resource_pool、access_type、dev_tools_info、sort_by、sort_order 和 show_all 等参数过滤。
image 和 imageUrl。其中 imageUrl 是实际下发到容器的字段。
from siflow.types.vscs import Instance, UpdateVscsRequest
images = client.images.list_for_workload(use_case="vscs")
if not images.rows:
raise RuntimeError("当前区域和集群没有可用于 VSCS 的镜像")
picked = images.rows[0]
client.vscs.update(
id=123,
request=UpdateVscsRequest(
image=picked.image,
imageUrl=picked.imageUrl,
instances=[
Instance(name="sci.c22-4", countPerPod=1),
],
selectedInstance="sci.c22-4",
),
)
client.vscs.stop(id=123)
client.vscs.start(id=123)
client.vscs.restart(id=123)
# 或者：client.vscs.inplace_restart(id=123)
client.vscs.delete(id=123)
from siflow.types.vscs import ScheduleVscsRequest
client.vscs.schedule(
request=ScheduleVscsRequest(
id=123,
cronEnable=True,
cronStartTime="0 9 * * *",
cronEndTime="0 20 * * *",
)
)
from siflow.types.vscs import AutoScaleVscsRequest
client.vscs.auto_scale(
request=AutoScaleVscsRequest(
id=123,
scaleEnable=True,
duration=10,
gpuUsage=60,
policyType="gpu",
)
)
update_ssh_key 会替换当前开发环境的 SSH 公钥列表。
from siflow.types.vscs import UpdateSSHKeyRequest
client.vscs.update_ssh_key(
id=123,
request=UpdateSSHKeyRequest(
sshPubKeys=[
"ssh-ed25519 AAAA...new-key... user@workstation",
],
),
)
summary = client.vscs.summary()
filters = client.vscs.filters()
statuses = client.vscs.statuses()
dashboard = client.vscs.dashboard(
details_limit=5,
resource_pool="<RESOURCE_POOL>",
)
print(summary)
print(filters)
print(statuses)
print(dashboard)