更新时间:2022-08-16 GMT+08:00

查询集群列表

功能介绍

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

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.d1.xlarge.ultrahigh",
            "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
            "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
            "number_of_node": 3,
            "availability_zone": "my-kualalumpur-1",
            "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": "10.0.0.8:8000",
                    "jdbc_url": "jdbc:postgresql://10.0.0.8:8000/<YOUR_DATABASE_name>"
                }
             ],
            "endpoints": [
                {
                    "connect_info": "192.168.0.12:8000",
                    "jdbc_url": "jdbc:postgresql://192.168.0.12:8000/<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
            "tags":[           
                     { 
                      "key": "key1",              
                      "value": "value1"           
                     }, 
                    { 
                    "key": "key2",              
                    "value": "value2"            
                    } 
                  ], 
            }
        ],
           "count":"2"
    }
  • 参数说明
    表2 响应参数说明

    参数

    参数类型

    描述

    clusters

    Array of ClusterInfo objects

    集群对象列表。

    count

    Integer

    集群对象的总数。

    表3 ClusterInfo

    参数

    参数类型

    描述

    id

    String

    集群ID。

    status

    String

    集群状态,有效值包括:

    • CREATING:创建中
    • AVAILABLE:可用
    • UNAVAILABLE:不可用
    • CREATION FAILED:创建失败

    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

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

    • 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 : 修复中
      • CREATING : 创建中
    • value值为正在进行任务的进度。

    示例如下:

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

    node_type

    String

    节点类型

    subnet_id

    String

    子网ID

    security_group_id

    String

    安全组ID

    number_of_node

    Integer

    集群节点数量,取值范围为2~256。

    availability_zone

    String

    可用区

    port

    Integer

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

    name

    String

    集群名称

    version

    String

    数据仓库版本

    vpc_id

    String

    虚拟私有云ID

    user_name

    String

    集群管理员用户名

    public_ip

    PublicIp object

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

    public_endpoints

    Array of PublicEndpoints objects

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

    endpoints

    Array of Endpoints objects

    集群的内网连接信息。

    updated

    String

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

    created

    String

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

    tags

    Tags object

    集群的标签。

    recent_event

    Integer

    事件数。

    failed_reasons

    FailedReason object

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

    表4 PublicIp

    参数

    是否必选

    参数类型

    描述

    public_bind_type

    String

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

    • auto_assign:现在购买
    • not_use:暂不使用
    • bind_existing :使用已有

    eip_id

    String

    弹性IP的id

    表5 Tags

    参数

    参数类型

    描述

    value

    String

    值。输入标签值的最大长度为43个字符,首尾字符不能为空格,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 只能包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(中划线-、下划线_)以及中文字符。

    key

    String

    键。输入标签键的最大长度为36个unicode字符,不能为空字符串,且首尾字符不能为空格。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 只能包含大写字母(A-Z)、小写字母(a-z)、数字(0-9)和特殊字符(中划线-、下划线_)以及中文字符。

    表6 PublicEndpoints

    参数

    参数类型

    描述

    public_connect_info

    String

    公网连接信息

    jdbc_url

    String

    公网JDBC URL

    表7 Endpoints

    参数

    是否必选

    参数类型

    描述

    connect_info

    String

    内网连接信息。

    jdbc_url

    String

    内网JDBC URL,默认格式如下

    jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

    表8 FailedReason

    参数

    参数类型

    描述

    error_code

    String

    错误码。

    error_msg

    String

    错误信息。

返回值

  • 正常

    200

  • 异常
    表9 返回值说明

    返回值

    描述

    400 Bad Request

    请求错误。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。