文档首页/ 智能数据湖 AI DataLake/ API参考/ 计算资源管理/ 查询计算资源列表 - ListV2Computes
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询计算资源列表 - ListV2Computes

功能介绍

查询工作空间下的计算资源列表。此接口为同步接口。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/computes

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID，可通过查询工作空间列表获取工作空间ID。

约束限制：不涉及。

取值范围：长度为32~36的英文字符、数字和中划线的组合。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：分页偏移量。

约束限制：不涉及。

取值范围：0~10000。

默认取值：0。

limit

否

Integer

参数解释：分页大小。

约束限制：不涉及。

取值范围：1~1000。

默认取值：100。

name

否

String

参数解释：计算资源名称，模糊查询。

约束限制：不涉及。

取值范围：支持小写字母、数字、中划线，必须字母开头、字母或数字结尾，长度为1~63个字符。

默认取值：不涉及。

compute_id

否

String

参数解释：计算资源ID。可通过查询计算资源列表获取计算资源ID。

约束限制：不涉及。

取值范围：长度为1~36的英文字符、数字和中划线的组合。

默认取值：不涉及。

tags

否

Array of strings

参数解释：标签过滤条件，支持多个标签。格式为 key#value1,value2，用英文逗号分隔多个值。

约束限制：最多10个标签。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：只能由英文字母、数字及特殊字符组成，长度不超过65534个字符。Token格式由IAM服务定义，具体字符集参见IAM服务相关文档。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：总记录数。

取值范围：0~10000。

computes

Array of V2ComputeInfo objects

参数解释：计算资源列表，每个元素为一个V2ComputeInfo对象，包含计算资源ID、名称、计费模式、容量配置、标签等详细信息。
表5 V2ComputeInfo

参数

参数类型

描述

id

String

参数解释：计算资源ID。

取值范围：长度为1~36个英文字母、数字和中划线的组合。

name

String

参数解释：计算资源名称。

取值范围：支持小写字母、数字、中划线，必须字母开头、字母或数字结尾，长度为1~63个字符。

description

String

参数解释：资源描述信息。

取值范围：字符长度为0~512个字符。

charge_mode

String

参数解释：计费模式。

取值范围：

  • postPaid：按需计费。

  • prePaid：包周期计费。

capacity

Array of ResourceCapacityItem objects

参数解释：计算资源容量配置，由ResourceCapacityItem对象组成的数组，每个对象定义了资源类型、资源数量、资源规格和资源ID等信息。

tags

Array of Tag objects

参数解释：标签列表，由Tag对象组成的数组，每个对象定义了标签键和标签值。

prometheus_config

PrometheusConfig object

参数解释：Prometheus监控配置。

update_time

String

参数解释：资源更新时间，使用UTC时间，ISO 8601格式，例如：2025-01-10T03:37:12.000+00:00。

取值范围：不涉及。

create_time

String

参数解释：资源创建时间，使用UTC时间，ISO 8601格式，yyyy-MM-dd'T'HH:mm:ss.SSSXXX，例如：2025-01-10T03:37:12.000+00:00。

取值范围：不涉及。

status

String

参数解释：资源状态。

取值范围：

  • PREPARING：创建中。

  • RELEASING：释放中。

  • RUNNING：运行中。

  • SCALEIN：缩容中。

  • SCALEOUT：扩容中。

  • FREEZING：冻结中。

  • DELETED：已删除。

  • DELETING：删除中。

  • FAILED：失败。

  • ORDER_PAYING：订单支付中。

creator

Creator object

参数解释：资源所有者信息。

error

Error object

参数解释：失败时返回的文本消息内容，包含错误码、错误描述。
表6 ResourceCapacityItem

参数

参数类型

描述

type

String

参数解释：资源类型。

取值范围：

  • CPU：中央处理器。

  • GPU：图形处理器。

  • NPU：神经网络处理器。

capacity

Integer

参数解释：资源容量数量。CPU资源单位为核，GPU/NPU资源单位为个。

取值范围：0~48000。

spec_code

String

参数解释：规格编码。

取值范围：长度为1~64的英文字母、数字、中划线和点号的组合。

resource_id

String

参数解释：资源ID。

取值范围：长度为1~64的英文字母、数字、中划线和点号的组合。
表7 Tag

参数

参数类型

描述

key

String

参数解释：标签键。

取值范围：长度为1~128个英文字符、数字、下划线、中划线、句点的组合。

value

String

参数解释：标签值。

取值范围：长度为0~255个字符。
表8 PrometheusConfig

参数

参数类型

描述

enable

Boolean

参数解释：是否接入AOM。

取值范围：

  • true：接入AOM。

  • false：不接入AOM。

aom_prometheus_id

String

参数解释：AOM Prometheus实例ID，可通过AOM管理控制台或查询AOM Prometheus实例列表接口获取。

