|
API Explorer
运营
应用中间件
软件开发生产线
网络
CDN与智能边缘
计算
安全和合规
数据库
人工智能
大数据
容器
迁移
管理与监管
企业应用
存储
开发者工具
视频
IoT物联网
运营
应用中间件
软件开发生产线
网络
CDN与智能边缘
计算
安全和合规
数据库
人工智能
大数据
容器
迁移
管理与监管
企业应用
存储
开发者工具
视频
IoT物联网
My Favorites

You are not logged in.

My Collections
More
English
文档数据库服务
| Details
  • 查询API版本
    • ListApiVersion
    • ShowApiVersion
  • 引擎版本和规格
    • ListDatastoreVersions
    • ListFlavorInfos
    • ListFlavors
    • ListStorageType
  • 实例管理
    • AddReadonlyNode
    • AddShardingNode
    • AttachEip
    • AttachInternalIp
    • BatchUpgradeDatabaseVersion
    • CancelEip
    • ChangeOpsWindow
    • CheckWeakPassword
    • CreateInstance
    • CreateIp
    • DeleteInstance
    • DeleteLtsConfig
    • DeleteReadonlyNode
    • ExpandReplicasetNode
    • ListAz2Migrate
    • ListInstances
    • ListLtsConfigs
    • ListRecycleInstances
    • ListSslCertDownloadAddress
    • MigrateAz
    • ResizeInstance
    • ResizeInstanceVolume
    • RestartInstance
    • SetAutoEnlargePolicies
    • SetRecyclePolicy
    • ShowAutoEnlargePolicy
    • ShowClientNetwork
    • ShowDiskUsage
    • ShowRecyclePolicy
    • ShowReplSetName
    • ShowSecondLevelMonitoringStatus
    • ShowUpgradeDuration
    • ShrinkInstanceNodes
    • SwitchoverReplicaSet
    • SwitchSecondLevelMonitoring
    • SwitchSsl
    • UpdateClientNetwork
    • UpdateInstanceName
    • UpdateInstancePort
    • UpdateInstanceRemark
    • UpdateLtsConfig
    • UpdateReplSetName
    • UpdateSecurityGroup
    • UpgradeDatabaseVersion
  • 连接管理
    • DeleteSession
    • ListSessions
    • ShowConnectionStatistics
  • 备份与恢复
    • BatchDeleteBackup
    • CreateManualBackup
    • DeleteManualBackup
    • ListBackups
    • ListRestoreCollections
    • ListRestoreDatabases
    • ListRestoreTimes
    • RestoreInstance
    • RestoreInstanceFromCollection
    • RestoreNewInstance
    • SetBackupPolicy
    • ShowBackupDownloadLink
    • ShowBackupPolicy
    • StopBackup
  • 获取日志信息
    • DeleteAuditLog
    • DownloadErrorlog
    • DownloadSlowlog
    • ListAuditlogLinks
    • ListAuditlogs
    • ListErrorLogs
    • ListLtsErrorLogs
    • ListLtsSlowLogs
    • ListSlowLogs
    • SetAuditlogPolicy
    • ShowAuditlogPolicy
    • ShowSlowlogDesensitizationSwitch
    • SwitchSlowlogDesensitization
  • 标签管理
    • BatchTagAction
    • ListInstancesByTags
    • ListInstanceTags
    • ListProjectTags
  • 管理数据库和用户
    • CheckPassword
    • CreateDatabaseRole
    • CreateDatabaseUser
    • DeleteDatabaseRole
    • DeleteDatabaseUser
    • ListDatabaseRoles
    • ListDatabases
    • ListDatabaseUsers
    • ResetPassword
    • SetBalancerSwitch
    • SetBalancerWindow
    • ShowShardingBalancer
  • 参数配置
    • CompareConfiguration
    • CopyConfiguration
    • CreateConfiguration
    • DeleteConfiguration
    • ListAppliedInstances
    • ListConfigurations
    • ResetConfiguration
    • ShowConfigurationAppliedHistory
    • ShowConfigurationModifyHistory
    • ShowConfigurationParameter
    • ShowEntityConfiguration
    • ShowInstanceConfigurationModifyHistory
    • SwitchConfiguration
    • UpdateConfigurationParameter
    • UpdateEntityConfiguration
    • ValidateConfigurationName
  • 配额管理
    • ShowQuotas
  • 任务管理
    • ListTasks
    • ShowJobDetail
  • 数据库运维
    • CreateKillOpRule
    • DeleteKillOpRuleList
    • ShowKillOpRuleRuleList
    • SwitchInstancePrimary
    • UpdateKillOpRule
  • 定时任务
    • CancelScheduledTask
    • ListScheduledTasks

