You need to enable JavaScript to run this app.
导航
获取线路列表
最近更新时间:2024.01.11 17:12:59首次发布时间:2022.11.24 20:57:30

API 说明

API 名称:ListLines
API 域名:open.volcengineapi.com
API 描述:获取云解析 DNS 提供的运营商线路和地理位置线路列表。

请求方法

GET

调用限制

每秒最多调用 50 次。

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 ListLines
VersionString查询参数API 的版本。该参数的取值是 2018-08-01

PageSize

Integer

查询参数

每页包含的线路的数量。

系统会将获取的线路进行分页显示。页数是由获取的线路总数和 PageSize 确定。

该参数的取值范围是 1-2000。该参数的默认值是 2000

PageNumberInteger查询参数页码。API 返回该页码所包含的线路。该参数的默认值是 1

Hierarchy

String

查询参数

是否按层级返回线路。该参数有以下取值:

  • true:按层级返回线路。在结果中会显示父线路以及子线路。

  • false:不按层级返回线路。父线路和子线路都在同一个层级返回。

该参数的默认值是 false

ZID

Integer

查询参数

表示一个域名的 ID。该参数有以下说明:

  • 如果您指定了该参数,根据您指定的域名所在的实例版本,云解析 DNS 返回该版本可用的线路。

  • 如果您不指定该参数,云解析 DNS 返回返回所有的的线路。

响应正文

ResponseMetadata 对象

参数名称
数据类型
参数说明
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在区域。

Result 对象

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

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=ListLines&PageNumber=7&PageSize=10&Hierarchy=true

响应示例

{
    "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
            }
        ]
    }
}