用户之声——提建议·赢好礼> HOT

1. 接口描述

接口请求域名: tse.tencentcloudapi.com 。

创建云原生API网关实例

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCloudNativeAPIGateway。
Version String 公共参数,本接口取值:2020-12-07。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn 。
Name String 云原生API网关名字, 最多支持60个字符。
示例值:kong-test
Type String 云原生API网关类型, 目前只支持kong。
示例值:kong
GatewayVersion String 云原生API网关版本。参考值:
- 2.4.1
- 2.5.1
示例值:2.4.1
NodeConfig CloudNativeAPIGatewayNodeConfig 云原生API网关节点配置。
VpcConfig CloudNativeAPIGatewayVpcConfig 云原生API网关vpc配置。
Description String 云原生API网关描述信息, 最多支持120个字符。
示例值:kong test
Tags.N Array of InstanceTagInfo 标签列表
EnableCls Boolean 是否开启 CLS 日志。默认值:fasle
示例值:false
FeatureVersion String 产品版本。参考值:
- TRIAL:开发版
- STANDARD:标准版 (默认值)
- PROFESSIONAL:专业版
示例值:STANDARD
InternetMaxBandwidthOut Integer 公网出流量带宽,[1,2048]Mbps
示例值:10
EngineRegion String 实例实际的地域信息,默认值:ap-guangzhou
示例值:ap-guangzhou
IngressClassName String ingress Class名称
示例值:nginx
TradeType Integer 付费类型。参考值:
0:后付费(默认值)
1:预付费(接口暂不支持创建预付费实例)
示例值:0
InternetConfig InternetConfig 公网相关配置

3. 输出参数

参数名称 类型 描述
Result CreateCloudNativeAPIGatewayResult 创建云原生API网关实例响应结果。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建云原生API网关实例

创建云原生API网关实例

输入示例

POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudNativeAPIGateway
<公共请求参数>

{
    "Name": "test",
    "Type": "kong",
    "GatewayVersion": "2.5.1",
    "NodeConfig": {
        "Specification": "1c2g",
        "Number": 2
    },
    "VpcConfig": {
        "VpcId": "vpc-xxxxxx",
        "SubnetId": "subnet-xxxxxx"
    },
    "Description": "test",
    "Tags": [
        {
            "TagKey": "abc",
            "TagValue": "abc"
        }
    ],
    "EnableCls": false,
    "FeatureVersion": "STANDARD",
    "InternetMaxBandwidthOut": 1,
    "EngineRegion": "ap-guangzhou",
    "IngressClassName": "abc",
    "TradeType": 0,
    "InternetConfig": {
        "InternetAddressVersion": "abc",
        "InternetPayMode": "abc",
        "InternetMaxBandwidthOut": 1,
        "Description": "abc",
        "SlaType": "abc",
        "MultiZoneFlag": true,
        "MasterZoneId": "abc",
        "SlaveZoneId": "abc"
    }
}

输出示例

{
    "Response": {
        "Result": {
            "GatewayId": "abc",
            "Status": "abc",
            "TaskId": "abc"
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.Cls 调用CLS服务失败
FailedOperation.FailedOperation 操作失败。
FailedOperation.InternalError 操作失败,内部错误。
FailedOperation.Resource 超过购买实例的最大数量。
FailedOperation.Role 获取临时密钥失败
FailedOperation.Vpc 调用VPC服务失败
InternalError 内部错误。
InternalError.CreateError 创建内部错误。
InvalidParameterValue.BadRequestFormat 请求格式不正确。
InvalidParameterValue.CreateError 无效请求参数导致创建失败。
InvalidParameterValue.InvalidParameterValue 无效的参数值。
InvalidParameterValue.Name 无效的名称。
InvalidParameterValue.Region 无效的Region。
InvalidParameterValue.Specification 网关规格参数内容错误
InvalidParameterValue.Type 网关类型参数内容错误
LimitExceeded.LimitExceeded 参数超过限制。
MissingParameter.MissParameter 缺少参数。
OperationDenied.OperationDenied 不允许的操作。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.ClsNotActivated 当前CLS产品未开通
UnauthorizedOperation.Uin Uin未授权
UnauthorizedOperation.UnauthorizedOperation 未授权的操作。
http://www.vxiaotou.com