# 创建专享版实例（按需） - CreateInstanceV2 #### 功能介绍 创建按需专享版实例 #### 调用方法 请参见[如何调用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:create | Write | - | - g:RequestTag/\ - g:TagKeys | apig:instances:create | - vpc:securityGroups:get - vpc:ports:create - vpc:ports:update - eip:publicIps:get - eip:publicIps:update - eps:enterpriseProjects:list | #### URI POST /v2/{project_id}/apigw/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-apig/apig-api-180713009.html)。 | #### 请求参数 表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** | | instance_id | 否 | String | 实例编号，不填写自动生成 | | spec_id | 是 | 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系列规格实例，需要开启白名单后才可以使用。 | | elb_id | 否 | String | 弹性负载均衡器ID，当实例规格为NLB系列规格时，该字段必填。 选择的弹性负载均衡器实例类型必须为独享型，负载均衡类型必须包含网络型。 创建实例时，该ELB将会开启实例删除保护，添加APIG的标签。 获取方法如下： - 方法1：登录弹性负载均衡服务的控制台界面，在弹性负载均衡的详情页面查找ELB ID。 - 方法2：通过弹性负载均衡服务的API接口查询，具体方法请参见《弹性负载均衡服务API参考》的"查询负载均衡器列表"章节。 最小长度：**32** 最大长度：**36** | | force_overwrite_enabled | 否 | Boolean | 删除监听端口为80、443或在APIG已配置的自定义端口的监听器开关。当弹性负载均衡器中已有监听端口为80、443或在APIG配置的自定义端口的监听器时，该参数必须置为true，否则无法添加该ELB。 缺省值：**true** | | 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参考》的"查询安全组列表"章节。 | | eip_id | 否 | String | 弹性公网IP ID。 实例需要开启公网访问，且loadbalancer_provider为lvs时需要填写，绑定后使用者可以通过该入口从公网访问APIG实例中的API等资源 获取方法：在虚拟私有云服务的控制台界面，进入弹性公网IP的详情页面查找弹性公网IP ID。 | | enterprise_project_id | 否 | String | 企业项目ID，企业账号必填。 获取方法如下： - 方法1：在企业项目管理界面，进入项目管理详情页面查找项目ID。 - 方法2：通过企业项目管理的API接口查询，具体方法请参见《企业管理API参考》的"查询企业项目列表"章节。 | | available_zone_ids | 是 | Array of strings | 可用区列表。 可用区指在同一地域下，电力、网络隔离的物理区域，可用区之内内网互通，不同可用区之间物理隔离。选择多个AZ部署可以有效提升可靠性。 获取方法：通过文档中实例管理的可用区列表接口查询。 | | bandwidth_size | 否 | Integer | 出公网带宽。 实例需要开启出公网功能时需要填写，绑定后使用者可以利用该出口访问公网上的互联网资源。 当实例规格为NLB系列规格时，该字段无效。 缺省值：**5** | | bandwidth_charging_mode | 否 | String | 当实例规格为NLB系列规格时，该字段无效。 出公网带宽计费类型，实例需要开启出公网功能时需要填写： - bandwidth：按带宽计费 缺省值：**bandwidth** | | ipv6_enable | 否 | Boolean | 公网访问是否支持IPv6。 当前仅部分region部分可用区支持IPv6 | | loadbalancer_provider | 否 | String | 实例使用的负载均衡器类型 - 该字段废弃，由Region支持的负载均衡模式决定使用elb还是lvs，详情参考产品介绍下的约束与限制。 - lvs Linux虚拟服务器 - elb 弹性负载均衡，elb仅部分region支持 缺省值：**lvs** | | tags | 否 | Array of [TmsKeyValue] objects | 标签列表。 一个实例默认最多支持创建20个标签 数组长度：**0 - 20** | | vpcep_service_name | 否 | String | 当实例规格为NLB系列规格时，该字段无效。 终端节点服务的名称。 支持英文、数字、中划线、下划线，0\~16个字符。 如果您不填写该参数，系统生成的终端节点服务的名称为{region}.apig.{service_id}。 如果您填写该参数，系统生成的终端节点服务的名称为{region}.{vpcep_service_name}.{service_id}。 实例创建完成后，可以在实例管理-\>终端节点管理页面修改该名称。 | | ingress_bandwidth_size | 否 | Integer | 入公网带宽。 实例需要开启入公网功能，且loadbalancer_provider为elb时需要填写，绑定后使用者可以通过该入口从公网访问APIG实例中的API等资源。 当实例规格为NLB系列规格时，该字段无效。 缺省值：**5** | | ingress_bandwidth_charging_mode | 否 | String | 当实例规格为NLB系列规格时，该字段无效。 入公网带宽计费类型，实例需要开启入公网功能，且loadbalancer_provider为elb时需要填写： - bandwidth：按带宽计费 缺省值：**bandwidth** | 表4TmsKeyValue | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | 键。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : = + - @； _sys_开头属于系统标签，租户不能输入 最小长度：**1** 最大长度：**128** | | value | 否 | String | 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 最小长度：**0** 最大长度：**255** | #### 响应参数 **状态码：202** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | 实例ID | | message | String | 创建实例任务信息 | | job_id | String | 任务编号 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 创建一个实例，配置网络、安全组等信息 ``` { "available_zone_ids" : [ "xx-xxx-7b", "xx-xxx-7a" ], "bandwidth_size" : 5, "description" : "test create instance", "eip_id" : "41f961ab-2bdd-4ca7-9b59-cfc4fcef10c9", "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_id" : "PROFESSIONAL", "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5", "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763" } ``` #### 响应示例 **状态码：202** Accepted ``` { "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81", "message" : "JOB_ASSIGNED_FOR_PROVISIONING_0003I:The job JOB-bdb370eb6f4c4c73b61b95a9da38beb5 has been assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running provisioning.", "job_id" : "JOB-edbac2355fb7433e98f173ea2e452e2d" } ``` **状态码：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.7301", "error_msg" : "Instance spec 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)。