全部产品
Search

搜索本产品

    实时数仓Hologres：ListLeaderInstances - 获取主实例列表

    文档中心

    实时数仓Hologres：ListLeaderInstances - 获取主实例列表

    更新时间：Sep 17, 2026

    获取可能的主实例Id列表。

    接口说明

    获取可与指定 Hologres 从实例绑定的主实例列表。instanceId 为路径参数，调用时必须提供。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    hologram:ListLeaderInstances

    list

    *Instance

    acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 无 无

    请求语法

    GET /api/v1/instances/{instanceId}/primaryInstances HTTP/1.1

    路径参数

    名称

    类型

    必填

    描述

    示例值
    instanceId

    string

    否

    实例 ID。该参数位于请求路径中，调用时必须提供。

    hgprecn-cn-zxu3001jn00d

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    否

    地域 id。

    cn-hangzhou

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    Id of the request

    5600196E-78E2-50F2-B2A1-C44D3B665438
    InstanceList

    array<object>

    实例列表。

    array<object>

    角色列表。

    ChargeType

    string

    付费类型。

    枚举值：

    • PostPaid :

      包年包月

    • PrePaid :

      按量付费

    PostPaid
    CommodityCode

    string

    商品 Code

    hologram_combo_public_cn
    CreationTime

    string

    创建时间。采用 ISO 8601 格式的 UTC 时间。

    2022-07-25T02:15:35Z
    ExpirationTime

    string

    到期时间（按量付费类型没有到期时间）。采用 ISO 8601 格式的 UTC 时间。

    2022-07-25T02:15:35Z
    InstanceId

    string

    实例 ID。

    hgpostcn-cn-tl32vsdir00h
    InstanceName

    string

    实例名称。

    user_defined_name
    InstanceStatus

    string

    实例状态。

    枚举值：

    • Creating :

      正在创建

    • Running :

      正常运行

    • Suspended :

      停机

    • Allocating :

      正在处理，一些接口可能不允许操作

    Running
    InstanceType

    string

    实例类型。

    枚举值：

    • Follower :

      只读从实例

    • Standard :

      普通型

    Standard
    Tags

    array<object>

    标签列表。

    object

    标签列表。

    Key

    string

    标签键。

    tagKey
    Value

    string

    标签值。

    value
    BindingCode

    string

    主实例和从实例的匹配程度。0 表示完美匹配，其他表示不匹配。

    0
    Success

    string

    请求结果,表示此次请求是否发生异常，与业务无关。

    枚举值：

    • false :

      失败

    • true :

      成功

    true
    ErrorCode

    string

    错误码。

    404
    ErrorMessage

    string

    错误信息。

    Internal server error.
    HttpStatusCode

    string

    http 状态码。

    200

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "5600196E-78E2-50F2-B2A1-C44D3B665438",
  "InstanceList": [
    {
      "ChargeType": "PostPaid",
      "CommodityCode": "hologram_combo_public_cn",
      "CreationTime": "2022-07-25T02:15:35Z",
      "ExpirationTime": "2022-07-25T02:15:35Z",
      "InstanceId": "hgpostcn-cn-tl32vsdir00h",
      "InstanceName": "user_defined_name",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tagKey",
          "Value": "value"
        }
      ],
      "BindingCode": "0"
    }
  ],
  "Success": "true",
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

    错误码

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

    变更历史

    更多信息，参考变更详情。