取值范围：长度为0~256个字符，支持英文字符、数字、中划线和下划线的组合。
表9 Creator

参数

参数类型

描述

domain_name

String

参数解释：租户名称。

取值范围：支持中文字符、英文字母、数字及特殊字符，长度为1~64个字符。

domain_id

String

参数解释：租户ID。

取值范围：支持英文字母、数字及中划线，长度为1~64个字符。

user_name

String

参数解释：用户名称。

取值范围：支持英文字母、数字、下划线的组合，长度为1~64个字符。

user_id

String

参数解释：用户ID。

取值范围：支持英文字母、数字及中划线，长度为1~64个字符。
表10 Error

参数

参数类型

描述

error_code

String

参数解释：失败状态时的错误编码。

取值范围：支持英文字母、数字、小数点及下划线，长度为0~36个字符。

error_msg

String

参数解释：失败状态时的错误信息。

取值范围：支持中文字符、英文字母、数字及特殊字符，长度为0~1024个字符。

状态码：400

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：401

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：403

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：404

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

状态码：500

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案。

取值范围：长度为0~4096个字符。

请求示例

查询指定工作空间下的计算资源列表。

GET /v2/workspaces/{workspace_id}/computes

响应示例

状态码：200

{
  "total" : 3,
  "computes" : [ {
    "id" : "03141229-84cd-4b1b-9733-dd124320c125",
    "name" : "compute-01",
    "description" : "description1",
    "charge_mode" : "postPaid",
    "capacity" : [ {
      "type" : "CPU",
      "capacity" : 1000,
      "spec_code" : "aidatalake.cpu.x86.general.1c4g",
      "resource_id" : "cpu.03141229-84cd-4b1b-9733-dd124320c125"
    } ],
    "tags" : [ {
      "key" : "test",
      "value" : "ai"
    } ],
    "update_time" : "2025-01-10T03:37:12.000+00:00",
    "create_time" : "2025-01-10T03:37:12.000+00:00",
    "status" : "RUNNING",
    "creator" : {
      "domain_name" : "domain_name",
      "domain_id" : "domain_id",
      "user_name" : "user_name",
      "user_id" : "user_id"
    },
    "error" : { }
  }, {
    "id" : "03141229-84cd-4b1b-9733-dd124320c126",
    "name" : "compute-02",
    "description" : "description2",
    "charge_mode" : "postPaid",
    "capacity" : [ {
      "type" : "CPU",
      "capacity" : 1000,
      "spec_code" : "aidatalake.cpu.x86.general.1c4g",
      "resource_id" : "cpu.03141229-84cd-4b1b-9733-dd124320c126"
    } ],
    "tags" : [ {
      "key" : "test",
      "value" : "ai"
    } ],
    "update_time" : "2025-01-10T03:38:12.000+00:00",
    "create_time" : "2025-01-10T03:38:12.000+00:00",
    "status" : "RUNNING",
    "creator" : {
      "domain_name" : "domain_name",
      "domain_id" : "domain_id",
      "user_name" : "user_name",
      "user_id" : "user_id"
    },
    "error" : { }
  }, {
    "id" : "03141229-84cd-4b1b-9733-dd124320c127",
    "name" : "compute-03",
    "description" : "description3",
    "charge_mode" : "postPaid",
    "capacity" : [ {
      "type" : "CPU",
      "capacity" : 1000,
      "spec_code" : "aidatalake.cpu.x86.general.1c4g",
      "resource_id" : "cpu.03141229-84cd-4b1b-9733-dd124320c127"
    } ],
    "tags" : [ {
      "key" : "test",
      "value" : "ai"
    } ],
    "update_time" : "2025-01-10T03:39:12.000+00:00",
    "create_time" : "2025-01-10T03:39:12.000+00:00",
    "status" : "RUNNING",
    "creator" : {
      "domain_name" : "domain_name",
      "domain_id" : "domain_id",
      "user_name" : "user_name",
      "user_id" : "user_id"
    },
    "error" : { }
  } ]
}

状态码：400

{
  "error_code" : "AIDataLake.00010151",
  "error_msg" : "Parameter value is invalid.",
  "solution_msg" : "Please input valid parameter value."
}

状态码：401

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
  "solution_msg" : "Check whether the IAM authentication information is correct."
}

状态码：403

{
  "error_code" : "AIDataLake.00010150",
  "error_msg" : "The operation is not allowed.",
  "solution_msg" : "Check whether the operation is allowed in the current status."
}

状态码：404

{
  "error_code" : "AIDataLake.00010009",
  "error_msg" : "No resources found.",
  "solution_msg" : "Ensure the requested resource exists and the parameters are correct."
}

状态码：500

{
  "error_code" : "AIDataLake.00011001",
  "error_msg" : "Internal error.",
  "solution_msg" : "Contact technical support or try again later."
}

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

500

内部服务器错误。
父主题： 计算资源管理

相关文档