本接口用于修改弹性公网 IP 的名称。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SetEIPInstanceName | 公共参数。该参数表示接口名称。取值:SetEIPInstanceName。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
eip_identity | String | 是 | eip-wqjgxf**** | 弹性公网 IP 的 ID。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。 |
name | String | 是 | new-name | 弹性公网 IP 的名称。命名规则如下:
|
该接口无特有的返回参数。
POST https://veenedge.volcengineapi.com/?Action=SetEIPInstanceName&Version=2021-04-30 &<其他公共参数> { "eip_identity":"eip-wqjgxf****" }
{ "ResponseMetadata": { "RequestId": "20230524155004F9A9DAEA1A8A00A2****", "Action": "SetEIPInstanceName", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。