查询可用资源规格-QueryAvailableResourceSpecifications

功能介绍

用户可根据资源规格用途查询可用的资源规格列表

URI

GET https://{host_url}/v1.0/{project_id}/common/clusters/resource-specs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目id。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	查询偏移量。最小值：0 缺省值：0
limit	否	Integer	返回个数上限。最小值：1 最大值：200 缺省值：10
usage	否	String	资源规格用途。枚举值： SIM_COMPILE(仿真编译) SIM_DOCKER(仿真异步镜像) DATA_PROCESS(数据处理) DATA_CONVERSION(数据转换) DATA_RESIM(回放仿真) DATA_DESENSITIZATION(数据脱敏) TRAINING_TRAIN(训练任务) TRAINING_EVALUATE(模型评测) TRAINING_COMPILE(模型编译) ANNOTATION_MANUAL(人工标注) ANNOTATION_AI(预标注) COMMON_DATASET(数据集)
spec	否	String	资源规格： GPU型：{GPU型号}{GPU个数}Gpu{CPU核数}Core_{内存大小}GiB ->例： P100_1Gpu_2.1Core_4.1GiB； CPU型：{CPU核数}Core_{内存大小}GiB ->例：2Core_4GiB
spec_id	否	String	资源规格ID。
cluster_id	是	String	集群ID。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
payload	ResourceSpecs object	-
meta_info	RespMetaInfo object	-

表5 ResourceSpecs
参数	参数类型	描述
list	Array of ResourceSpecsDto objects	-
page_info	PageInfo object	返回列表分页信息。

表6 ResourceSpecsVo
参数	参数类型	描述
id	String	ID
cluster_id	String	集群ID。
usage	String	资源规格用途。枚举值： SIM_COMPILE(仿真编译) SIM_DOCKER(仿真异步镜像) DATA_PROCESS(数据处理) DATA_CONVERSION(数据转换) DATA_RESIM(回放仿真) DATA_DESENSITIZATION(数据脱敏) TRAINING_TRAIN(训练任务) TRAINING_EVALUATE(模型评测) TRAINING_COMPILE(模型编译) ANNOTATION_MANUAL(人工标注) ANNOTATION_AI(预标注) COMMON_DATASET(数据集)
gpu_type	String	GPU类型(资源规格不包含GPU，此字段不会返回)。枚举值： T4(NVIDIA T4) V100(NVIDIA V100) M60(NVIDIA M60) P100(NVIDIA P100) P4(NVIDIA P4)
gpu	Integer	GPU数量，整数(资源规格不包含GPU，此字段不会返回)。
cpu	String	CPU数量，单位Core,支持一位小数。
memory	String	内存大小，单位GiB,支持一位小数。
build_in	Boolean	是否内置资源规格，true代表内置资源规格，false代表用户自定义资源规格。
project_id	String	项目ID。
match_nodes	Integer	资源规格可用节点的数量。

表7 PageInfo
参数	参数类型	描述
offset	Integer	查询偏移量。
limit	Integer	返回个数上限。
total	Integer	资源总数。

表8 RespMetaInfo
参数	参数类型	描述
current_time	String	请求时间，UTC时间格式，时间为UTC标准时间。

请求示例

查询训练任务资源规格列表

GET https://{endpoint}/v1.0/{project_id}/common/clusters/resource-specs?usage=TRAINING_TRAIN

响应示例

状态码：200

{
  "meta_info" : {
    "current_time" : "2023-12-13T09:55:45Z"
  },
  "payload" : {
    "list" : [ {
      "id" : "ef4fd3d6-fa4e-49ea-989a-3216c36164d7",
      "cluster_id" : "3c151f54-e5df-4b6c-8690-b955df98a97f",
      "match_nodes" : 1,
      "usage" : "TRAINING_TRAIN",
      "cpu" : 5,
      "memory" : 20,
      "build_in" : false,
      "project_id" : "54d37c8f25af4277a1ff4ee9772687bf"
    }, {
      "id" : "38aa2057-4217-41d0-b5ba-94f8832e909e",
      "cluster_id" : "3c151f54-e5df-4b6c-8690-b955df98a97f",
      "match_nodes" : 1,
      "usage" : "TRAINING_TRAIN",
      "gpu_type" : "Ant03",
      "gpu" : 1,
      "cpu" : 5,
      "memory" : 20,
      "build_in" : false,
      "project_id" : "54d37c8f25af4277a1ff4ee9772687bf"
    }, {
      "id" : "2ac937fa-d17a-4991-8e56-f1951b878af8",
      "cluster_id" : "3c151f54-e5df-4b6c-8690-b955df98a97f",
      "match_nodes" : 1,
      "usage" : "TRAINING_TRAIN",
      "gpu_type" : "Ant03",
      "gpu" : 1,
      "cpu" : 4,
      "memory" : 20,
      "build_in" : false,
      "project_id" : "54d37c8f25af4277a1ff4ee9772687bf"
    }, {
      "id" : "7676f33e-cf22-4227-aac1-ac3865ceddb2",
      "cluster_id" : "3c151f54-e5df-4b6c-8690-b955df98a97f",
      "match_nodes" : 1,
      "usage" : "TRAINING_TRAIN",
      "gpu_type" : "Ant03",
      "gpu" : 1,
      "cpu" : 4,
      "memory" : 32,
      "build_in" : false,
      "project_id" : "54d37c8f25af4277a1ff4ee9772687bf"
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 4,
      "total" : 4
    }
  }
}