查询纳管资源池详情 - ShowV2ServiceCluster
功能介绍
该接口允许用户通过指定资源池的ID来查询纳管资源池的详细信息,包括实例ID、名称、Flavor规格、实例状态和实例可访问的URL。此功能适用于需要监控或管理云资源的用户,使用该接口前,用户需确保已拥有访问权限及正确的资源池ID。执行成功后,用户将获得所需的实例详情,可用于进一步的资源管理和配置。如果资源池ID无效或用户没有相应的访问权限,接口将返回错误信息,如404 Not Found或401 Unauthorized。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts:pool:get
Read
pool *
g:ResourceTag/<tag-key>
-
-
-
g:EnterpriseProjectId
URI
GET /v2/{project_id}/services/clusters/{id}
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-User-Token | 否 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| workspace_id | String | 参数解释: 工作空间ID。未创建工作空间时默认值为“0”,存在创建并使用的工作空间,以实际取值为准。 取值范围: 不涉及。 |
| logic_cluster_id | String | 参数解释: 资源池cceID。 取值范围: 不涉及。 |
| status | String | 参数解释: 资源当前状态。 取值范围: |
| pool_id | String | 参数解释: 专属资源池ID。 取值范围: 不涉及。 |
| type | String | 参数解释: 专属池类型。 取值范围: |
| resource_categories | Array of strings | 参数解释: 资源池类型。 |
| project_id | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 取值范围: 不涉及。 |
| create_at | Long | 参数解释: 资源池启用的时间,UTC毫秒。 取值范围: 不涉及。 |
| update_at | Long | 参数解释: 资源池最后更新的时间,UTC毫秒。 取值范围: 不涉及。 |
| flavors | Array of NotebookFlavor objects | 参数解释: 当前专属池支持的规格。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| arch | String | 参数解释: 架构类型。 取值范围: |
| ascend | AscendInfo object | 参数解释: NPU信息。 |
| billing | BillingInfo object | 参数解释: 话单信息。 |
| category | String | 参数解释: 规格处理器类型。 取值范围: |
| description | String | 参数解释: 规格描述信息。 取值范围: 不涉及。 |
| feature | String | 参数解释: 规格类别。 取值范围: |
| free | Boolean | 参数解释: 是否为免费规格。 取值范围: |
| gpu | GPUInfo object | 参数解释: GPU信息。 取值范围: 不涉及。 |
| id | String | 参数解释: 规格ID。 取值范围: 不涉及。 |
| memory | Long | 参数解释: 内存大小。 取值范围: 不涉及。 |
| name | String | 参数解释: 规格名称。 取值范围: 不涉及。 |
| sold_out | Boolean | 参数解释: 资源是否充足。 取值范围: |
| storages | Array of strings | 参数解释: 规格支持的存储类型。 |
| vcpus | Integer | 参数解释: CPU核数。 取值范围: 不涉及。 |
| evs_max_size | String | 参数解释: EVS磁盘最大容量。 取值范围: 不涉及。 |
请求示例
指定资源池的ID来查询纳管资源池的详细信息。
https://{endpoint}/v2/{project_id}/services/clusters/{id}
{
"id" : "123e4567-e89b-12d3-a456-426655440000"
} 响应示例
状态码:200
成功获取纳管集群的详细信息。
{
"logic_cluster_id" : "df7ab421-4c12-4032-a344-b2e41aa1a962",
"status" : "ACTIVE",
"pool_id" : "pool-id***example",
"type" : "DEDICATED",
"resource_categories" : [ "CPU" ],
"flavors" : [ {
"arch" : "x86_64",
"billing" : {
"unit_num" : 0
},
"category" : "CPU",
"description" : "General-purpose CPU specifications, ideal for data exploration and algorithm discovery",
"evs_max_size" : "4096",
"feature" : "NOTEBOOK",
"free" : false,
"id" : "modelarts.vm.cpu.2u.8g",
"memory" : 8388608,
"name" : "CPU: 2vCPUs 8GB",
"sold_out" : false,
"storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
"vcpus" : 2
}, {
"arch" : "x86_64",
"billing" : {
"code" : "modelarts.vm.cpu.4u",
"unit_num" : 1
},
"category" : "CPU",
"description" : "General-purpose Intel CPU specifications, ideal for data exploration and algorithm discovery.",
"evs_max_size" : "4096",
"feature" : "NOTEBOOK",
"free" : false,
"id" : "modelarts.vm.cpu.4u",
"memory" : 16777216,
"name" : "CPU: 4vCPUs 16GB",
"sold_out" : false,
"storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
"vcpus" : 4
}, {
"arch" : "x86_64",
"billing" : {
"code" : "modelarts.vm.cpu.8u",
"unit_num" : 1
},
"category" : "CPU",
"description" : "General computing-plus Intel CPU specifications, ideal for compute-intensive applications.",
"evs_max_size" : "4096",
"feature" : "NOTEBOOK",
"free" : false,
"id" : "modelarts.vm.cpu.8u",
"memory" : 33554432,
"name" : "CPU: 8vCPUs 32GB",
"sold_out" : false,
"storages" : [ "OBS", "EFS_DEDICATED", "EVS", "OBSFS" ],
"vcpus" : 8
} ],
"workspace_id" : "0",
"create_at" : 1721795441423,
"update_at" : 1724767716067,
"project_id" : "06024304be00d***example"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功获取纳管集群的详细信息。 |
错误码
请参见错误码。