
# 新增实例的自定义入方向端口 - AddCustomIngressPort
#### 功能介绍
新增实例的自定义入方向端口，在同个实例中，一个端口仅能支持一种协议。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-apig/apig-api-180713003.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apig/apig-api-grant-policy_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                | 别名 | 依赖的授权项            |
  |:---|:---|:---|:---|:---|:---|
  | apig:instance:addCustomIngressPort | Write | instance \* | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | -  | apig:instance:get |
     
  
 
#### URI
POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                      |
|:---|:---|:---|:---|
| project_id  | 是    | String | 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.html)。 |
| instance_id | 是    | String | 实例ID，在API网关控制台的"实例信息"中获取。                                                               |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表3请求Body参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| protocol     | 是    | String  | 实例自定义入方向端口协议。 - HTTP：实例自定义入方向端口使用HTTP协议。   - HTTPS：实例自定义入方向端口使用HTTPS协议。    |
| ingress_port | 是    | Integer | 实例自定义入方向端口，支持的端口范围为1024\~49151。 最小值：**1024** 最大值：**49151**                                                                                                                                                                                                                                                                                                     |
   
#### 响应参数
**状态码：201**
表4响应Body参数 
| 参数              | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|
| protocol        | String  | 实例自定义入方向端口协议。 - HTTP：实例自定义入方向端口使用HTTP协议。   - HTTPS：实例自定义入方向端口使用HTTPS协议。        |
| ingress_port    | Integer | 实例自定义入方向端口，支持的端口范围为1024\~49151。 最小值：**1024** 最大值：**49151**                                                                                                                                                                                                                                                                                                         |
| ingress_port_id | String  | 实例自定义入方向端口ID。 最小长度：**32** 最大长度：**36**                                                                                                                                                                                                                                                                                                                              |
| status          | String  | 实例自定义入方向端口的有效状态。 - normal：实例自定义入方向端口状态正常。   - abnormal：实例自定义入方向端口状态异常，无法使用。    |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：401**
表6响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：403**
表7响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：404**
表8响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：500**
表9响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
新增实例的自定义入方向端口
```
{
  "protocol" : "HTTP",
  "ingress_port" : 8080
}
```
#### 响应示例
**状态码：201**
Created
```
{
  "protocol" : "HTTP",
  "ingress_port" : 8080,
  "ingress_port_id" : "0ae98839d78043d8a6dff54d7cb096dc",
  "status" : "normal"
}
```
**状态码：400**
Bad Request
```
{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[protocol]"
}
```
**状态码：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"
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 201 | Created               |
| 400 | Bad Request           |
| 401 | Unauthorized          |
| 403 | Forbidden             |
| 404 | Not Found             |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-apig/ErrorCode.html)。
