You need to enable JavaScript to run this app.
导航
获取自定义线路列表
最近更新时间:2023.12.06 10:39:31首次发布时间:2023.04.25 21:24:22

API 说明

API 名称:ListCustomLines
API 域名:open.volcengineapi.com
API 描述:获取云解析 DNS 的自定义线路列表。

请求方法

GET

调用限制

每秒最多调用 1 次。

请求参数

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

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

PageSize

Integer

查询参数

每页包含的线路的数量。

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

该参数的取值范围是 1 ~ 500。该参数的默认值是 10

PageNumberInteger查询参数页码。API 返回该页码所包含的线路。该参数的默认值是 1
LineString查询参数自定义线路的 ID。
NameCNString查询参数自定义线路的名称。
RemarkString查询参数自定义线路的备注。
IPSegmentString查询参数自定义线路的 CIDR 地址块。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
TotalCount
Integer
返回的自定义线路的总数。该参数值不受 PageNumber 参数的影响。假设您指定的 PageNumber 没有包含任何线路。此时CustomerLines 参数不会展示任何线路。但是 TotalCount 仍然会显示该 API 实际获取到的线路总数。
PageSize
Integer
每个分页所包含的线路的数量。
PageNumber
Integer
CustomerLines 展示的线路所在的页码。
IPSegmentCount
Integer
当前火山引擎账号添加的 CIDR 地址块的总数。
CustomerLines
Object Array
自定义线路列表。

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=ListCustomLines

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023041217295515273366212067046A34",
        "Action": "ListCustomLines",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "IPSegmentCount": 1,
        "CustomerLines": [
            {
                "Line": "custom-2811",
                "NameCN": "test",
                "Remark": "test",
                "IPSegments": [
                    "192.168.1.0/24"
                ],
                "CreatedAt": "2023-03-21T16:53:29+08:00",
                "UpdatedAt": "2023-04-03T19:30:20+08:00"
            }
        ]
    }
}