What's New
Function Overview
Product Bulletin
- Product Notice
- Version Support Notes
Service Overview
- GaussDB(DWS) Infographics
- What Is GaussDB(DWS)?
- Data Warehouse Types
- Data Warehouse Flavors
- Advantages
- Application Scenarios
- Functions
- Concepts
- Related Services
- Security
- GaussDB(DWS) Permissions Management
- GaussDB(DWS) Access
- Restrictions
- Technical Support
- Service Quotas
- GaussDB(DWS) Technical Specifications
Billing
- GaussDB(DWS) Billing Overview
- Billing Modes
- Item
- Billing Examples
- Billing Mode Change
- Renewal
  - Overview
  - Manual Renewal
- Bills
- Arrears
- Stopping Billing
- Cost Management
- Billing FAQs
Getting Started
- Checkpoint Vehicle Analysis
- Supply Chain Requirement Analysis of a Company
- Operations Status Analysis of a Retail Department Store
- Creating a Time Series Table
- Best Practices of Hot and Cold Data Management
- Best Practices for Automatic Partition Management
- Creating a Cluster and Connecting to It
- Using CDM to Migrate MySQL Data to the GaussDB(DWS) Cluster
- Using DLI Flink Jobs to Write Kafka Data to GaussDB(DWS) in Real Time
- Basic SQL Operations
- Database Quick Start
- Getting Started with Common Practices
User Guide
- Using GaussDB(DWS)
- Preparations
- Creating a GaussDB(DWS) Cluster
- Connecting to a GaussDB(DWS) Cluster
- Creating a GaussDB(DWS) Database and User
- Migrating Service Data to a GaussDB(DWS) Cluster
  - Migrating Data to a GaussDB(DWS) Cluster Using GDS-Kafka
  - Data Source Management
- GaussDB(DWS) Cluster Data Security and Encryption
- GaussDB(DWS) Cluster Management
- GaussDB(DWS) Cluster O&M
Best Practices
- Import and Export
- Data Migration
- Data Analytics
- Decoupled Storage and Compute
  - DWS 3.0 Decoupled Storage and Compute Usage Suggestions and Performance Optimization
- Data Development
- Database Management
- Performance Tuning
  - Optimizing Table Structure Design to Enhance GaussDB(DWS) Query Performance
  - Analyzing SQL Statements That Are Being Executed to Handle GaussDB(DWS) Performance Issues
- Cluster Management
  - Binding Different Resource Pools to Two Types of Jobs to Balance Load for GaussDB(DWS)
  - Scaling Options for GaussDB(DWS) with a Coupled Storage-Compute Architecture
Data Migration and Synchronization
- Data Migration to GaussDB(DWS)
- Importing Data
- Full Database Migration
  - Using CDM to Migrate Data to GaussDB(DWS)
  - Using DSC to Migrate SQL Scripts
- Real-time Import
  - Using DRS to Import Data to GaussDB(DWS)
  - Real-time Data Import From Kafka GaussDB(DWS)
- Metadata Migration
  - Using gs_dump and gs_dumpall to Export Metadata
  - Using gs_restore to Import Data
