文档首页/ API网关 APIG/ API参考/ 专享版API(V2)/ 专享版-实例管理/ 开启实例公网出口 - AddEngressEipV2
更新时间:2025-10-24 GMT+08:00
分享

开启实例公网出口 - AddEngressEipV2

功能介绍

实例开启公网出口

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apig:instance:createOutboundEip

    Write

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    • apig:instances:update
    • apig:instance:get
    • vpc:ports:get

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID,在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

bandwidth_size

String

出公网带宽

单位:Mbit/s

bandwidth_charging_mode

String

出公网带宽计费类型:

  • bandwidth:按带宽计费

缺省值:bandwidth

响应参数

状态码:200

OK

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

开启实例的公网出口

{
  "bandwidth_size" : "5",
  "bandwidth_charging_mode" : "bandwidth"
}

响应示例

状态码:400

Bad Request

{
  "error_code" : "APIC.9210",
  "error_msg" : "create cloud nat eip failed"
}

状态码:401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码:403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码:404

Not Found

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

状态码:500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档