> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/zec/byo-asn/describebyoasns.md).

# DescribeByoAsns

## 1. 接口描述

本接口(DescribeByoAsns)用于查询一个或多个自带ASN的详细信息。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称            | 必选 | 类型                                                                      | 描述                                       |
| --------------- | -- | ----------------------------------------------------------------------- | ---------------------------------------- |
| byoAsnIds       | 否  | Array of String                                                         | <p>BYO ASN的ID列表。</p><p>最多支持100个ID查询。</p> |
| asn             | 否  | Integer                                                                 | 根据ASN号进行精确过滤。                            |
| status          | 否  | [ByoAsnStatus](/api-reference/cn/zec/datastructure.md#byoasnstatus)     | 根据状态进行过滤。                                |
| resourceGroupId | 否  | String                                                                  | 根据资源组ID进行过滤。                             |
| orderBy         | 否  | [ByoAsnOrderBy](/api-reference/cn/zec/datastructure.md#byoasnorderby)   | <p>排序字段。</p><p>未指定时按创建时间排序。</p>          |
| direction       | 否  | [OrderDirection](/api-reference/cn/zec/datastructure.md#orderdirection) | <p>排序方向。</p><p>未指定时为降序。</p>              |
| pageSize        | 否  | Integer                                                                 | <p>返回的分页大小。</p><p>默认为20，最大为1000。</p>     |
| pageNum         | 否  | Integer                                                                 | <p>返回的分页数。</p><p>默认为1。</p><p>默认值：1</p>   |
| tagKeys         | 否  | Array of String                                                         | <p>根据标签键进行搜索。</p><p>最长不得超过20个标签键。</p>    |
| tags            | 否  | Array of [Tag](/api-reference/cn/zec/datastructure.md#tag)              | <p>根据标签进行搜索。</p><p>最长不得超过20个标签。</p>      |

## 3. 响应结果

| 参数名称       | 类型                                                                       | 描述                                                       |
| ---------- | ------------------------------------------------------------------------ | -------------------------------------------------------- |
| requestId  | String                                                                   | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                  | 符合条件的数据总数。                                               |
| dataSet    | Array of [ByoAsnInfo](/api-reference/cn/zec/datastructure.md#byoasninfo) | BYO ASN结果集。                                              |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 查询当前账号下的BYO ASN列表。**

```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeByoAsns
<Common Request Params>

Request：
{
  "pageNum": 1,
  "pageSize": 20
}

Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 2,
    "dataSet": [
      {
        "byoAsnId": "byoasn-3JK29DKS",
        "asn": 12340,
        "status": "AVAILABLE",
        "type": "BYOASN",
        "verifyCode": "62610:831522",
        "exportDeclaration": "export: to AS62610 action community .= {62610:831522}; announce AS12340",
        "ipv4CidrCount": 1,
        "ipv6CidrCount": 1,
        "createTime": "2026-09-03T07:21:17Z",
        "resourceGroup": {
          "resourceGroupId": "9d5f8e2a4c1b47f3",
          "resourceGroupName": "Default Resource Group"
        },
        "tags": {
          "tagList": [
            {
              "key": "env",
              "value": "prod"
            }
          ]
        }
      },
      {
        "byoAsnId": "byoasn-7PQ41MZX",
        "asn": 59798,
        "status": "VERIFYING",
        "type": "BYOASN",
        "verifyCode": "62610:519890",
        "exportDeclaration": "export: to AS62610 action community .= {62610:519890}; announce AS59798",
        "ipv4CidrCount": 0,
        "ipv6CidrCount": 0,
        "createTime": "2026-09-03T09:03:52Z",
        "resourceGroup": {
          "resourceGroupId": "9d5f8e2a4c1b47f3",
          "resourceGroupName": "Default Resource Group"
        },
        "tags": {
          "tagList": []
        }
      }
    ]
  }
}
```

**2. 按ASN号升序排序。**

```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeByoAsns
<Common Request Params>

Request：
{
  "orderBy": "ASN",
  "direction": "ASC"
}

Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 2,
    "dataSet": [
      {
        "byoAsnId": "byoasn-3JK29DKS",
        "asn": 12340,
        "status": "AVAILABLE",
        "type": "BYOASN",
        "verifyCode": "62610:831522",
        "exportDeclaration": "export: to AS62610 action community .= {62610:831522}; announce AS12340",
        "ipv4CidrCount": 1,
        "ipv6CidrCount": 1,
        "createTime": "2026-09-03T07:21:17Z",
        "resourceGroup": {
          "resourceGroupId": "9d5f8e2a4c1b47f3",
          "resourceGroupName": "Default Resource Group"
        },
        "tags": {
          "tagList": []
        }
      },
      {
        "byoAsnId": "byoasn-7PQ41MZX",
        "asn": 59798,
        "status": "VERIFYING",
        "type": "BYOASN",
        "verifyCode": "62610:519890",
        "exportDeclaration": "export: to AS62610 action community .= {62610:519890}; announce AS59798",
        "ipv4CidrCount": 0,
        "ipv6CidrCount": 0,
        "createTime": "2026-09-03T09:03:52Z",
        "resourceGroup": {
          "resourceGroupId": "9d5f8e2a4c1b47f3",
          "resourceGroupName": "Default Resource Group"
        },
        "tags": {
          "tagList": []
        }
      }
    ]
  }
}
```

**3. 只查询已可用的BYO ASN。**

```json
POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeByoAsns
<Common Request Params>

Request：
{
  "status": "AVAILABLE"
}

Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 1,
    "dataSet": [
      {
        "byoAsnId": "byoasn-3JK29DKS",
        "asn": 12340,
        "status": "AVAILABLE",
        "type": "BYOASN",
        "verifyCode": "62610:831522",
        "exportDeclaration": "export: to AS62610 action community .= {62610:831522}; announce AS12340",
        "ipv4CidrCount": 1,
        "ipv6CidrCount": 1,
        "createTime": "2026-09-03T07:21:17Z",
        "resourceGroup": {
          "resourceGroupId": "9d5f8e2a4c1b47f3",
          "resourceGroupName": "Default Resource Group"
        },
        "tags": {
          "tagList": []
        }
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |