查询端点配置限制 - ShowV2EndpointResourceLimit

功能介绍

查询指定资源池各规格的端点配置限制。用户可通过该接口查询计算资源池各规格资源大小和资源剩余量，各规格下端点可配置的cpu，mem，卡数列表。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间ID。取值范围：长度为32~36的英文字符、数字和中划线的组合。

表2 Query参数
参数	是否必选	参数类型	描述
engine_type	是	String	参数解释：端点引擎类型列表。约束限制：不涉及。取值范围： AuraJob：AuraJob引擎。 SparkSql：SparkSql引擎。 SparkJob：SparkJob引擎。 AuraJobV2：AuraJobV2引擎。 RayJob：RayJob引擎。 RayCluster：RayCluster引擎。默认取值：不涉及。
id	否	String	参数解释：端点ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。
compute_id	是	String	参数解释：计算资源ID。约束限制：不涉及。取值范围：长度为36个英文字母、数字和中划线的组合。默认取值：不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。约束限制：不涉及。取值范围：长度不超过65534个字符。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
[数组元素]	Array of ResourceLimit objects	参数解释：资源限制。

表5 ResourceLimit
参数	参数类型	描述
type	String	参数解释：资源类型。取值范围： CPU：CPU资源。 GPU：GPU资源。 NPU：NPU资源。
spec_code	String	参数解释：资源规格。取值范围：长度为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，单位毫核。取值范围：小于等于资源池该规格cpu大小。
mem	Integer	参数解释：内存，单位MB。取值范围：小于等于资源池该规格内存大小。
accelerator	Integer	参数解释：显卡，单位卡。取值范围：小于等于资源池该规格显卡大小。

状态码：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_max" : 10000,
    "mem_max" : 20000
  }
}, {
  "type" : "GPU",
  "spec_code" : "aidatalake.gpu.m.hnt02.8x.d",
  "compute_allocatable" : {
    "cpu" : 500,
    "mem" : 1000,
    "accelerator" : 2
  },
  "compute_size" : {
    "cpu_max" : 5000,
    "mem_max" : 10000,
    "accelerator_max" : 4
  }
} ]

状态码：400

请求参数错误。

{
  "error_code" : "AIDataLake.00010011",
  "error_msg" : "Invalid specification code.",
  "solution_msg" : "Enter a correct specification code."
}

状态码：401

未授权。

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information decrypt token fail"
}

状态码：403

禁止访问。

{
  "error_code" : "AIDataLake.00010038",
  "error_msg" : "Unauthorized requests.",
  "solution_msg" : "Check permissions {xxx} and retry after authorization."
}

状态码：404

资源未找到。

{
  "error_code" : "AIDataLake.00010004",
  "error_msg" : "Not Found",
  "solution_msg" : "Please check the resource ID and try again"
}

状态码：408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

内部服务器错误。

{
  "error_code" : "AIDataLake.00010067",
  "error_msg" : "Failed to initialize the task because the number of tasks may have reached the upper limit.",
  "solution_msg" : "Try again later."
}