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

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListCustomLines-获取自定义线路列表

最近更新时间：2024.06.27 14:33:48首次发布时间：2023.04.25 21:24:22

获取自定义线路列表。

使用说明

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListCustomLines`	API 的名称。该参数的取值是 `ListCustomLines`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。
PageSize	Integer	否	`10`	每页包含的线路的数量。云解析 DNS 会将获取的线路进行分页显示。页数是由获取的线路总数和 `PageSize` 确定。该参数的取值范围是 1 ~ 500。该参数的默认值是 `10`。
PageNumber	Integer	否	`1`	页码。API 返回该页码所包含的线路。该参数的默认值是 `1`。
Line	String	否	`custom-2811`	自定义线路的 ID。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
NameCN	String	否	`test`	自定义线路的名称。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
Remark	String	否	`remark`	自定义线路的备注。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。
IPSegment	String	否	`192.168.1.0/24`	自定义线路的 CIDR 地址块。如果您不设置该参数，该 API 不会根据该参数筛选查询结果。

返回参数

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

错误码

您可访问公共错误码，获取详细信息。