文档

QueryInstancesInfo - 查询集群静态信息

更新时间:

查询指定集群的运行时数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:QueryInstancesInfoRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

mse-09k1q11****
InstanceIdstring

实例 ID。

mse_prepaid_public_cn-tl32g1u9k01
OrderIdstring

订单 ID。

20574710974****
RegionIdstring

实例所属地域的 ID。

cn-hangzhou
RequestParsstring

扩展请求参数,JSON 格式。

{}
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

BaseResult

Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Messagestring

返回信息。

  • 当请求成功时,返回成功信息。
  • 当请求失败时,返回失败原因。
请求处理成功
RequestIdstring

请求 ID。

54973C90-F379-4372-9AA5-053A3F7****
ErrorCodestring

错误码。

mse-100-000
HttpCodestring

HTTP 状态码。

202
Dataobject []

数据概览。

HealthStatusstring

预留字段。

null
Rolestring

预留字段。

null
PodNamestring

POD 名称。

mse-xxxxx-xxxxx-reg-center-0-1
Ipstring

POD 的 IP。

25.24.91.x
InternetIpstring

公网 IP。

120.55.71.x
SingleTunnelVipstring

内网 IP。

172.16.66.x
CreationTimestampstring

创建时间。

2022-12-15T02:02:15Z
ClientPortstring

启用的端口。

8848
Zonestring

可用区。

cn-hangzhou-k
ZoneDistributedboolean

所有 Pod 是否已满足多可用区分布。

true

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "请求处理成功",
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "ErrorCode": "mse-100-000",
  "HttpCode": "202",
  "Data": [
    {
      "HealthStatus": "null",
      "Role": "null",
      "PodName": "mse-xxxxx-xxxxx-reg-center-0-1",
      "Ip": "25.24.91.x",
      "InternetIp": "120.55.71.x",
      "SingleTunnelVip": "172.16.66.x",
      "CreationTimestamp": "2022-12-15T02:02:15Z",
      "ClientPort": "8848",
      "Zone": "cn-hangzhou-k",
      "ZoneDistributed": true
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-25API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