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

文档中心

立即注册

导航

ModifyDBInstanceVpcAuthMode

最近更新时间：2024.09.13 11:12:18首次发布时间：2022.03.01 10:49:22

调用 ModifyDBInstanceVpcAuthMode 接口开启或关闭目标 Redis 实例的免密访问功能。

请求类型

同步请求。

注意事项

Redis 实例创建成功后，免密访问功能默认关闭。更多详情，请参见免密访问。
开启免密访问后，若不输入账号，默认使用 default 账号，此时无需输入密码即可访问 Redis 实例。
开启免密访问后，同时也兼容账密验证的方式连接 Redis 实例，您仍然可以通过账号和密码来连接 Redis 实例。
为保障数据库安全，无论免密功能是否开启，使用任何账号通过公网地址连接 Redis 实例时，都需验证账密信息。
出于数据安全考虑，不允许在开启实例免密访问功能的同时，将地址 0.0.0.0/0 加入实例的白名单中。如需开启免密访问，请先将地址 0.0.0.0/0 从实例白名单中移除。白名单修改方法，请参见 ModifyAllowList。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
VpcAuthMode	String	是	open	开启或关闭免密访问功能。取值范围如下： `open`：开启免密访问。 `close`：关闭免密访问。说明参数取值不区分大小写。关于免密访问的更多信息，请参见免密访问。
ClientToken	String	否	WbiAlPqJM6tMoSOYhT****	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感且不超过 127 个 ASCII 字符。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyDBInstanceVpcAuthMode&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****",
	"VpcAuthMode": "open"
}

返回示例

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

错误码

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