文档

CreateInstance - 创建实例

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

创建API网关实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:CreateInstanceWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ChargeTypestring

付费类型。

PostPaid 后付费 PrePaid 预付费
InstanceNamestring

实例名称

ApigatewayInstance
InstanceSpecstring

实例规格

api.s1.small
ZoneIdstring

可用区,专享实例类型为传统类型专享实例为必填项,VPC 融合类型专享实例可以不填

cn-beijing-MAZ3(c,e)
HttpsPolicystring

https 的策略

HTTPS2_TLS1_2
Durationinteger

实例包年包月的时间,取值:

  • PricingCycle 为 Month,表示按月付费,取值范围为 1~9
  • PricingCycle 为 Year,表示按年付费,取值范围为 1~3
说明 ChargeType 取值为 PrePaid 时,本参数可用且必须传入。
1
PricingCyclestring

指定预付费实例为包年或包月类型,取值范围如下:

  • year:年
  • month:月
说明 若付费类型为 PrePaid,该参数为必传参数。
Month
AutoPayboolean

续费时是否自动付费。取值:

  • True:自动付费。请确保账号有足够的余额。
  • False:控制台手动付费。具体操作为:登录控制台,在右上角选择费用>进入费用中心,在订单管理找到目标订单进行支付。

默认值:False

false
Tokenstring

口令,是用来做防止重复提交请求的,请勿重复使用。

c20d86c4-1eb3-4d0b-afe9-c586df1e2136
Tagobject []

标签列表。

Keystring

标签键

test1
Valuestring

标签的值。

v1
InstanceTypestring

专享实例类型

  • vpc_connect:VPC 融合类型专享实例
  • normal:传统类型专享实例

注意 说明该参数正在邀测中,暂未开放使用。

vpc_connect
InstanceCidrstring

专享实例类型为 VPC 融合专享实例时,实例所在网段

  • 192.168.0.0/16
  • 172.16.0.0/12

警告 VPC 融合专享实例会连接您指定的网段,请尽量避开冲突,以防出现云产品的私网 ip 和您指定网段下云服务 ip 冲突的情况
注意 说明该参数正在邀测中,暂未开放使用。

172.16.0.0/12
UserVpcIdstring

专享实例类型为 VPC 融合专享实例时,需要连通的用户 VPC ID

注意 说明该参数正在邀测中,暂未开放使用。

vpc-m5eo7khlb4h4f8y9egsdg
ZoneVSwitchSecurityGroupobject []

专享实例类型为 VPC 融合专享实例时,需要连通网络所需要的可用区,虚拟交换机以及安全组信息

注意 说明该参数正在邀测中,暂未开放使用。

ZoneIdstring

可用区 ID

cn-beijing-c
VSwitchIdstring

虚拟交换机 ID

vsw-0xi349n11cxogmvm866tb
CidrBlockstring

交换机的 IPv4 网段。

192.168.9.0/24
SecurityGroupIdstring

安全组的 ID,同一个安全组内的服务可以互相访问。

sg-2ze2ql9nozv8q7kmlt6e

返回参数

名称类型描述示例值
object
TagStatusboolean

标签是否存在,取值为:-true:存在-false:不存在

True
InstanceIdstring

实例 ID

apigateway-hz-b3c5dadd5***
RequestIdstring

请求 ID

CEB6EC62-B6C7-5082-A45A-45A204724AC2

示例

正常返回示例

JSON格式

{
  "TagStatus": true,
  "InstanceId": "apigateway-hz-b3c5dadd5***",
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-19API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-03-07OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceType
    新增入参:InstanceCidr
    新增入参:UserVpcId
    新增入参:ZoneVSwitchSecurityGroup
  • 本页导读 (1)