本接口用于修改IP地址池信息,包括名称和描述。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | UpdateIpPoolAttribute | 接口名称。当前 API 的名称为 UpdateIpPoolAttribute。 |
Version | String | 是 | 2021-04-30 | 接口版本。当前 API 的版本为 2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ip_pool_id | String | 是 | ippool-phh9wg28qk8**** | IP 地址池 ID。您可以调用 ListIpPools 接口获取 IP 地址池的 ID。 |
ip_pool_name | String | 否 | ip_pool_testing | IP 地址池的名称。命名规则如下:
|
ip_pool_desc | String | 否 | used for testing env | IP 地址池描述。描述须符合以下要求:
|
该接口无特有的返回参数。
POST https://veenedge.volcengineapi.com/?Action=UpdateIpPoolAttribute&Version=2021-04-30 &<其他公共参数> { "ip_pool_id": "ippool-phh9wg28qk8****", "ip_pool_name": "ip_pool_testing" }
{ "ResponseMetadata": { "RequestId": "202507241534500741852050979E****", "Action": "UpdateIpPoolAttribute", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-beijing" }, "Result": {} }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。