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

查询集群列表

分享
更新时间: 2019/09/12 11:31

功能介绍

该接口用于查询并显示集群列表。

URI

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

    参数

    是否必选

    参数类型

    描述

    project_id

    String

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

请求

请求样例

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

响应

  • 响应样例
    {
            "clusters": [
            {
            "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
            "status": "AVAILABLE",
            "sub_status": "READONLY",            
            "task_status": "SNAPSHOTTING",
            "action_progress": {"SNAPSHOTTING": "20%"},
            "node_type": "dws.m1.xlarge.ultrahigh",
            "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,
            "name": "dws-1",
            "version": "1.2.0",
            "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
            "user_name": "dbadmin",
            "public_ip": {
                "public_bind_type": "auto_assign",
                "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
             },
            "public_endpoints": [
                {
                    "public_connect_info": "dws-1.cn-north-1.myhwclouds.com",
                    "jdbc_url": "jdbc:postgresql://dws-1.cn-north-1.myhwclouds.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>"
                },
             ] , 
            "updated": "2016-02-10T14:28:14Z",
            "created": "2016-02-10T14:26:14Z", 
            "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",
            "recent_event": 6
            }
        ]
    }
  • 参数说明
    表2 响应参数说明

    参数

    是否必选

    参数类型

    描述

    clusters

    Array

    集群对象列表。

    id

    String

    集群ID。

    status

    String

    集群状态,有效值包括:

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

    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<String, String>

    任务信息,由key、value组成。key值为正在进行的任务,value值为正在进行任务的进度。

    key值的有效值包括:

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

    示例如下:

    "action_progress":{"SNAPSHOTTING":"16%"}

    node_type

    UUID

    节点类型。

    subnet_id

    UUID

    子网ID。

    security_group_id

    UUID

    安全组ID。

    number_of_node

    Integer

    节点数量。

    availability_zone

    String

    可用区。

    port

    Integer

    集群服务端口,取值范围8000~10000,默认值:8000。

    name

    String

    集群名称。

    version

    String

    数据仓库版本。

    vpc_id

    UUID

    虚拟私有云ID。

    user_name

    String

    管理员用户。

    public_ip

    public_ip object

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

    public_endpoints

    Array of public_endpoints object

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

    endpoints

    Array of endpoints object

    集群的内网连接信息。

    updated

    String

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

    created

    String

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

    failed_reasons

    failed_reasons object

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

    enterprise_project_id

    UUID

    企业项目ID。

    recent_event

    Integer

    事件数。

    表3 public_ip字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    public_bind_type

    String

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

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

    eip_id

    UUID

    弹性IP的id。

    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 failed_reasons字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    error_code

    String

    错误码,取值如下:

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

    error_msg

    String

    错误信息。

返回值

  • 正常

    200

  • 异常
    表7 返回值说明

    返回值

    描述

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

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

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区