Docs

Database Workshop

AutoOps

AutoScale

Call the AutoScale API to configure scaling rules.

Request type

Asynchronous request.

Request parameters

Parameter	Type	Is it required?	Sample	Description
InstanceType	String	Yes	Postgres	Database type. Currently, only Postgres is supported, which indicates RDS for PostgreSQL.
InstanceId	String	Yes	postgres-5d1******	Instance ID. tip You can call the DescribeDBInstances API to query the instance IDs of all RDS for PostgreSQL instances in the target region.
InstanceName	String	Yes	test	Instance name.
RegionId	String	Yes	cn-guangzhou	Region.
ObservationWindow	Integer	Yes	5	Observation window.
Configs	Array of RuleConfig	Yes	[ { "Action": "Expand", "IsOpen": true, "ScalingLimit": "3000", "Threshold": 48 } ]	Auto scaling rule list.
Metric	String	Yes	Disk	Scaling indicator. Currently, only disk scaling out is supported, meaning this parameter is set to Disk.

Response parameters

Null.

Request example

POST /?Action=AutoScale&Version=2018-01-01 HTTP/1.1​
Content-Type: application/json​
Host: dbw.cn-beijing.volcengineapi.com​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
​
{​
    "InstanceId": "postgres-5d1******",​
    "InstanceType": "Postgres",​
    "InstanceName": "test",​
    "RegionId": "cn-guangzhou",​
    "ObservationWindow": 5,​
    "Metric": "Disk",​
    "Configs": [​
        {​
            "Action": "Expand",​
            "IsOpen": true,​
            "ScalingLimit": "3000",​
            "Threshold": 48​
        }​
    ]​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20260825113937DAD8BD1919BA40DCD66D-c0d7bf",​
        "Action": "AutoScale",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-guangzhou"​
    },​
    "Result": {}​
}​

Error code

For details, refer to Error codes.

Last updated: 2026.09.07 11:28:40