tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

UpdateDatabase

Last updated: 2024-09-14 11:01:29

1. API Description

Domain name for API request: cdwdoris.tencentcloudapi.com.

This API is used to modify the attributes of a specified database, including setting the data volume quota, renaming the database, setting the replica quantity quota, and modifying other attributes of the database.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: UpdateDatabase.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
DbName Yes String The database name to be modified
Operation Yes String Modify the operation type, such as SET_QUOTA, RENAME, SET_REPLICA_QUOTA, and SET_PROPERTIES. Modify the operation type, such as SET_QUOTA, RENAME, SET_REPLICA_QUOTA, and SET_PROPERTIES.
InstanceId Yes String InstanceId
Quota No String Quota value, which is used to set the quota of data volume or replicas.
NewDbName No String New database name, used for renaming operation.
Properties.N No Array of PropertiesMap Attribute key-value pair to be set
UserName No String Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
PassWord No String Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in.
CatalogName No String The name of the catalog, if left unspecified, defaults to "internal".

3. Output Parameters

Parameter Name Type Description
Success Boolean Whether the operation is successful
Message String Message description of the operation result
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Updating

Input Example

POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateDatabase
<Common request parameters>

{
      "InstanceId": "cdwdoris-7da9fumk",
    "DbName": "demo1",
    "Operation": "SET_QUOTA",
    "Quota": "10T",
   "CatalogName": "internal"

}

Output Example

{
    "Response": {
        "Success": true,
        "Message": "Database quota set successfully.",
        "RequestId": "xxxx-xxxx-xxxx-xxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy