文档首页/ 数据仓库服务 GaussDB(DWS)/ API参考/ 应用示例/ 使用Postman调用创建集群接口
更新时间:2024-04-18 GMT+08:00

使用Postman调用创建集群接口

场景介绍

本章节指导用户使用Postman创建GaussDB(DWS)集群。该接口为异步接口,创建集群需要10~15分钟。API的调用方法请参考如何调用API

准备工作

  • 已注册华为云账号并开通华为云。
  • 已获取服务对应区域终端节点地址,具体请参考地区和终端节点
  • 已获取华为云账号对应的用户名、用户密码、账号名及项目ID。在华为云控制台右上角“我的凭证->API凭证->项目列表”查看用户名、账号名、用户密码和所属区域项目ID。项目ID获取方法请参见获取项目ID
  • 创建VPC,并获取VPC和子网的ID,具体参考虚拟私有云VPC

操作步骤

  1. 环境配置。

    下载Postman调用创建快照服务,Postman建议使用7.24.0版本。

  2. 获取Token,进行认证。

    1. 在Postman界面上新建Post请求,选中Body的配置项,填写用户名、用户密码、账号名及项目ID。

      获取token的华为云服务所在区域需要和调用的服务所在区域需一致,否则会导致调用失败。

    2. 单击右上角“Send”,发送“POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens”。获取返回结果中的Headers->X-Subject-Token值(Token有效期为24小时)。

  3. 调用创建集群接口。

    1. 在Postman界面上新建Post请求,选中“Headers”配置项,添加对应的KEY、VALUE,复制Token值到“X-Auth-Token”。
    2. 调用接口,本服务提供了两个创建集群接口。其中请求URL的所在区域需要与调用的服务所在区域保持一致,project_id为项目ID(必填参数),获取方法参见准备工作
      • v1接口:
        POST https://{Endpoint}/v1.0/{project_id}/clusters
      • v2接口:
        POST https://{Endpoint}/v2/{project_id}/clusters

      推荐使用v2接口。

    3. 单击“Body”, 添加请求参数值到请求中。不同服务的参数各不相同,详情请参考API说明
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      {
          "cluster": {
              "flavor": "dwsx2.rt.xlarge.m6",
              "num_node": 3,
              "subnet_id": "050e154d-9954-4929-b6d3-12af7c9213ac",
              "security_group_id": "",
              "vpc_id": "050e154d-9954-4929-b6d3-12af7c9213ac",
              "db_port": 8000,
              "datastore_version": "8.1.3.320",
              "availability_zones": [
                  "cn-north-4c"
              ],
              "name": "dws1",
              "num_cn": 3,
              "db_name": "dbadmin",
              "db_password": "Passw0rd!",
              "public_ip": {
                  "public_bind_type": "auto_assign",
                  "eip_id": ""
              },
              "volume": {
                  "volume": "SSD",
                  "capacity": "100"
              }
          }
      }
      
    4. 单击右上角“Send”按钮发送请求。例如:“POST https://dws.ap-southeast-1.myhuaweicloud.com/v2/89cd04f168b84af6be287f71730fdb4b/clusters”,查看创建结果。
      {
        "cluster" : {
          "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
        }
      }

常见问题

  • DWS.5207 CN实例个数不合法

    根据最新版本,集群CN数量,取值范围为2~集群节点数,最大值为20,默认值为3。

  • DWS.5240 所选规格不存在

    v2接口flavor填写规格名称,请勿使用规格ID。

  • ECS.0319 创建集群失败,报错“The capacity of flavor am7.xlarge.8 is not sufficient.”。

    所选DWS规格在底层资源不足,请确认flavor字段并重新选择可用的DWS规格。