文档首页 > > API参考> API说明> 集群管理接口> 查询集群详情

查询集群详情

分享
更新时间:2020/09/21 GMT+08:00

功能介绍

该接口用于查询集群详情。

URI

  • URI 格式
    GET /v1.0/{project_id}/clusters/{cluster_id}
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。获取方法,请参见获取项目ID

    cluster_id

    String

    集群ID。

请求消息

请求样例

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

响应消息

  • 响应样例
    {
        "cluster": {
            "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
            "status": "AVAILABLE",
            "name": "dws-1",
            "updated": "2018-02-10T14:28:14Z",
            "created": "2018-02-10T14:28:14Z",
            "user_name": "dbadmin",
            "sub_status": "READONLY",
            "task_status": "SNAPSHOTTING",
            "action_progress": {"SNAPSHOTTING": "20%"},
            "node_type":   "dws.m1.xlarge.ultrahigh",
            "node_type_id": "5ddb1071-c5d7-40e0-a874-8a032e81a697",
            "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
            "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
            "number_of_node": 3,
            "availability_zone": "cn-north-1b",
            "port": 8000,
            "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
            "public_ip": {
                "public_bind_type": "auto_assign",
                "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
                "eip_address": "100.95.157.20"
            },        
            "private_ip":["192.168.0.12","192.168.0.66"],        
            "public_endpoints": [
                {
                    "public_connect_info": "dws-1.cn-north-1.myhuaweicloud.com",
                    "jdbc_url": "jdbc:postgresql://dws-1.cn-north-1.myhuaweicloud.com/<YOUR_DATABASE_NAME>"
                }
             ],
            "endpoints": [
                {
                    "connect_info": "dws-1.cn-north-1.myhuaweicloud.com",
                    "jdbc_url": "jdbc:postgresql://dws-1.cn-north-1.myhuaweicloud.com/<YOUR_DATABASE_NAME>"
                }
             ],
            "version": "1.2.0",
            "maintain_window": {
                "day": "Wed",
                "start_time": "22:00",
                "end_time": "02:00"
            },
            "resize_info" : { 
                "target_node_num": "6",
                "origin_node_num": "3",
                "status": "GROWING",
                "start_time": "2018-02-14T14:28:14Z",
                "origin_node_type": "dws.m1.xlarge.ultrahigh",
                "target_node_type": "dws.d2.xlarge"
            }, 
            "enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065",
            "recent_event": 6, 
            "tags":[ 
                { 
                    "key": "key1", 
                    "value": "value1" 
                }, 
                { 
                    "key": "key2", 
                    "value": "value2" 
                } 
              ], 
    
             "parameter_group": {
                  "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
                  "name": "Default-Parameter-Group-DWS",
                  "status": "In-Sync"
             } 
        }
    } 
  • 参数说明
    表2 响应参数说明

    参数

    是否必选

    参数类型

    描述

    cluster

    Object

    集群对象。

    id

    String

    集群ID。

    status

    String

    集群状态,有效值包括:

    • CREATING:创建中
    • AVAILABLE:可用
    • UNAVAILABLE:不可用
    • CREATION FAILED:创建失败
    • FROZEN:已冻结

    name

    String

    集群名称。

    updated

    String

    集群上次修改时间,格式为ISO8601:YYYY-MM-DDThh:mm:ssZ。

    created

    String

    集群创建时间,格式为ISO8601:YYYY-MM-DDThh:mm:ssZ。

    user_name

    String

    管理员用户名。

    sub_status

    String

    “可用”集群状态的子状态,有效值包括:

    • NORMAL:正常
    • READONLY:只读
    • REDISTRIBUTING:重分布中
    • REDISTRIBUTION-FAILURE:重分布失败
    • UNBALANCED:低性能
    • UNBALANCED | READONLY:低性能,只读。
    • DEGRADED:节点故障
    • DEGRADED | READONLY:节点故障,只读。
    • DEGRADED | UNBALANCED:节点故障,低性能。
    • UNBALANCED | REDISTRIBUTING:低性能,重分布中。
    • UNBALANCED | REDISTRIBUTION-FAILURE:低性能,重分布失败。
    • READONLY | REDISTRIBUTION-FAILURE:只读,重分布失败。
    • UNBALANCED | READONLY | REDISTRIBUTION-FAILURE:低性能,只读,重分布失败。
    • DEGRADED | REDISTRIBUTION-FAILURE:节点故障,重分布失败。
    • DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE:节点故障,低性能,只读,重分布失败。
    • DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE:节点故障,低性能,只读,重分布失败。
    • DEGRADED | UNBALANCED | READONLY:节点故障,低性能,只读。

    task_status

    String

    集群管理任务,有效值包括:

    • UNFREEZING:解冻中
    • FREEZING:冻结中
    • RESTORING:恢复中
    • SNAPSHOTTING:快照中
    • GROWING:扩容中
    • REBOOTING:重启中
    • SETTING_CONFIGURATION:安全设置配置中
    • CONFIGURING_EXT_DATASOURCE:MRS连接配置中
    • DELETING_EXT_DATASOURCE:删除MRS连接
    • REBOOT_FAILURE:重启失败
    • RESIZE_FAILURE:扩容失败

    action_progress

    Map

    Key值为正在进行的任务,有效值包括:

    • GROWING:扩容中
    • RESTORING:恢复中
    • SNAPSHOTTING:快照中
    • REPAIRING : 修复中
    • CREATING : 创建中

      value值为正在进行任务的进度。

    node_type

    UUID

    节点类型。

    node_type_id

    UUID

    节点类型ID。

    subnet_id

    UUID

    子网ID。

    security_group_id

    UUID

    安全组ID。

    number_of_node

    Integer

    节点数量。

    availability_zone

    String

    可用区。

    port

    Integer

    集群服务端口(8000~30000),默认值:8000。

    vpc_id

    UUID

    虚拟私有云ID。

    public_ip

    public_ip object

    公网IP地址,如果未指定,则默认不使用公网连接。

    private_ip

    Array

    内网IP地址列表。

    public_endpoints

    Array of public_endpoints object

    集群的公网连接信息,如果未指定,则默认不使用公网连接信息。

    endpoints

    Array of endpoints object

    集群的内网连接信息。

    version

    String

    数据仓库版本。

    maintain_window

    maintain_window object

    集群维护时间窗信息。

    resize_info

    resize_info object

    集群扩容状态详情。

    failed_reasons

    failed_reasons object

    失败原因。如果为空,则集群处于正常状态。

    enterprise_project_id

    String

    企业项目ID。值为0表示默认企业项目“default”。

    recent_event

    Integer

    事件数。

    tags

    Array of tags object

    集群标签。

    parameter_group

    parameter_group object

    集群所关联的参数组信息。

    表3 public_ip字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    public_bind_type

    String

    弹性IP绑定类型,取值如下:

    • auto_assign:自动绑定
    • not_use:暂未使用
    • bind_existing :使用已有

    eip_id

    UUID

    弹性IP的id。

    eip_address

    String

    弹性IP地址。

    status

    String

    eip绑定状态,取值如下:

    • FAIL:绑定失败

    error_message

    String

    eip绑定失败原因。

    表4 public_endpoints字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    public_connect_info

    String

    公网连接信息。

    jdbc_url

    String

    公网JDBC URL,默认格式如下:

    jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_NAME>

    表5 endpoints字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    connect_info

    String

    内网连接信息。

    jdbc_url

    String

    内网JDBC URL,默认格式如下:

    jdbc:postgresql://< connect_info>/<YOUR_DATABASE_NAME>

    表6 maintain_window字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    day

    String

    每周的维护时间,以天为粒度,取值如下

    • Mon:星期一
    • Tue:星期二
    • Wed:星期三
    • Thu:星期四
    • Fri: 星期五
    • Sat:星期六
    • Sun:星期日

    start_time

    String

    维护开始时间,显示格式为 HH:mm,时区为GMT+0。

    end_time

    String

    维护结束时间,显示格式为 HH:mm, 时区为GMT+0。

    表7 resize_info字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    target_node_num

    Integer

    扩容后的节点数量。

    origin_node_num

    Integer

    扩容前的节点数量。

    status

    String

    扩容状态,取值如下:

    • GROWING:扩容中
    • RESIZE_FAILURE:扩容失败

    origin_node_type

    String

    调整大小前节点规格。

    target_node_type

    String

    调整大小后节点规格。

    start_time

    String

    扩容开始时间,格式为ISO8601:YYYY-MM-DDThh:mm:ss。

    表8 failed_reasons字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    error_code

    String

    错误码,取值如下:

    • DWS.6000:集群创建失败
    • DWS.6001:集群扩容失败
    • DWS.6002:集群重启失败
    • DWS.6003:集群恢复失败

    error_msg

    String

    错误信息。

    表9 tags字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    key

    String

    标签的键

    value

    String

    标签的值

    表10 parameter_group字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    id

    String

    参数组ID

    name

    String

    参数组名称

    status

    String

    集群参数状态,有效值包括:

    • In-Sync:已同步
    • Applying:应用中
    • Pending-Reboot:需重启生效
    • Sync-Failure:应用失败

状态码

  • 正常

    200

  • 异常
    表11 返回值说明

    返回值

    描述

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问