ModifyDBInstanceName--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyDBInstanceName

最近更新时间：2024.07.18 22:55:09首次发布时间：2021.11.15 16:07:16

调用 ModifyDBInstanceName 接口修改目标 Redis 实例的实例名称。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
InstanceName	String	是	test123	修改后的实例新名称。名称需同时满足如下要求不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~128 个字符内。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

无。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceName&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
	"InstanceId": "redis-cn0212gzmh2xs****",
	"InstanceName": "test123"
}

返回示例

{
     "ResponseMetadata": {
          "RequestId": "202204151542510102120972070662****",
          "Action": "ModifyDBInstanceName",
          "Version": "2020-12-07",
          "Service": "Redis",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

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