All Products
Search
Document Center

API Gateway:CreateGateway

Last Updated:Mar 26, 2026

Creates a cloud-native gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:CreateGatewaycreate
*Gateway
acs:apig:{#regionId}:{#accountId}:gateway/*
    none
none

Request syntax

POST /v1/gateways HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The zone ID.

namestringNo

The ID of the vSwitch.

test-ceshi
chargeTypestringNo

The logging configurations.

Enumeration Value:
  • POSTPAY: The Simple Log Service configurations. .
  • PREPAY: Indicates if enabled. .
POSTPAY
gatewayTypestringNo

The ID of the resource group.

Enumeration Value:
  • AI: The tags. .
  • API: The tag value. .
API
specstringNo

The tag key.

apigw.dev.x2
vpcIdstringNo

The tag value.

vpc-zm0x16tomfiat1mk9f6rs
networkAccessConfigobjectNo

The gateway edition.

typestringNo
Enumeration Value:
  • InternetAndIntranet: Schema of Response .
  • Intranet: The ID of the request..
  • Internet: The status code. .
Internet
zoneConfigobjectNo

The status message.

selectOptionstringNo

The response payload.

Enumeration Value:
  • Auto: The instance ID. .
  • Manual: .
Manual

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

Id of the request

9CDE3E69-69C2-5402-83AD-ACA80B1AF35B

Examples

Sample success responses

JSONformat

{
  "requestId": "9CDE3E69-69C2-5402-83AD-ACA80B1AF35B",
  "code": "Ok",
  "message": "success",
  "data": {
    "gatewayId": "gw-cq2vundlhtg***"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history