# 更新专享版实例 - UpdateInstanceV2 #### 功能介绍 更新专享版实例 #### 调用方法 请参见[如何调用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:update | Write | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | apig:instances:update | - vpc:securityGroups:get - vpc:ports:update | #### URI PUT /v2/{project_id}/apigw/instances/{instance_id} 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | description | 否 | String | 实例描述。支持除\>和\<以外的字符，长度为0\~255。 | | maintain_begin | 否 | String | 维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。 在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。 | | maintain_end | 否 | String | 维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。 在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。 | | instance_name | 否 | String | 实例名称。 中英文字符开头，只能由中英文字符、数字、中划线、下划线组成，长度为3\~64。 说明： 中文字符必须为UTF-8或者unicode编码。 最小长度：**3** 最大长度：**64** | | security_group_id | 否 | String | 指定实例所属的安全组。 获取方法如下： - 方法1：在虚拟私有云服务的控制台界面，进入安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的"查询安全组列表"章节。 | | vpcep_service_name | 否 | String | 当实例规格为NLB系列规格时，该字段无效。 终端节点服务的名称。 支持英文、数字、中划线、下划线，0\~16个字符。 如果您填写该参数为空，系统生成的终端节点服务的名称为{region}.{service_id}。 如果您填写该参数，系统生成的终端节点服务的名称为{region}.{vpcep_service_name}.{service_id}。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 实例ID | | project_id | String | 实例所属租户ID | | instance_name | String | 实例名称 | | status | String | 实例状态： - Creating：创建中 - CreateSuccess：创建成功 - CreateFail：创建失败 - Initing：初始化中 - Registering：注册中 - Running：运行中 - InitingFailed：初始化失败 - RegisterFailed：注册失败 - Installing：安装中 - InstallFailed：安装失败 - Updating：升级中 - UpdateFailed：升级失败 - Rollbacking：回滚中 - RollbackSuccess：回滚成功 - RollbackFailed：回滚失败 - Deleting：删除中 - DeleteFailed：删除失败 - Unregistering：注销中 - UnRegisterFailed：注销失败 - CreateTimeout：创建超时 - InitTimeout：初始化超时 - RegisterTimeout：注册超时 - InstallTimeout：安装超时 - UpdateTimeout：升级超时 - RollbackTimeout：回滚超时 - DeleteTimeout：删除超时 - UnregisterTimeout：注销超时 - Starting：启动中 - Freezing：冻结中 - Frozen：已冻结 - Restarting：重启中 - RestartFail：重启失败 - Unhealthy：实例异常 - RestartTimeout：重启超时 - Resizing：规格变更中 - ResizeFailed：规格变更失败 - ResizeTimeout：规格变更超时 | | instance_status | Integer | 实例状态对应编号 - 1：创建中 - 2：创建成功 - 3：创建失败 - 4：初始化中 - 5：注册中 - 6：运行中 - 7：初始化失败 - 8：注册失败 - 10：安装中 - 11：安装失败 - 12：升级中 - 13：升级失败 - 20：回滚中 - 21：回滚成功 - 22：回滚失败 - 23：删除中 - 24：删除失败 - 25：注销中 - 26：注销失败 - 27：创建超时 - 28：初始化超时 - 29：注册超时 - 30：安装超时 - 31：升级超时 - 32：回滚超时 - 33：删除超时 - 34：注销超时 - 35：启动中 - 36：冻结中 - 37：已冻结 - 38：重启中 - 39：重启失败 - 40：实例异常 - 41：重启超时 - 42：规格变更中 - 43：规格变更失败 - 44：规格变更超时 | | type | String | 实例类型 默认apig | | spec | String | 实例规格： - BASIC：基础版实例 - PROFESSIONAL：专业版实例 - ENTERPRISE：企业版实例 - PLATINUM：铂金版实例 - BASIC_IPV6：基础版IPV6实例 - PROFESSIONAL_IPV6：专业版IPV6实例 - ENTERPRISE_IPV6：企业版IPV6实例 - PLATINUM_IPV6：铂金版IPV6实例 - PLATINUM_X2：铂金版 x2实例 - PLATINUM_X3：铂金版 x3实例 - PLATINUM_X4：铂金版 x4实例 - PLATINUM_X5：铂金版 x5实例 - PLATINUM_X6：铂金版 x6实例 - PLATINUM_X7：铂金版 x7实例 - PLATINUM_X8：铂金版 x8实例 - PLATINUM_X2_IPV6：铂金版IPV6 x2实例 - PLATINUM_X3_IPV6：铂金版IPV6 x3实例 - PLATINUM_X4_IPV6：铂金版IPV6 x4实例 - PLATINUM_X5_IPV6：铂金版IPV6 x5实例 - PLATINUM_X6_IPV6：铂金版IPV6 x6实例 - PLATINUM_X7_IPV6：铂金版IPV6 x7实例 - PLATINUM_X8_IPV6：铂金版IPV6 x8实例 - NLB_BASIC：NLB基础版实例(无内置ELB) - NLB_PROFESSIONAL：NLB专业版实例(无内置ELB) - NLB_ENTERPRISE：NLB企业版实例(无内置ELB) - NLB_PLATINUM：NLB铂金版实例(无内置ELB) - NLB_BASIC_IPV6：NLB基础版IPV6实例(无内置ELB) - NLB_PROFESSIONAL_IPV6：NLB专业版IPV6实例(无内置ELB) - NLB_ENTERPRISE_IPV6：NLB企业版IPV6实例(无内置ELB) - NLB_PLATINUM_IPV6：NLB铂金版IPV6实例(无内置ELB) - NLB_PLATINUM_X2：NLB铂金版 x2实例(无内置ELB) - NLB_PLATINUM_X3：NLB铂金版 x3实例(无内置ELB) - NLB_PLATINUM_X4：NLB铂金版 x4实例(无内置ELB) - NLB_PLATINUM_X5：NLB铂金版 x5实例(无内置ELB) - NLB_PLATINUM_X6：NLB铂金版 x6实例(无内置ELB) - NLB_PLATINUM_X7：NLB铂金版 x7实例(无内置ELB) - NLB_PLATINUM_X8：NLB铂金版 x8实例(无内置ELB) - NLB_PLATINUM_X2_IPV6：NLB铂金版IPV6 x2实例(无内置ELB) - NLB_PLATINUM_X3_IPV6：NLB铂金版IPV6 x3实例(无内置ELB) - NLB_PLATINUM_X4_IPV6：NLB铂金版IPV6 x4实例(无内置ELB) - NLB_PLATINUM_X5_IPV6：NLB铂金版IPV6 x5实例(无内置ELB) - NLB_PLATINUM_X6_IPV6：NLB铂金版IPV6 x6实例(无内置ELB) - NLB_PLATINUM_X7_IPV6：NLB铂金版IPV6 x7实例(无内置ELB) - NLB_PLATINUM_X8_IPV6：NLB铂金版IPV6 x8实例(无内置ELB) 当前仅部分region支持铂金版 x2、铂金版 x3、铂金版 x4、铂金版 x5、铂金版 x6、铂金版 x7、铂金版 x8。 NLB系列规格实例，需要开启白名单后才可以使用。 | | create_time | Long | 实例创建时间。unix时间戳格式。 | | enterprise_project_id | String | 企业项目ID，企业账号必填 | | eip_address | String | 实例绑定的弹性IP地址 | | charging_mode | Integer | 实例计费方式： - 0：按需计费 - 1：包周期计费 | | cbc_metadata | String | 包周期计费订单编号 | | loadbalancer_provider | String | 实例使用的负载均衡器类型 - lvs Linux虚拟服务器 - elb 弹性负载均衡，elb仅部分region支持 缺省值：**lvs** | | cbc_operation_locks | Array of [CbcOperationLock] objects | 云运营限制操作锁 | | description | String | 实例描述 | | vpc_id | String | 虚拟私有云ID。 获取方法如下： - 方法1：在虚拟私有云服务的控制台界面，进入虚拟私有云的详情页面查找VPC ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的"查询VPC列表"章节。 | | subnet_id | String | 子网的网络ID。 获取方法如下： - 方法1：在虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的"查询子网列表"章节。 | | security_group_id | String | 指定实例所属的安全组。 获取方法如下： - 方法1：在虚拟私有云服务的控制台界面，进入安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体方法请参见《虚拟私有云服务API参考》的"查询安全组列表"章节。 | | maintain_begin | String | '维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。' | | maintain_end | String | '维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次'。 | | ingress_ip | String | 实例入口，虚拟私有云访问地址。 当实例规格为NLB系列规格时，该字段无效。 | | ingress_ip_v6 | String | 实例入口，虚拟私有云访问地址 (IPv6) 。 当实例规格为NLB系列规格时，该字段无效。 | | user_id | String | 实例所属用户ID | | nat_eip_ipv6_cidr | String | 出公网网段 (IPv6) 。 当前仅部分region部分可用区支持IPv6。 当实例规格为NLB系列规格时，该字段无效。 | | eip_ipv6_address | String | 弹性IP地址(IPv6)。 当前仅部分region部分可用区支持IPv6。 当实例规格为NLB系列规格时，该字段无效。 | | nat_eip_address | String | 实例出公网IP。 当实例规格为NLB系列规格时，该字段无效。 | | bandwidth_size | Integer | 出公网带宽。 当实例规格为NLB系列规格时，该字段无效。 | | bandwidth_charging_mode | String | 出公网带宽计费模式。 当实例规格为NLB系列规格时，该字段无效。 | | available_zone_ids | String | 可用区 | | instance_version | String | 实例版本编号 | | virsubnet_id | String | 子网的网络ID。 暂不支持 | | roma_eip_address | String | roma弹性公网IP。 暂不支持 | | listeners | Object | 监听信息 暂不支持 | | supported_features | Array of strings | 实例支持的特性列表 | | endpoint_service | [EndpointService] object | 终端节点服务详情 待废弃，优先使用endpoint_services | | endpoint_services | Array of [EndpointService] objects | 终端节点服务列表。 当实例规格为NLB系列规格时，该字段无效。 | | node_ips | [NodeIps] object | 服务节点IP | | node_ipv6_ips | [NodeIps] object | 服务IPV6节点IP | | public_ipv6_ips | Array of strings | 实例IPV6出公网IP。 当实例规格为NLB系列规格时，该字段无效。 | | publicips | Array of [IpDetails] objects | 公网入口地址列表 | | privateips | Array of [IpDetails] objects | 私网入口地址列表 | | unreliable_ips | Array of strings | 不建议使用的实例入口列表：分组子域名解析未指向到该列表的IP，不能用该列表的IP直接访问DEFAULT分组 | | enable_fullstack_ipv6 | Boolean | 实例是否支持全量IPv6 - true：支持，实例入口和实例出口都支持IPV6 - false：不支持，仅实例入口支持IPV6 | | is_releasable | Boolean | 实例是否可释放 - true：可释放 - false：不可释放 | | ingress_bandwidth_charging_mode | String | 入公网带宽计费模式 | 表5CbcOperationLock | 参数 | 参数类型 | 描述 | |:---|:---|:---| | lock_scene | String | 限制操作场景： - TO_PERIOD_LOCK：按需转包周期场景锁，不允许进行删除、规格变更、按需转包周期等 - SPEC_CHG_LOCK：包周期规格变更场景锁，不允许进行删除、规格变更等 | | lock_source_id | String | 发起限制操作对象的标志 | 表6EndpointService | 参数 | 参数类型 | 描述 | |:---|:---|:---| | service_name | String | 终端节点服务名称 | | created_at | String | 创建时间 | 表7NodeIps | 参数 | 参数类型 | 描述 | |:---|:---|:---| | livedata | Array of strings | livedata节点IP地址列表 | | shubao | Array of strings | shubao节点IP地址列表 | 表8IpDetails | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip_address | String | IP地址 | | ipv6_address | String | IPV6地址 | | bandwidth_size | Integer | 带宽大小 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 更新实例的信息 ``` { "description" : "test create instance", "instance_name" : "apig-demo" } ``` #### 响应示例 **状态码：200** OK ``` { "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]", "bandwidth_size" : 5, "description" : "test create instance", "enterprise_project_id" : "0", "instance_name" : "apig-demo", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7", "spec" : "PROFESSIONAL", "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5", "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763", "enable_fullstack_ipv6" : true, "unreliable_ips" : [ "192.xx.xxx.xxx" ] } ``` **状态码：400** Bad Request ``` { "error_code" : "APIC.7211", "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]" } ``` **状态码：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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-apig/ErrorCode.html)。