You need to enable JavaScript to run this app.
云手机

云手机

请输入
  • 文档首页
    • 云手机服务端 OpenAPI 文档网络配置与管理DNS 管理创建 DNS 规则 CreateDNSRule
复制全文
我的收藏
DNS 管理
创建 DNS 规则 CreateDNSRule
复制全文
我的收藏
创建 DNS 规则 CreateDNSRule

为同一机房（Dc）内的云手机实例创建自定义 DNS 解析规则。您可以通过定制 DNS 解析行为，将指定域名定向到特定的 IP 地址。
该接口适用于需要优化网络性能、增强数据可控性的场景，如加速内部网络中的文件下载，或对网络流量进行精确控制和分发。
使用本接口可将云手机的 DNS 请求指向自己的服务器进行处理，为特定域名的解析结果进行定制，或为云手机实例设置默认 DNS 服务器，从而满足特定的业务需求。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=CreateDNSRule&Version=2025-05-01

请求参数

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

Query

参数

类型

是否必选

示例值

描述

Action

String

是

CreateDNSRule

接口名称。当前 API 的名称为 CreateDNSRule。

Version

String

是

2025-05-01

接口版本。当前 API 的版本为 2025-05-01。

Body

参数

类型

是否必选

示例值

描述

ProductId

String

是

1749281594201xxxxxx

业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。

Dc

String

是

tjtj-xxxxxx

机房 ID, 可通过 ListDc 接口获取。

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}

DNS 地址列表，参看 IPInfo 数据结构说明。

IPInfo

参数

类型

是否必选

示例值

描述

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 解析。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数

类型

示例值

描述

ProductId

String

1749281594201xxxxxx

业务 ID。

DNSId

String

dns-7417778232776xxxxxx

DNS 规则 ID。

DNSName

String

test-dns-name

DNS 规则名称。

Dc

String

tjtj-xxxxxx

机房 ID。

Type

Integer

0

是否为默认 DNS 规则。

IPList

Array of IPInfo

IP 列表。

CreateAt

Long

1727086080

DNS 解析规则创建时间，Unix 时间戳，单位为秒。

IPInfo

参数

类型

示例值

描述

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 解析。

请求示例 

POST https://open.volcengineapi.com?Action=CreateDNSRule&Version=2025-05-01
{
    "ProductId": "1749281594201xxxxxx",
    "Dc": "tjtj-xxxxxx",
    "DNSName": "test-dns-name",
    "Type": 0,
    "IPList": [
        {
            "IP": "8.8.8.8",
            "ISP": 1,
            "Priority": 1
        }
    ]
}

返回示例 

{
    "ResponseMetadata": {
        "Action": "CreateDNSRule",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "ProductId": "1749281594201xxxxxx",
        "DNSId": "dns-7417778232776xxxxxx",
        "DNSName": "test-dns-name",
        "Dc": "tjtj-xxxxxx",
        "Type": 0,
        "IPList": [
            {
                "IP": "8.8.8.8",
                "ISP": 1,
                "Priority": 1
            }
        ],
        "CreateAt": 1727086080
    }
}

错误码

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

最近更新时间：2026.01.28 16:48:46
这个页面对您有帮助吗？
有用
有用
无用
无用