查询 DNS 规则列表 ListDNSRule--云手机-火山引擎

文档中心

立即注册

导航

查询 DNS 规则列表 ListDNSRule

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

查询业务下已创建的自定义 DNS 解析规则详情列表。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
DNSName	String	否	`test-dns-name`	DNS 规则名称，支持中英文、数字、下划线、中划线，长度限制为 0~64 个字符。
Type	Integer	否	`0`	是否为默认 DNS： 0：非默认 DNS； 1：默认 DNS。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

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

参数	类型	示例值	描述
Row	Array of DetailDNSRuleResult	`-`	查询到的 DNS 规则信息列表，参看 DetailDNSRuleResult 数据结构说明。
Total	Long	`1`	查询结果总数。

DetailDNSRuleResult

参数	类型	示例值	描述
ProductId	String	`1749281594201xxxxxx`	业务 ID。
Dc	String	`tjtj-xxxxxx`	机房 ID。
Type	Integer	`0`	是否为默认 DNS 规则。
DNSId	String	`dns-7417778232776xxxxxx`	DNS 规则 ID。
IPList	Array of IPInfo	`-`	DNS 地址列表。
DNSName	String	`test-dns-name`	DNS 规则名称。
CreateAt	Long	`1727086125`	DNS 解析规则创建时间，Unix 时间戳，单位为秒。
UpdateAt	Long	`1727086125`	DNS 解析规则更新时间，Unix 时间戳，单位为秒。

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=ListDNSRule&Version=2023-10-30
{
    "ProductId": "1749281594201xxxxxx",
    "DNSName": "test-dns-name",
    "Type": 0,
    "Offset": 0,
    "Count": 10
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListDNSRule",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Row": [
            {
                "Dc": "tjtj-xxxxxx",
                "Type": 0,
                "DNSId": "dns-7417778232776xxxxxx",
                "IPList": [
                    {
                        "IP": "8.8.8.8",
                        "ISP": 1,
                        "Priority": 1
                    }
                ],
                "DNSName": "test-dns-name",
                "CreateAt": 1727086125,
                "UpdateAt": 1727086125,
                "ProductId": "1749281594201xxxxxx"
            }
        ],
        "Total": 1
    }
}

错误码

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