更新 DNS 规则 UpdateDNSRule--云手机-火山引擎

文档中心

立即注册

导航

云手机

更新 DNS 规则 UpdateDNSRule

最近更新时间：2025.09.26 11:11:27首次发布时间：2024.10.14 16:33:38

更新或修改已创建的 DNS 解析规则。若使用该接口修改的 DNS 规则已关联某实例，则修改后的配置将在关联实例重启后生效。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateDNSRule&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateDNSRule`	接口名称。当前 API 的名称为 `UpdateDNSRule`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
DNSId	String	是	`dns-xxx`	DNS 规则 ID，可通过调用 ListDNSRule 接口获取。
DNSName	String	否	`test-dns-name`	DNS 规则名称，支持中英文、数字、下划线、中划线，长度限制为0~64个字符。
Type	Integer	否	`0`	DNS 规则类型： 0：非默认 DNS； 1：默认 DNS。同一个业务的单个 Dc 维度只支持一个默认的 DNS 策略。
IPList	Array of IPInfo	否	`[{"IP":"8.8.8.8","ISP":1,"Priority":1},{"IP":"114.114.114.114","ISP":2,"Priority":2}]`	DNS 地址列表，参看 IPInfo 数据结构说明。

IPInfo

参数类型是否必选示例值描述

IP String 是 8.8.8.8 IP 地址。

参数	类型	是否必选	示例值	描述
IP	String	是	`8.8.8.8`	IP 地址。
ISP	Integer	是	`1`	运营商： 1：移动； 2：联通； 4：电信； 8：BGP。
Priority	Integer	否	`1`	IP 地址的优先级。枚举值： 1：实例优先使用该 DNS IP 进行 DNS 解析。 2：当优先级为 1 的 DNS IP 解析失败后，采用该 DNS IP 进行 DNS 解析。

ISP

Integer

是

1

运营商：

1：移动；
2：联通；
4：电信；
8：BGP。

Priority

Integer

否

1

IP 地址的优先级。枚举值：

1：实例优先使用该 DNS IP 进行 DNS 解析。
2：当优先级为 1 的 DNS IP 解析失败后，采用该 DNS IP 进行 DNS 解析。

返回参数

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

请求示例

POST https://open.volcengineapi.com?Action=UpdateDNSRule&Version=2023-10-30
{
    "ProductId": "1749281594201xxxxxx",
    "DNSId": "dns-xxx",
    "DNSName": "test-dns-name",
    "Type": 0,
    "IPList": [
        {
            "IP": "8.8.8.8",
            "ISP": 1,
            "Priority": 1
        },
        {
            "IP": "114.114.114.114",
            "ISP": 2,
            "Priority": 2
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateDNSRule",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。