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

文档中心

立即注册

导航

ModifyDBInstancePrivateDNSVisibility

最近更新时间：2025.09.25 11:57:53首次发布时间：2025.09.25 11:57:53

调用 ModifyDBEndpointPrivateDNSVisibility 接口为目标 Redis 实例开启或关闭公网解析功能。

请求类型

异步请求。

注意事项

由于公网环境复杂，无法确保域名解析的准确性与时效性，因此该功能仅限用于非生产环境。如果是生产环境强烈建议采用 DNS Forward 方案，即在本地的 DNS 服务器中配置 Forward 到火山引擎 DNS，其中 100.96.0.2 和 100.96.0.3 为火山引擎使用的 DNS 服务器，以实现私网环境下的域名解析。更多详情，请参见开启或关闭公网解析。
开启公网解析时如出现连接地址前缀已存在的报错，需要先修改当前实例的私网连接地址后再开启公网解析。修改私网连接地址的方法，请参见修改连接地址。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyDBInstancePrivateDNSVisibility&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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-cnlfkmh6uiii8****",
    "PrivateDNSVisibility": "Public"
}

返回示例

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

错误码

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