CreateGateway

Updated at:
Copy as MD

Creates a gateway instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DBClusterClass

string

No

The cluster specification.

polar.app.g2.medium

RegionId

string

Yes

The region ID.

cn-beijing

ZoneId

string

No

The availability zone ID.

cn-beijing-l

PayType

string

Yes

The billing method. Valid values:

  • Postpaid: pay-as-you-go

  • Prepaid: subscription

Prepaid

AutoRenew

boolean

No

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.

  • false: disables auto-renewal.

Default value: false.

Note

This parameter applies only when PayType is set to Prepaid.

false

Period

string

No

The unit of the subscription duration. This parameter is required when PayType is set to Prepaid.

  • Year: The subscription duration is measured in years.

  • Month: The subscription duration is measured in months.

Month

UsedTime

string

No

The subscription duration. This parameter is required when PayType is set to Prepaid.

  • If Period is set to Month, the value must be an integer from 1 to 9.

  • If Period is set to Year, the value must be an integer from 1 to 3.

3

VPCId

string

Yes

The ID of the virtual private cloud (VPC).

vpc-*******************

VSwitchId

string

Yes

The vSwitch ID.

vsw-*********************

SecurityGroupId

string

No

The security group ID.

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

DBType

string

No

The database engine type. Valid values:

  • MySQL

  • PostgreSQL

MySQL

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The request ID.

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

GwClusterId

string

The gateway instance ID.

pg-2ze2079ueg20****

OrderId

string

The order ID.

2035629******

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.