ListLines - 获取线路列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

ListLines - 获取线路列表

最近更新时间：2025.03.10 14:04:24首次发布时间：2022.11.24 20:57:30

获取云解析 DNS 提供的线路列表。

使用说明

请求频率：每秒最多调用 50 次。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListLines&Version=2018-08-01

调试

API Explorer

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

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	ListLines	要执行的操作，取值：ListLines。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
Hierarchy	String	否	true	是否按层级返回线路。该参数有以下取值： `true`：按层级返回线路。在结果中会显示父线路以及子线路。 `false`（默认）：不按层级返回线路。父线路和子线路都在同一个层级返回。
ZID	Long	否	1234	表示一个域名的 ID。根据您设置的域名所在的实例版本，云解析 DNS 返回该版本可用的线路。如果您不设置该参数，云解析 DNS 默认返回所有的线路。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的线路。该参数的默认值是 1。
PageSize	Integer	否	2000	每页包含的线路的数量。系统会将获取的线路进行分页显示。页数是由获取的线路总数和 `PageSize` 确定。该参数的取值范围是 1-2000。该参数的默认值是 `2000`。

返回参数

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

参数	类型	示例值	描述
Lines	Array of Object	无	线路列表。
PageNumber	Integer	1	`Lines` 展示的线路所在的页码。
PageSize	Integer	10	每个分页所包含的线路的数量。
TotalCount	Integer	564	返回的线路的总数。该参数值不受 `PageNumber` 参数的影响。假设您指定的 `PageNumber` 没有包含任何线路。此时`Lines` 参数不会展示任何线路。但是 `TotalCount` 仍然会显示该 API 实际获取到的线路总数。

请求示例

GET /?Action=ListLines&Version=2018-08-01&PageNumber=7&PageSize=10 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240908T115044Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230413201148F0DE3A41DD2EE858F888",
        "Action": "ListLines",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 564,
        "PageNumber": 1,
        "PageSize": 10,
        "Lines": [
            {
                "ID": "2432",
                "Name": "全球",
                "Value": "oversea",
                "Type": 3,
                "PartName": "全球",
                "Level": 1
            },
            {
                "ID": "2001",
                "Name": "中国内地",
                "Value": "domestic",
                "Type": 3,
                "PartName": "中国内地",
                "Level": 1
            },
            {
                "ID": "2568",
                "Name": "中国_科技网_辽宁",
                "Value": "cn_science_liaoning",
                "Type": 2,
                "PartName": "辽宁",
                "Level": 5
            },
            {
                "ID": "2567",
                "Name": "中国_科技网_黑龙江",
                "Value": "cn_science_heilongjiang",
                "Type": 2,
                "PartName": "黑龙江",
                "Level": 5
            },
            {
                "ID": "2559",
                "Name": "中国_科技网_青海",
                "Value": "cn_science_qinghai",
                "Type": 2,
                "PartName": "青海",
                "Level": 5
            },
            {
                "ID": "2558",
                "Name": "中国_科技网_甘肃",
                "Value": "cn_science_gansu",
                "Type": 2,
                "PartName": "甘肃",
                "Level": 5
            },
            {
                "ID": "2557",
                "Name": "中国_科技网_陕西",
                "Value": "cn_science_shaanxi",
                "Type": 2,
                "PartName": "陕西",
                "Level": 5
            },
            {
                "ID": "2556",
                "Name": "中国_科技网_西藏",
                "Value": "cn_science_xizang",
                "Type": 2,
                "PartName": "西藏",
                "Level": 5
            },
            {
                "ID": "2554",
                "Name": "中国_科技网_贵州",
                "Value": "cn_science_guizhou",
                "Type": 2,
                "PartName": "贵州",
                "Level": 5
            },
            {
                "ID": "2552",
                "Name": "中国_科技网_重庆",
                "Value": "cn_science_chongqing",
                "Type": 2,
                "PartName": "重庆",
                "Level": 5
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrDBNotFound	record not found :%s	数据库条目未找到。
500	ErrInternalServer	server internal error	服务内部错误。