ModifyIpAddressPoolAttributes--公网IP-火山引擎

文档中心

立即注册

导航

ModifyIpAddressPoolAttributes

最近更新时间：2024.11.18 10:48:14首次发布时间：2024.09.06 10:16:24

调用 ModifyIpAddressPoolAttributes 接口，修改IP地址池的名称和描述。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	ModifyIpAddressPoolAttributes	要执行的操作，取值：ModifyIpAddressPoolAttributes。
Version	String	是	2020-04-01	API的版本信息，当前版本为2020-04-01。
IpAddressPoolId	String	是	ippool-fda83op****	IP 地址池的 ID。您可以调用 DescribeIpAddressPools 接口，查询IP地址池的ID。
Name	String	否	IpAddressPool01	IP 地址池的名称。长度限制为 1 ~ 128个字符。需要以字母或数字开头，不能以 http:// 或 https://.开头。可包含字母、数字、引号（：）、下划线（_）和短划线（-）。不填默认为不修改。
Description	String	否	238q08230***	IP 地址池的描述。长度限制为 1 ~ 255 个字符。需要以字母、中文或数字开头，不能以 http:// 或 https://. 开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不填默认为不修改。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303314515207C4****	请求ID。

请求示例

GET /?Action=ModifyIpAddressPoolAttributes&Version=2020-04-01&IpAddressPoolId=ippool-fda83op****&Name=IpAddressPool01 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210624153033015207C4****",
        "Action": "ModifyIpAddressPoolAttributes",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
         "RequestId": "20210624153033015207C4****"
     }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
	InvalidIPPool.InvalidStatus	The specified IP address pool is not in the correct status for the request.	指定IP地址池所处的状态无法响应该请求。
	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
404	InvalidIPPool.NotFound	The specified IP address pool does not exist.	指定的IP地址池不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。