TerminatePort

TerminatePort

1. 接口描述

本接口用于终止端口。

准备工作

  • 在终止端口之前,你可以调用DescribePorts进行查看端口列表。

注意事项

  • 不再使用的端口,可通过本接口主动退还。如果是后付费,退还的端口将停止计费。

  • 本接口无法主动退还预付费订阅模式的端口,订阅模式的端口将会在订阅到期后自动退还。

  • 退还后的端口将进入回收站,进入回收站后如无其他操作端口将在48小时后自动释放,也可以调用DestroyPort接口主动进行释放。

  • 已经在回收站中或者正在创建中的端口调用该接口无效。

2. 请求参数

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

参数名称是否必选类型描述

portId

String

端口id。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

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

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

Response:
{
  "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2",
  "response": {
    "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码错误码说明

7105

SELF_SERVICE_PORT_NOT_FOUND

端口未找到。

最后更新于