# 登记实例入口IP信息 - RegisterIngressIps
#### 功能介绍
登记实例入口IP信息，仅当实例为NLB系列规格时支持。
#### 调用方法
请参见[如何调用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:registerIngressIps | Write | instance \* | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | -  | elb:loadbalancers:show |
     
  
 
#### URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/ingress-register
表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参数 
| 参数   | 是否必选 | 参数类型                                                                                 | 描述                                                              |
|:---|:---|:---|:---|
| elbs | 是    | Array of [ElbIngressDetails] objects | 弹性负载均衡详情。 数组长度：**1 - 10** |
   
 表4ElbIngressDetails 
| 参数          | 是否必选 | 参数类型                                                               | 描述                                                                                                            |
|:---|:---|:---|:---|
| public_ips  | 否    | Array of [IpDetail] objects | 公网入口。 数组长度：**0 - 2**                                                    |
| private_ips | 否    | Array of [IpDetail] objects | 私网入口。 数组长度：**0 - 2**                                                    |
| global_eips | 否    | Array of [IpDetail] objects | 全域公网入口。 数组长度：**0 - 2**                                                  |
| elb_id      | 是    | String                                                             | 弹性负载均衡编号。 最小长度：**32** 最大长度：**36** |
   
 表5IpDetail 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| type | 是    | String | IP版本信息。 - v4: IPv4。   - v6: IPv6。    |
| ip   | 是    | String | IP地址。                                                                                                                                                                                                                                                                                                                                                                                    |
   
#### 响应参数
**状态码：202**
表6响应Body参数 
| 参数          | 参数类型   | 描述                                                                                                        |
|:---|:---|:---|
| instance_id | String | 实例ID。 最小长度：**32** 最大长度：**36** |
| message     | String | 任务信息。 最小长度：**0** 最大长度：**200** |
| job_id      | String | 任务编号。 最小长度：**36** 最大长度：**36** |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：401**
表8响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：403**
表9响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：404**
表10响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：500**
表11响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
登记实例入口IP信息。
```
{
  "elbs" : [ {
    "elb_id" : "85392b45-685c-4f77-b19a-14ad875b8190",
    "public_ips" : [ {
      "type" : "v4",
      "ip" : "xxx.xxx.xxx.xxx"
    } ]
  } ]
}
```
#### 响应示例
**状态码：202**
Accepted
```
{
  "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
  "message" : "JOB_ASSIGNED_FOR_UPDATE_0077I:The job JOB-a7c1241c33334490a3fdcd11102bcbda is assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running updating",
  "job_id" : "JOB-a7c1241c33334490a3fdcd11102bcbda"
}
```
**状态码：400**
Bad Request
```
{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[elb_id]"
}
```
**状态码：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"
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 202 | Accepted              |
| 400 | Bad Request           |
| 401 | Unauthorized          |
| 403 | Forbidden             |
| 404 | Not Found             |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-apig/ErrorCode.html)。