DescribePortUsableVlan

DescribePortUsableVlan

1. 接口描述

本接口用于查询端口可用的VLAN范围。

准备工作

注意事项

• 端口或数据中心必传一个。

2. 请求参数

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

参数名称	是否必选	类型	描述
dcId	否	String	数据中心四字码。 具体取值可通过调用接口DescribeDataCenters来获得最新的数据中心列表。
portId	否	String	端口id。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
start	Integer	VLAN 范围起始值。
end	Integer	VLAN 范围结束值。
inuseVlanList	Array of Integer	占用中的vlan列表。

4. 代码示例

示例

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

Request: {
  "portId": "your-port-id"
}

Response: {
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "dataSet": {
      "start": 1,
      "end": 4000,
      "inuseVlanList":[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 3999, 4000]
    }
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
7112	SELF_SERVICE_PORT_VLAN_PORT_AND_DC_NEED_AT_LEAST_ONE	数据中心或端口必传一个。