查询镜像规格族-ListImageHypernodeTypeFamilies
功能介绍
查询指定镜像支持的超节点规格族列表。
该接口适用于以下场景:当用户需要了解某个镜像支持哪些超节点规格族时,可通过此接口查询。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::listImageHypernodeTypeFamilies | List | - | - | - | - |
URI
GET /v2/{project_id}/images/{image_id}/hypernode-type-families
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| image_id | 是 | String | 参数解释: IMS镜像ID,用于唯一标识一个IMS镜像。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。可通过查询镜像列表获取。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 分页查询单页记录数量。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 20。 |
| marker | 否 | String | 参数解释: 分页标记,本次请求获取该标记后的资源,base64编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| page_info | PageInfo object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| hypernode_type_families | Array of strings | 参数解释: 镜像支持的超节点规格族列表。该参数用于描述镜像可运行的超节点规格族名称,影响镜像的适用范围。 取值范围: 列表长度取决于实际关联的规格族数量。 |
请求示例
查询镜像规格族请求示例。使用场景:用户需要了解某个镜像支持哪些超节点规格族时,通过镜像ID查询其支持的规格族列表。
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/images/4771d482-ac26-4a67-846f-bfb2ffeed4ff/hypernode-type-families 响应示例
状态码:200
{
"hypernode_type_families" : [ "ka5n" ],
"page_info" : {
"next_marker" : null,
"current_count" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。