ListRuntimes - 获取运行时列表

更新时间:
复制 MD 格式

获取运行时列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pailangstudio:ListRuntimes

list

*全部资源

*

无 无

请求语法

GET /api/v1/langstudio/runtimes HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

否

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces 。

478**

NextToken

string

否

分页游标。用于请求下一页检索的结果。

  • 首次请求时置空。

  • 后续请求时传入上一次响应返回的NextToken值。

""

MaxResults

integer

否

本次请求允许返回的最大记录条数。

20

PageNumber

integer

否

分页查询时,当前页面的页码。

1

PageSize

integer

否

每页所显示的项数,默认为 10。

10

RuntimeName

string

否

运行时的名称。支持按名称模糊搜索。

dev01

RuntimeId

string

否

运行时 ID。支持按运行时 ID 精确搜索。

rtime-apje******beaz

WorkDir

string

否

工作目录的 OSS 路径。

oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/

RuntimeStatus

string

否

运行时状态。

枚举值:

  • Creating :

    创建中

  • SaveFailed :

    镜像保存失败

  • Stopped :

    已停止

  • Failed :

    失败

  • ResourceAllocating :

    资源分配中

  • Stopping :

    停止中

  • Updating :

    更新中

  • Saving :

    镜像保存中

  • Queuing :

    排队中

  • Recovering :

    实例恢复中

  • Starting :

    创建中

  • Running :

    运行中

  • Saved :

    镜像保存成功

  • Deleting :

    删除中

  • EnvPreparing :

    环境准备中

Running

Creator

string

否

创建者 ID。

2485765****023475

SortBy

string

否

分页查询时的排序字段,默认使用 GmtCreateTime。

枚举值:

  • Status :

    运行时状态

  • RuntimeName :

    运行时名称

  • Creator :

    创建者 ID

  • WorkDir :

    工作路径

  • GmtCreateTime :

    按创建时间

  • GmtModifiedTime :

    按修改时间

GmtCreateTime

Order

string

否

排序方式。

枚举值:

  • ASC :

    升序

  • DESC :

    降序

DESC

Version

string

否

版本

1.0

Accessibility

string

否

可见性。

枚举值:

  • PUBLIC :

    工作空间内可见

  • PRIVATE :

    创建者可见

PRIVATE

返回参数

名称

类型

描述

示例值

object

返回结果。

Runtimes

array

运行时列表。

Runtime

运行时详情。

MaxResults

integer

请求最大返回结果数。

10

NextToken

string

下次请求令牌。

11

TotalCount

integer

运行时总数量。

25

RequestId

string

请求 ID。

963BD7F9-0C02-5594-9550-BCC6DD43E3C0

示例

正常返回示例

JSON格式

{
  "Runtimes": [
    {
      "WorkspaceId": "478***",
      "RuntimeId": "rtime-apje******beaz",
      "RuntimeName": "dev01",
      "RuntimeType": "DSW",
      "RuntimeStatus": "Running",
      "GmtCreateTime": "2025-09-24T07:33:53Z",
      "GmtModifiedTime": "2025-09-24T08:24:36Z",
      "Creator": "2680******4103",
      "Accessibility": "PRIVATE",
      "EcsSpec": {
        "InstanceType": "ecs.c6.large",
        "GPUType": "V100",
        "CPU": 4,
        "GPU": 0,
        "Memory": 8,
        "SharedMemory": 8,
        "Driver": "535.161.08"
      },
      "ResourceId": "quota18******zv9",
      "UserVpc": {
        "VpcId": "vpc-wz90****5v23",
        "VSwitchId": "vsw-wz9r****ng10",
        "SecurityGroupId": "sg-wz9i****1129",
        "DefaultRoute": "eth0",
        "ExtendedCIDRs": [
          "172.16.1.0/24"
        ]
      },
      "Envs": [
        {
          "Key": "testKey01",
          "Value": "testValue01"
        }
      ],
      "Labels": [
        {
          "Key": "testKey01",
          "Value": "testValue01"
        }
      ],
      "DataSources": [
        {
          "DatasetId": "d-umns******zij4szhc",
          "Uri": "oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/",
          "MountPath": "/mnt/data"
        }
      ],
      "RunTimeout": 180,
      "CredentialConfig": {
        "EnableCredentialInject": true,
        "AliyunEnvRoleKey": "0",
        "CredentialConfigItems": [
          {
            "Key": "0",
            "Type": "Role",
            "Roles": [
              {
                "AssumeRoleFor": "1095******785714",
                "RoleType": "service",
                "RoleArn": "acs:ram::1095******785714:role/testrole"
              }
            ]
          }
        ]
      },
      "WorkDir": "oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/",
      "Version": "2.0.0",
      "RuntimeLog": "oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log",
      "AutoUpdateImage": true
    }
  ],
  "MaxResults": 10,
  "NextToken": "11",
  "TotalCount": 25,
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。