ModifyDatabaseDescription--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

ModifyDatabaseDescription

最近更新时间：2025.02.11 10:33:03首次发布时间：2025.02.11 10:33:03

调用 ModifyDatabaseDescription 接口修改数据库的描述信息。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-r3xq0zdl****	实例名称。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
DBName	String	是	testdb1	数据库名称。
DBDesc		是	这是一段数据库的描述信息	数据库的描述信息，描述内容长度为 0~256 个字符。可以包含数字、中文、英文、下划线（_）和中划线（-）。说明若传入空字符串（即长度为 0），则表示清空原有描述。

返回参数

null

请求示例

POST /?Action=ModifyDatabaseDescription&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host：vedbm.volcengineapi.com
X-Date: 20241201T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
    "InstanceId": "vedbm-ca12cbqv****",
    "DBName": "testdb",
    "DBDesc": "修改数据库描述信息"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412102311440101940340380A4E7D37",
        "Action": "ModifyDatabaseDescription",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。