文档首页/ 智能数据湖 AI DataLake/ API参考/ 端点管理/ 查询端点配置限制 - ShowV2EndpointResourceLimit
更新时间：2026-10-10 GMT+08:00
查看PDF
分享

查询端点配置限制 - ShowV2EndpointResourceLimit

功能介绍

查询指定资源池各规格的端点配置限制。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/endpoint-limit

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

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

约束限制：不涉及。

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

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

参数

是否必选

参数类型

描述

engine_type

是

String

参数解释：端点引擎类型。

约束限制：不涉及。

取值范围：

  • AuraJob：AuraJob引擎。

  • SparkSql：SparkSql引擎。

  • SparkJob：SparkJob引擎。

  • FlinkJob：FlinkJob引擎。

  • AuraJobV2：AuraJobV2引擎。

  • RayJob：RayJob引擎。

  • RayCluster：RayCluster引擎。

默认取值：不涉及。

id

否

String

参数解释：端点ID，可通过查询端点列表获取端点ID。

约束限制：不涉及。

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

默认取值：不涉及。

compute_id

是

String

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

约束限制：不涉及。

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

默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

约束限制：不涉及。

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

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ResourceLimit objects

参数解释：资源限制。
表5 ResourceLimit

参数

参数类型

描述

type

String

参数解释：资源类型。

取值范围：

  • CPU：中央处理器。

  • GPU：图形处理器。

  • NPU：神经网络处理器。

spec_code

String

参数解释：资源规格编码，标识资源池中具体的资源规格，由系统生成，例如"aidatalake.cpu.x86.general.1c2g"。

取值范围：由英文字母、数字、小数点和中划线组成，长度为1~64个字符。

compute_allocatable

ComputeAllocatable object

参数解释：可分配资源汇总。

compute_size

ComputeSize object

参数解释：资源总量信息。

worker_sizes

Array of WorkerSizeInfo objects

参数解释：可选的资源配置枚举列表。
表6 ComputeAllocatable

参数

参数类型

描述

cpu

Integer

参数解释：CPU剩余量，单位毫核。

取值范围：小于等于资源池该规格cpu大小。

mem

Integer

参数解释：内存剩余量，单位MB。

取值范围：小于等于资源池该规格内存大小。

accelerator

Integer

参数解释：显卡剩余量，单位卡。

取值范围：小于等于资源池该规格显卡大小。
表7 ComputeSize

参数

参数类型

描述

cpu

Integer

参数解释：CPU总量，单位毫核。

取值范围：等于资源池该规格cpu大小。

mem

Integer

参数解释：内存总量，单位MB。

取值范围：等于资源池该规格内存大小。

accelerator

Integer

参数解释：显卡总量，单位卡。

取值范围：等于资源池该规格显卡数量大小。
表8 WorkerSizeInfo

参数

参数类型

描述

cpu

Integer

参数解释：可选资源配置项中的CPU大小，即单个worker的CPU配置大小，单位毫核。

取值范围：小于等于资源池该规格CPU大小。

mem

Integer

参数解释：可选资源配置项中的内存大小，即单个worker的内存配置大小，单位MB。

取值范围：小于等于资源池该规格内存大小。

accelerator

Integer

参数解释：可选资源配置项中的显卡数量，即单个worker的显卡配置数量，单位卡。

取值范围：小于等于资源池该规格显卡大小。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：408

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

状态码：500

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

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

error_msg

String

参数解释：错误描述。

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

solution_msg

String

参数解释：解决方案。

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

请求示例

查询指定资源池的端点配置限制，包括资源池各规格资源大小和资源剩余量。

GET /v2/workspaces/{workspace_id}/endpoint-limit?engine_type=AuraJob&compute_id=0150a336-dda9-431c-9ef1-af02ec424a5e

响应示例

状态码：200

[ {
  "type" : "CPU",
  "spec_code" : "aidatalake.cpu.x86.general.1c2g",
  "compute_allocatable" : {
    "cpu" : 1000,
    "mem" : 2000
  },
  "compute_size" : {
    "cpu" : 10000,
    "mem" : 20000
  }
}, {
  "type" : "GPU",
  "spec_code" : "aidatalake.gpu.m.hnt02.8x.d",
  "compute_allocatable" : {
    "cpu" : 500,
    "mem" : 1000,
    "accelerator" : 2
  },
  "compute_size" : {
    "cpu" : 5000,
    "mem" : 10000,
    "accelerator" : 4
  }
} ]

状态码：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."
}

状态码：408

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred",
  "solution_msg" : "Try again later. If the problem persists, contact technical support."
}

状态码：500

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

状态码

状态码

描述

200

请求成功。

400

请求参数错误。

401

未授权。

403

禁止访问。

404

资源未找到。

408

请求超时。

500

内部服务器错误。
父主题： 端点管理

相关文档