CreateGateway - API Gateway - Alibaba Cloud Documentation Center

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
apig:CreateGateway	create	Gateway `acs:apig:{#regionId}:{#accountId}:gateway/`	none	none

Request syntax

POST /v1/gateways HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
name	string	No	The name of the gateway instance.	test-ceshi
chargeType	string	No	The billing method. Valid values: POSTPAY PREPAY	POSTPAY
gatewayType	string	No	The type of the gateway. Valid values: AI API	API
spec	string	No	The specifications of the node.	apigw.dev.x2
vpcId	string	No	The ID of the VPC.	vpc-zm0x16tomfiat1mk9f6rs
networkAccessConfig	object	No	The network access configuration.
type	string	No	The network access type. Valid values: InternetAndIntranet Intranet Internet	Internet
zoneConfig	object	No	The zone settings.
selectOption	string	No	The option for selecting the zone. Valid values: Auto Manual	Manual
vSwitchId	string	No	The ID of the vSwitch.	vsw-xxx
zones	array<object>	No	The supported zones.
	object	No	The zone information.
zoneId	string	No	The zone ID.	cn-wulanchabu-a
vSwitchId	string	No	The ID of the vSwitch.	vsw-xx
logConfig	object	No	The logging configurations.
sls	object	No	The Simple Log Service configurations.
enable	boolean	No	Indicates if enabled.	false
resourceGroupId	string	No	The ID of the resource group.	rg-ahr5uil8raz0rq3b
tag	array<object>	No	The tags.
	object	No	The tag value.
key	string	No	The tag key.	key
value	string	No	The tag value.	value
gatewayEdition	string	No	The gateway edition.	-

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request.	9CDE3E69-69C2-5402-83AD-ACA80B1AF35B
code	string	The status code.	Ok
message	string	The status message.	success
data	object	The response payload.
gatewayId	string	The instance ID.	gw-cq2vundlhtg***

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.