1. 接口描述
本接口(CreateLocalIPTranslationNatRule)用于添加专线网关本端 IP 转换。
接口请求域名:vpc.api.qcloud.com
- 私有网络内原 IP 映射为新 IP,并以新 IP 与专线对端进行网络互访,只有 NAT 类型网关才支持。
- 原 IP 必须在 VPC 网段内,转换后 IP 不能在 VPC 网段内。
- 同一个 NAT 网关下的本端IP转换规则原 IP 不能重复,转换后 IP 也不能重复。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 CreateLocalIPTranslationNatRule。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
vpcId | 是 | String | 系统分配的私有网络 ID,支持升级前的 vpcId,也支持升级后的 unVpcId,例如 vpc-ddg454。 |
directConnectGatewayId | 是 | String | 系统分配的专线网关 ID,例如 dcg-dgd54g。 |
localIPTranslation.n | 是 | Array | 本端IP转换。 |
localIPTranslation.n.originalIP | 是 | String | 原始 IP。 |
localIPTranslation.n.translationIP | 是 | String | 转换后 IP。 |
localIPTranslation.n.description | 否 | String | 备注。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
data | Array | 返回信息。 |
data.taskId | Int | 任务ID,操作结果可以用taskId查询,详见 查询任务执行结果接口。 |
codeDesc | String | 错误码。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码。
错误码 | 描述 |
---|---|
InvalidVpc.NotFound | 无效的 VPC。VPC 资源不存在,请再次核实您输入的资源信息是否正确。可调用 查询私有网络列表(DescribeVpcEx)接口查询。 |
InvalidDirectConnectGateway.NotFound | 无效的专线网关。专线网关资源不存在,请再次核实您输入的资源信息是否正确。可调用 查询专线网关(DescribeDirectConnectGateway)接口查询。 |
InvalidOriginalIP.NotInVpcCidr | 无效的原始 IP。原始 IP 不在 VPC 网段内。 |
InvalidOriginalIP.Duplicate | 无效的原始 IP。原始 IP 重复,原始 IP 已经在该网关的本端IP专线规则中,原始IP不可重复。 |
InvalidTranslationIP.InVpcCidr | 无效的转换后 IP。转换后 IP 在 VPC 网段内。 |
InvalidTranslationIP.Duplicate | 无效的转换后 IP。 转换后 IP 重复,转换后IP已经在该网关的本端 IP 转换规则中,转换后IP不可重复。 |
LocalIPTranslationLimitExceeded | 您添加的本端IP转换规则已达上限。如果需要更多资源,请联系客服申请。更多VPC资源限制信息详见 VPC 使用限制。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=CreateLocalIPTranslationNatRule &<公共请求参数> &vpcId=vpc-csnmo39l &directConnectGatewayId=dcg-mm01ughx &localIPTranslation.0.originalIP=10.100.10.2 &localIPTranslation.0.translationIP=10.100.10.2 &localIPTranslation.0.description=183.0.0.1
输出
{
"code":"0",
"message":"",
"data":{
"taskId":"17934"
},
"codeDesc":"Success"
}