创建API网关实例。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:CreateInstance | create | *Instance acs:apigateway:{#regionId}:{#accountId}:instance/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ChargeType | string | 是 | 付费类型。 | PostPaid 后付费 PrePaid 预付费 |
| InstanceName | string | 是 | 实例名称 | ApigatewayInstance |
| InstanceSpec | string | 是 | 实例规格 | api.s1.small |
| ZoneId | string | 否 | 可用区，专享实例类型为传统类型专享实例为必填项，VPC 融合类型专享实例可以不填 | cn-beijing-MAZ3(c,e) |
| HttpsPolicy | string | 是 | HTTPS 的策略 | HTTPS2_TLS1_2 |
| Duration | integer | 否 | 实例包年包月的时间，取值：
说明
ChargeType 取值为 PrePaid 时，本参数可用且必须传入。
| 1 |
| PricingCycle | string | 否 | 指定预付费实例为包年或包月类型，取值范围如下：
说明
若付费类型为 PrePaid，该参数为必传参数。
| Month |
| AutoPay | boolean | 否 | 续费时是否自动付费。取值：
默认值：False。 | false |
| Token | string | 是 | 口令，是用来做防止重复提交请求的，请勿重复使用。 | c20d86c4-1eb3-4d0b-afe9-c586df1e2136 |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | |||
| Key | string | 否 | 标签键 | test1 |
| Value | string | 否 | 标签的值。 | v1 |
| InstanceType | string | 否 | 专享实例类型
注意 该参数正在邀测中，暂未开放使用。 | vpc_connect |
| InstanceCidr | string | 否 | 专享实例类型为 VPC 融合专享实例时，实例所在网段
警告 VPC 融合专享实例会连接您指定的网段，请尽量避开冲突，以防出现云产品的私网 IP 和您指定网段下云服务 IP 冲突的情况 注意 该参数正在邀测中，暂未开放使用。 | 172.16.0.0/12 |
| UserVpcId | string | 否 | 专享实例类型为 VPC 融合专享实例时，需要连通的用户 VPC ID 注意 该参数正在邀测中，暂未开放使用。 | vpc-m5eo7khlb4h4f8y9egsdg |
| ZoneVSwitchSecurityGroup | array<object> | 否 | 专享实例类型为 VPC 融合专享实例时，需要连通网络所需要的可用区，虚拟交换机以及安全组信息 注意 该参数正在邀测中，暂未开放使用。 | |
| object | 否 | |||
| ZoneId | string | 否 | 可用区 ID | cn-beijing-c |
| VSwitchId | string | 否 | 虚拟交换机 ID | vsw-0xi349n11cxogmvm866tb |
| CidrBlock | string | 否 | 交换机的 IPv4 网段。 | 192.168.9.0/24 |
| SecurityGroupId | string | 否 | 安全组的 ID，同一个安全组内的服务可以互相访问。 | sg-2ze2ql9nozv8q7kmlt6e |
返回参数
示例
正常返回示例
JSON格式
{
"TagStatus": true,
"InstanceId": "apigateway-hz-b3c5dadd5***",
"RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-19 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-03-07 | OpenAPI 入参发生变更 | 查看变更详情 |