全部产品
Search

搜索本产品

    云原生数据库 PolarDB：CreateGateway - 创建网关实例

    文档中心

    云原生数据库 PolarDB：CreateGateway - 创建网关实例

    更新时间：Apr 28, 2026

    创建网关实例。

    调试

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

    调试

    授权信息

    当前API暂无授权信息透出。

    请求语法

    GET  HTTP/1.1

    请求参数

    名称

    类型

    必填

    描述

    示例值
    DBClusterClass

    string

    否

    集群规格。

    polar.app.g2.medium
    RegionId

    string

    是

    地域 ID。

    cn-beijing
    ZoneId

    string

    否

    可用区 ID。

    cn-beijing-l
    PayType

    string

    是

    实例的付费类型。取值：

    • Postpaid：后付费（按量付费）

    • Prepaid：预付费（包年包月）

    Prepaid
    AutoRenew

    boolean

    否

    是否自动续费，取值范围如下：

    • true：自动续费。

    • false：不自动续费。

    默认为 false。

    说明

    当参数 PayType 取值为 Prepaid 时，该参数才生效。

    false
    Period

    string

    否

    若付费类型为 Prepaid 时，该参数为必传参数。指定预付费集群为包年或包月类型。

    • Year：包年。即选择包年包月时，单位为年。

    • Month：包月。即选择包年包月时，单位为月。

    Month
    UsedTime

    string

    否

    若付费类型为 Prepaid 时，该参数为必传参数。

    • 当 Period 为 Month 时，UsedTime 取值为整数类型，取值范围为[1-9]。

    • 当 Period 为 Year 时，UsedTime 取值为整数类型，取值范围为[1-3]。

    3
    VPCId

    string

    是

    vpc-2zehr7ghqovft****** 虚拟私有云标识符

    vpc-*******************
    VSwitchId

    string

    是

    虚拟交换机 ID

    vsw-*********************
    SecurityGroupId

    string

    否

    安全组 ID

    sg-bp**************
    DBType

    string

    否

    数据库引擎类型，取值范围如下：

    • MySQL

    • PostgreSQL

    MySQL

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    RequestId

    string

    Id of the request

    F9F1CB1A-B1D5-4EF5-A53A-************
    GwClusterId

    string

    网关实例 ID。

    pg-2ze2079ueg20****
    OrderId

    string

    订单 ID。

    2035629******

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "F9F1CB1A-B1D5-4EF5-A53A-************",
  "GwClusterId": "pg-2ze2079ueg20****",
  "OrderId": "2035629******"
}

    错误码

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

    变更历史

    更多信息，参考变更详情。