ResizeInstanceVolume

POST
https://dds.af-south-1.myhuaweicloud.com/v3/{project_id}/instances/{instance_id}/enlarge-volume
Advanced
Required parameters only
Default
Encrypt sensitive parameters
*
Region
Headers
*
Authorization
Parameters
*
project_id
*
instance_id
Body
*{
*
volume
: {
*
group_id
:
*
size
:
*
node_ids
: [
+Add
*]
*}
*
is_auto_pay
:
}
API Description

This API is used to scale up the storage space of a DB instance.

Constraints
  • This API supports only pay-per-use Community Edition DB instances.
URL
POST  https://dds.af-south-1.myhuaweicloud.com/v3/{project_id}/instances/{instance_id}/enlarge-volume
Request Parameters
NameTypeINMandatoryDescription
x-auth-token
stringheader Yes

Specifies the user token obtained from the IAM service.

instance_id
stringpath Yes

Specifies the instance ID, which can be obtained by calling the API for querying instances and details. If you do not have an instance, you can call the API used for creating an instance.

project_id
stringpath Yes

Specifies the project ID of a tenant in a region.

Body Parameters
NameTypeMandatoryDescription
volume
ResizeInstanceVolumeOption object Yes

Specifies detailed information about the volume request.

is_auto_pay
boolean No

扩容包年包月实例的存储容量时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。

  • true,表示自动从账户中支付。
  • false,表示手动从账户中支付,默认为该方式。
Parameter:
volume
NameTypeMandatoryDescription
group_id
string No

Specifies the group ID.

  • For a cluster instance, this parameter is set to the ID of the shard group.
  • This parameter is not transferred for replica set and single node instances.
size
string Yes

Specifies the requested disk capacity. The value must be an integer multiple of 10 and greater than the current storage space.

  • In a cluster instance, this parameter indicates the storage space of shard nodes. The value range is from 10 GB to 2000 GB.
  • In a replica set instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 3000 GB.
  • In a single node instance, this parameter indicates the disk capacity of the DB instance to be expanded. The value range is from 10 GB to 1000 GB.
node_ids
Array of strings No

This parameter is required when the disk capacity of the read replica of a replica set instance is expanded. Only one element can be transferred in the list.

Response Parameters
Status code: 200

Success.

NameTypeDescription
job_id
string

Indicates the task ID.

order_id
string

订单ID,仅扩容包年包月实例的存储容量时返回该参数。

Status code: default

Client or server error.

NameTypeDescription
error_code
string

Specifies the error returned when a task submission exception occurs.

error_msg
string

Specifies the description of the error returned when a task submission exception occurs.

Example Request
Example 1

Clusters:

"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume"
{
    "volume": {
        "group_id": "1b0c008adbcb495c81a3d5762a02a2abgr02",
        "size": 20
    }
}
Example 2

Replica sets:

"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume"
{
    "volume": {
        "size": 20
    }
}
Example 3

Single nodes:

"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume"
{
    "volume": {
        "size": 20
    }
}
Example 4

The read replica of a replica set:

"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein02/enlarge-volume"
{
    "volume": {
        "size": 20,
        "node_ids": [
            "8f643d252d834a4c916b2db4322f9955no02"
        ]
    }
}
Example Response
Status code: 200

Success.

Example 1
{
  "job_id": "04efe8e2-9255-44ae-a98b-d87cae411890"
}
SDK
Click 文档数据库服务 (DDS) SDK to download the SDK in your programming language or view the SDK documentation. To learn how to install an SDK and perform authentication, read Usage.
Error Code

Outline

API Description
Constraints
URL
Request Parameters
Response Parameters
Example Request
Example Response
SDK
Error Code