ListCustomLines - 获取自定义线路列表--TrafficRoute DNS 套件-火山引擎

文档中心

TrafficRoute DNS 套件

自定义线路管理

ListCustomLines - 获取自定义线路列表

获取自定义线路列表。

使用说明

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

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=ListCustomLines&Version=2022-06-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListCustomLines	要执行的操作，取值：ListCustomLines。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
SearchMode	String	否	like	搜索模式。作用于`Line`、`NameCN`、`Remark`、`IPSegment`。支持的取值： like（默认）：模糊查询。 exact：精确查询。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的线路。该参数的默认值是 `1`。
PageSize	Integer	否	10	每页包含的线路的数量。私网解析 PrivateZone 会将获取的线路进行分页显示。页数是由获取的线路总数和 PageSize 确定。该参数的取值范围是 1 ~ 500。该参数的默认值是 10。
Line	String	否	custom-2811	自定义线路的 ID。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。匹配方式由 `SearchMode` 决定。
NameCN	String	否	test	自定义线路的名称。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。匹配方式由 `SearchMode` 决定。
Remark	String	否	remark	自定义线路的备注。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。匹配方式由 `SearchMode` 决定。
IPSegment	String	否	192.168.1.0/24	自定义线路的 CIDR 地址块。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。匹配方式由 `SearchMode` 决定。

返回参数

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

参数	类型	示例值	描述
CustomerLines	Array of Object	见返回示例	自定义线路列表。当无符合条件的记录时，返回空数组。
IPSegmentCount	Integer	1	当前火山引擎账号添加的 CIDR 地址块的总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前每页所包含的线路的数量。
TotalCount	Integer	1	返回的自定义线路的总数。该参数值不受 `PageNumber` 参数的影响。假设您指定的 `PageNumber` 没有包含任何线路。此时`CustomerLines` 参数不会展示任何线路。但是 `TotalCount` 仍然会显示该 API 实际获取到的线路总数。

请求示例

GET /?Action=ListCustomLines&Version=2022-06-01&SearchMode=like&PageNumber=1&PageSize=10&Line=custom-2811&NameCN=test&Remark=remark&IPSegment=192.168.1.0/24 HTTP/1.1
Host: private-zone.volcengineapi.com
X-Date: 20260603T062024Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260603/cn-beijing/private_zone/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2026060314204108401416924031D094",
    "Action": "ListCustomLines",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-beijing"
  },
  "Result": {
    "CustomerLines": [
      {
        "Line": "custom-2811",
        "NameCN": "test",
        "Remark": "test",
        "IPSegments": [
          "192.168.1.0/24"
        ],
        "CreatedAt": "2023-03-21T16:53:29+08:00",
        "UpdatedAt": "2023-03-21T16:53:29+08:00"
      }
    ],
    "IPSegmentCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败
400	ErrPageSizeNotValid	page size must be less than 500 when search	分页查找的记录数量不能大于500。
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
500	ErrInternalServer	server internal error	服务内部错误

最近更新时间：2026.06.03 18:08:37

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #