云解析服务 DNS云解析服务 DNS

更新时间:2021/06/16 GMT+08:00
分享

查询自定义线路

功能介绍

查询自定义线路。

URI

GET /v2.1/customlines?line_id={line_id}&name={name}&limit={limit}&offset={offset}&show_detail={show_detail}

参数说明请参见表1
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

line_id

String

解析线路ID。

支持模糊匹配。

name

String

解析线路名称。

支持模糊匹配。

limit

Integer

每页返回的资源个数。

  • 当查询详细信息时,取值范围为0~100。

    取值一般为10、20、50。默认为100。

  • 当查询概要信息时,取值范围为0~3000。

    默认为3000。

offset

Integer

分页查询起始偏移量,表示从偏移量的下一个资源开始查询。

取值范围:0~2147483647

起始值为0。

show_detail

Boolean

是否查询详细信息。

取值范围:

  • true:是,查询详细信息。
  • false:否,不查询详细信息。

默认为true。

请求

  • 请求参数

  • 请求样例

    查询解析线路ID为“custom_2ce45ef669fc87870169fcbada7a0007”的自定义线路。

    GET https://{DNS_Endpoint}/v2.1/customlines?line_id=custom_2ce45ef669fc87870169fcbada7a0007

响应

  • 参数说明
    表2 响应样例的要素说明

    名称

    参数类型

    说明

    lines

    Array of object

    列表对象。详细内容请参见表3

    metadata

    Object

    返回满足过滤条件的资源总数。详细内容请参见表4

    表3 lines字段说明

    名称

    参数类型

    说明

    line_id

    String

    解析线路ID。

    name

    String

    解析线路名称。

    ip_segments

    Array of strings

    IP地址段。

    created_at

    String

    创建时间。

    采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

    updated_at

    String

    更新时间。

    采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

    status

    String

    资源状态。

    详细内容请参见枚举类型

    description

    String

    自定义线路的描述信息。

    表4 metadata参数说明

    名称

    参数类型

    说明

    total_count

    Integer

    满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

  • 响应样例
    当查询详细信息时(show_detail=true):
    {
        "lines": [
           {
              "line_id": "custom_2ce45ef669fc87870169fcbada7a0007",
              "name": "customline",
              "ip_segments": [
                  "1.1.1.1-1.1.1.1",
                  "1.1.1.2-1.1.1.3"
              ],
              "status": "ACTIVE",
              "created_at": "2019-04-10T10:03:17.827",
              "updated_at": "2019-04-10T10:03:57.207",
              "description": "1234"
           }
        ],
        "metadata": {
            "total_count": 1
        }
    }
    当查询概要信息时(show_detail=false):
    {
        "lines": [
           {  
              "line_id": "custom_2ce45ef669fc87870169fcbada7a0007",
              "name": "customline"
           }
        ],
        "metadata": {
            "total_count": 1
        }
    }

返回值

接口正常的返回值为2xx,例如200、202或者204。

返回值含义以及更多返回值请参考状态码

分享:

    相关文档

    相关产品