Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Adding CNs and DN Shards and Scaling Up Storage

Adding CNs and DN Shards and Scaling Up Storage

Updated on 2024-12-27 GMT+08:00

Function

This API is used to add CNs, add DN shards, and scale up storage. Before calling this API:

Constraints

  • Scaling up storage
    • The storage space must be a multiple of (Number of shards x 4 GB).
    • All nodes must be available.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

expand_cluster

No

Object

This parameter is mandatory when you add CNs or shards.

For details, see Table 3.

enlarge_volume

No

Object

New storage space after scaling up. This parameter is mandatory for scaling up storage.

For details, see Table 6.

is_auto_pay

No

String

Whether the order will be automatically paid after yearly/monthly instances are created. This parameter does not affect the payment mode of automatic renewal.

  • true: indicates that the order is automatically paid from the account.
  • false (default value): indicates that the order is manually paid from the account.
Table 3 expand_cluster field data structure description

Name

Mandatory

Type

Description

coordinators

No

Array of Coordinators objects

This parameter is mandatory for adding CNs. For details, see Table 4.

shard

No

Shard object

This parameter is mandatory for adding shards. For details, see Table 5.

Table 4 coordinators parameter description

Name

Mandatory

Type

Description

az_code

Yes

String

AZs to which CNs are to be added. If multiple CNs need to be added, enter the AZ where each CN is located.

For details about AZs in different regions, see Regions and Endpoints.

Table 5 shard parameter description

Name

Mandatory

Type

Description

count

Yes

Integer

Number of shards to be added.

Table 6 enlarge_volume field data structure description

Name

Mandatory

Type

Description

size

Yes

Integer

Storage space, which must always be a multiple of (Number of shards x 4 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 24 TB).

Response Parameters

Table 7 Response parameters

Name

Type

Description

job_id

String

Task ID. This parameter is returned when your instance is billed at a pay-per-use basis.

order_id

String

Order ID. This parameter is returned only when your instance is billed at a yearly/monthly basis.

Example Request

  • Adding a CN
    POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action
    {
        "expand_cluster": {
            "coordinators": [
                {
                    "az_code": "az_code"
                }
            ]
        }
    }
  • Adding multiple CNs
    POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action
    {
        "expand_cluster": {
            "coordinators": [
                {
                    "az_code": "az_code"
                },
                {
                    "az_code": "az_code"
                },
                {
                    "az_code": "az_code"
                }
            ]
        }
    }
  • Adding a DN shard
    POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action
    {
        "expand_cluster": {
            "shard": {
                "count": 1
            }
        }
    }
  • Scaling up storage to 400 GB
    POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action
    {
        "enlarge_volume": {
            "size": 400
        }
    }

Example Response

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback