查询Hyper Cluster实例详情 - ShowHyperCluster
功能介绍
查询Hyper Cluster实例详情接口用于获取指定Hyper Cluster实例的详细信息。该接口适用于以下场景:当用户需要了解某个超节点网络的具体配置和状态,以便进行管理和监控时,可以通过此接口获取相关信息。使用该接口的前提条件是用户已登录并具有查询Hyper Cluster详情的权限,且指定的超节点网络已存在。查询操作完成后,接口将返回指定超节点网络的详细信息,包括ID、名称、子网信息等。若用户无权限操作、指定的超节点网络不存在或ID无效,接口将返回相应的错误信息。
接口约束
暂无约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/dev-servers/hyper-clusters/{id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
参数解释:Hyper Cluster ID。 约束限制:必填。 取值范围:1 - 64字符。 默认取值:不涉及。 |
|
project_id |
是 |
String |
参数解释:用户项目ID。 约束限制:必填。 取值范围:1 - 64字符,字母、数字和中划线。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
参数解释:Hyper Cluster的类型。 约束限制:可选。 取值范围:
默认取值:HPS。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释:hyper cluster的ID。 取值范围:^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。 |
|
name |
String |
参数解释:hyper cluster的名称。 取值范围:^[-_.a-zA-Z0-9]{1,64}$。 |
|
network_info |
Array of network_info objects |
参数解释:网络信息。 |
请求示例
GET https://{endpoint}/v1/{project_id}/dev-servers/hyper-clusters/{id}
响应示例
状态码:200
OK
{
"id" : "74437437-6810-43b8-ba20-8f8e5bc034da",
"name" : "test-hps--1107",
"network_info" : [ {
"hyper_cluster_subnet_id" : "47be1c96-b00c-4cc9-83cb-089893a632b6",
"is_default" : true
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。