DeletePublicAddress - 关闭公网访问--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DeletePublicAddress - 关闭公网访问

最近更新时间：2024.09.26 15:55:17首次发布时间：2023.03.30 19:59:25

调用 DeletePublicAddress 接口关闭公网访问方式。

使用说明

如果不再需要通过公网访问实例，可以通过此接口关闭实例的公网访问方式，并解绑公网 IP 地址。

说明

修改实例的公网 IP，可以先调用此接口关闭公网访问，再通过 CreatePublicAddress 打开公网访问，并绑定新的IP地址。
该接口能够动态关闭实例的公网访问权限，但并不会释放 EIP 资源，您需要手动释放 EIP 资源。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DeletePublicAddress	要执行的操作，取值：DeletePublicAddress。
Version	String	是	2022-05-01	API的版本，取值：2022-05-01。
InstanceId	String	是	kafka-cnngqkfgdudt****	待关闭公网访问方式的 Kafka 实例 ID。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=CreatePublicAddress&Version=2022-05-01 HTTP/1.1
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-cnng3s31v076****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023022719153124D1D2D50917B7639137",
        "Action": "DeletePublicAddress",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
403	OperationDenied.InternetAccessDisabled	Internet access is disabled for the instance.	该实例未开启公网访问方式。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。