- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
创建专享版实例(包周期)
功能介绍
创建包周期专享版实例。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/apigw/prepay-instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
product_id |
否 |
String |
产品编号 |
charging_mode |
否 |
Integer |
计费模式:
|
payment_mode |
否 |
String |
支付模式:
缺省值:ALL_UPFRONT |
period_type |
否 |
Integer |
订购周期类型:
|
period_num |
否 |
Integer |
订购周期数:1-9 |
is_auto_renew |
否 |
Integer |
是否支持自动续费:
|
promotion_id |
否 |
String |
促销产品编号 |
promotion_plan_id |
否 |
String |
促销计划编号 |
promotion_info |
否 |
String |
促销信息 |
composite_product_id |
否 |
String |
组合产品编号 |
instance_info |
否 |
InstanceCreateReqV2 object |
实例信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
实例规格:
当前仅部分region支持铂金版 x2、铂金版 x3、铂金版 x4、铂金版 x5、铂金版 x6、铂金版 x7、铂金版 x8 |
vpc_id |
是 |
String |
虚拟私有云ID。 获取方法如下:
|
subnet_id |
是 |
String |
子网的网络ID。 获取方法如下:
|
security_group_id |
是 |
String |
指定实例所属的安全组。 获取方法如下:
|
eip_id |
否 |
String |
弹性公网IP ID。 实例需要开启公网访问,且loadbalancer_provider为lvs时需要填写,绑定后使用者可以通过该入口从公网访问APIG实例中的API等资源 获取方法:登录虚拟私有云服务的控制台界面,在弹性公网IP的详情页面查找弹性公网IP ID。 |
enterprise_project_id |
否 |
String |
企业项目ID,企业账号必填。 获取方法如下:
|
available_zone_ids |
是 |
Array of strings |
可用区列表 |
bandwidth_size |
否 |
Integer |
出公网带宽 实例需要开启出公网功能时需要填写,绑定后使用者可以利用该出口访问公网上的互联网资源 缺省值:5 |
bandwidth_charging_mode |
否 |
String |
带宽收费模式:
|
ipv6_enable |
否 |
Boolean |
公网访问是否支持IPv6。 当前仅部分region部分可用区支持IPv6 |
loadbalancer_provider |
否 |
String |
负载均衡器类型:
|
tags |
否 |
Array of TmsKeyValue objects |
标签列表。 一个实例默认最多支持创建20个标签 数组长度:0 - 20 |
vpcep_service_name |
否 |
String |
终端节点服务的名称。 支持英文、数字、中划线、下划线,0~16个字符。 如果您不填写该参数,系统生成的终端节点服务的名称为{region}.apig.{service_id}。 如果您填写该参数,系统生成的终端节点服务的名称为{region}.{vpcep_service_name}.{service_id}。 实例创建完成后,可以在实例管理->终端节点管理页面修改该名称。 |
ingress_bandwidth_size |
否 |
Integer |
入口带宽大小 |
ingress_bandwidth_charging_mode |
否 |
String |
入口带宽收费模式:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
order_id |
String |
订单编号 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
{ "product_id" : "00301-35126-0--0", "charging_mode" : 1, "period_type" : 2, "period_num" : 1, "instance_info" : { "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" } }
响应示例
状态码: 200
OK
{ "order_id" : "CS2306142249SHP53" }
状态码: 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" }
状态码: 500
Internal Server Error
{ "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。