You need to enable JavaScript to run this app.
导航
修改弹性公网IP描述
最近更新时间:2024.07.08 16:21:02首次发布时间:2022.02.25 18:58:32

本接口用于修改弹性公网 IP 的描述。

请求说明

  • 请求方式:POST
  • 请求地址:https://veenedge.volcengineapi.com/?Action=SetEIPInstanceDesc&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

参数

类型

是否必选

示例值

描述

Action

String

SetEIPInstanceDesc

公共参数。该参数表示接口名称。取值:SetEIPInstanceDesc。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

Body

参数

类型

是否必选

示例值

描述

eip_identity

String

eip-wqjgxf****

弹性公网 IP 的 ID。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。

desc

String

test

弹性公网 IP 的描述。最多可输入 80 个字符。
如果不指定该参数或参数值为空字符串,原来的描述将被清空。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetEIPInstanceDesc&Version=2021-04-30
&<其他公共参数>
{
  "eip_identity":"eip-jgxf****",
  "desc":"test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230524153838AA7CB16589B2E8FD****",
        "Action": "SetEIPInstanceDesc",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码