# 查询资源规格-GetResourceSpecList #### 功能介绍 查询资源规格 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:resourceManager:list | List | - | - | - | - | #### URI GET /v1.0/{project_id}/common/clusters/resource-specs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 查询偏移量 **约束限制**： 与limit配合使用 **取值范围**： 最小值为0 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 返回个数上限 **约束限制**： 与offset配合使用 **取值范围**： 最小值为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 **约束限制**： 不涉及 **取值范围**： 标准36位带横杠、小写UUID **默认取值**： 不涉及 | | cluster_id | 是 | String | **参数解释**： 集群ID **约束限制**： 不涉及 **取值范围**： 标准36位带横杠、小写UUID **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [ResourceSpecs] object | **参数解释**： 实际返回信息 | | meta_info | [RespMetaInfo] object | **参数解释**： 元数据 | 表5ResourceSpecs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | list | Array of [ResourceSpecsDto] objects | **参数解释**： 规格列表 | | page_info | [PageInfo] object | **参数解释**： 分页信息 | 表6ResourceSpecsVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 资源规格可用节点的数量 **取值范围**： 不涉及 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Integer | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 资源总数 **取值范围**： 不涉及 | 表8RespMetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 查询训练任务资源规格列表 ``` GET https://{endpoint}/v1.0/{project_id}/common/clusters/resource-specs?usage=TRAINING_TRAIN ``` #### 响应示例 **状态码：200** OK ``` { "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 } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 没有可用的资源规格或者请求的usage类型不存在 | | 403 | 权限校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。