- Exporting Data
- Other Operations
Developer Guide
- Standard Data Warehouse (9.1.0.x)
- Standard data warehouse (8.1.3.x)
- Hybrid Data Warehouse (9.1.0.x）
- Hybrid Data Warehouse (8.1.3.x）
- Historical Versions
SQL Syntax Reference
- SQL Syntax Reference (9.1.0.x)
- SQL Syntax Reference (8.1.3.x)
- Historical Versions
Performance Tuning
- Overview of Query Performance Optimization
- Query Execution Process
- SQL Execution Plan
- SQL Optimization Guide
- Optimization Cases
- SQL Execution Troubleshooting
- query_band Load Identification
- Common Performance Parameter Optimization Design
Tool Guide
- Overview
- Downloading Related Tools
- gsql
- Data Studio
- GDS
- DSC
- DataCheck
- DWS-Connector
- Server Tool
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- API Description
- Application Cases
  - Using Postman to Call the API for Creating a Cluster
  - Using Postman to Call the API for Creating a Snapshot
- Introduction
- Appendix
SDK Reference
- SDK Overview
FAQs
- Top FAQs
- Product Consulting
- Database Connections
- Data Migration
- Database Usage
- Cluster Management
- Account Permissions
- Database Performance
- Backup and Restoration
  1. Why Does It Take a Long Time to Create an Automated Snapshot in GaussDB(DWS)?
  2. Does a GaussDB(DWS) Snapshot Have the Same Function as an EVS Snapshot?
Troubleshooting
- Database Connections
- JDBC/ODBC
- Data Import and Export
- Database Parameter Modification
- Account/Permission/Password
- Cluster Performance
- Cluster Exceptions
  - The Disk Usage Alarm Is Frequently Generated
- Database Use
Videos
Performance White Paper
- Overview
- Test Result
  - TPC-H Single Query Test
  - TPC-DS Single Query Test
- Test Methods
- Appendixes
  - TPC-H Test Sets
  - TPC-DS Test Sets
Technical White Paper
- GaussDB(DWS)
- Platforms and Technical Specifications Supported by GaussDB(DWS)
  - Technical Specifications
- GaussDB(DWS) Core Technologies
- GaussDB(DWS) Tools
  - Client Tools
  - Database Monitoring Tool
- External APIs
Error Code Reference
- 8.2.0 and earlier versions
  - Management Console Error Code
  - Data Warehouse Service Error Codes
- 8.2.1 or later versions
Glossary
More Documents
- User Guide
- API Reference (ME-Abu Dhabi Region)
- Developer Guide (ME-Abu Dhabi Region)
- SQL Syntax Reference (ME-Abu Dhabi Region)
- Tool Guide (ME-Abu Dhabi Region)
- Error Code Reference (ME-Abu Dhabi Region)
  - Management Console Error Code
- User Guide (Paris Region)
- API Reference (Paris Region)
- Developer Guide (Paris Region)
- SQL Syntax Reference (Paris Region)
- Tool Guide (Paris Region)
- Error Code Reference (Paris Region)
  - Management Console Error Code
- User Guide (Kuala Lumpur Region)
- API Reference (Kuala Lumpur Region)
- Developer Guide (Kuala Lumpur Region)
- SQL Syntax Reference (Kuala Lumpur Region)
- Tool Guide (Kuala Lumpur Region)
- Error Code Reference (Kuala Lumpur Region)
  - Management Console Error Code
General Reference
- Glossary
- Service Level Agreement
- White Papers
- Endpoints
- Permissions

On this page

Show all

Help Center/ GaussDB(DWS)/ API Reference/ Application Cases/ Using Postman to Call the API for Creating a Cluster

Using Postman to Call the API for Creating a Cluster

Updated on 2024-04-18 GMT+08:00

View PDF

Scenario

Use Postman to create a GaussDB(DWS) cluster. This API is an asynchronous API. It takes 10 to 15 minutes to create a cluster. For details, see Calling APIs.

Preparations

You have registered a Huawei Cloud account and enabled Huawei Cloud services.
You have obtained the endpoint addresses of GaussDB(DWS) in the region you choose. For details, see Regions and Endpoints.
You have obtained the username, password, account name, and project ID of your Huawei Cloud account. In the upper right corner of the Huawei Cloud management console, choose My Credentials > API Credential. The username, account name, user password, and region project ID is displayed in the Projects area. For details about how to obtain the project ID, see Obtaining a Project ID.
You have created a VPC and obtained the VPC and subnet IDs. For details, see Virtual Private Cloud (VPC).

Procedure

Configure the environment.

NOTE:

Download Postman (7.24.0 is recommended) and call the snapshot creation service.
Obtain the token for authentication.
1. Create a POST request on Postman, select the Body tab, and enter the username, password, account name, and project ID.
  
  NOTE:
  
  The region where the Huawei Cloud service for obtaining the token is located must be the same as the region where the called service is located. Otherwise, the calling fails.
2. Click Send in the upper right corner to send POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens. Obtain the value of Headers->X-Subject-Token in the command output. (The validity period of the token is 24 hours.)

Call the API for creating a cluster.

Create a POST request on Postman, select Headers, add the corresponding KEY and VALUE, and copy the token value to X-Auth-Token.
Call the API. This service provides two APIs for creating a cluster. The region of the request URL must be the same as that of the invoked service. project_id indicates the project ID (mandatory). For details about how to obtain the project ID, see Preparations.
- v1 API:
```
POST https://{Endpoint}/v1.0/{project_id}/clusters
```
- v2 API:
```
POST https://{Endpoint}/v2/{project_id}/clusters
```
NOTE:

The v2 API is recommended.

Click Body and add the request parameter values to the request. Parameters vary by services. For details, see the API Description.

         
          
            
            {
    "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"
        }
    }
}

           

         
        

Click Send in the upper right corner to send the request. For example, enter "POST https://dws.ap-southeast-1.myhuaweicloud.com/v2/89cd04f168b84af6be287f71730fdb4b/clusters" to view the creation result.
```
{
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
  }
}
```

FAQs

DWS.5207 Invalid CN instance quantity.
In the latest version, the number of CNs in the cluster ranges from 2 to the number of cluster nodes. The maximum value is 20 and the default value is 3.
DWS.5240 The selected flavor does not exist.
If you use the v2 API, enter the flavor name but not the flavor ID.
ECS.0319 Failed to create a cluster, and the error message "The capacity of flavor am7.xlarge.8 is not sufficient." is displayed.
The underlying resources for the selected flavor are insufficient. Check the flavor field and select an available flavor.

Parent Topic: Application Cases

Previous topic: Application Cases

Next topic: Using Postman to Call the API for Creating a Snapshot

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot