AddGateway - Microservices Engine - Alibaba Cloud Documentation Center

Adds a 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:
- The required resource types are displayed in bold characters.
- 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
mse:AddGateway	create	Gateway `acs:mse:{#regionId}:{#accountId}:instance/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The ID of the region.	test-ceshi
Region	string	Yes	The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values: slb.s1.small slb.s2.small slb.s2.medium slb.s3.small slb.s3.medium slb.s3.large	cn-hangzhou
SlbSpec	string	No	The specifications of the internal-facing Server Load Balancer (SLB) instance. Valid values: slb.s1.small slb.s2.small slb.s2.medium slb.s3.small slb.s3.medium slb.s3.large	slb.s2.small
Vpc	string	Yes	The ID of the primary vSwitch.	vpc-bp15mncnrtm83uauxd1xb
VSwitchId	string	No	The ID of the primary vSwitch.	vsw-bp1q8th57frl5khj2li43
Spec	string	No	The node specifications you specify when you purchase an ordinary instance. Valid values: MSE_GTW_16_32_200_c(16C32G) MSE_GTW_2_4_200_c(2C4G) MSE_GTW_4_8_200_c(4C8G) MSE_GTW_8_16_200_c(8C16G)	MSE_GTW_2_4_200_c
Replica	integer	No	The number of nodes you specify when you purchase an ordinary instance.	2
InternetSlbSpec	string	No	The specifications of the Internet-facing Server Load Balancer (SLB) instance. Valid values: slb.s1.small slb.s2.smal slb.s2.medium slb.s3.small slb.s3.medium slb.s3.large	slb.s2.small
VSwitchId2	string	No	Specifies whether to use an advanced security group.	vsw-wz9bu6o5vsvitt5mrxo6s
EnterpriseSecurityGroup	boolean	No	Specifies whether to enable hardware acceleration.	false
EnableHardwareAcceleration	boolean	No	Specifies whether to activate Tracing Analysis.	false
EnableXtrace	boolean	No	The sampling rate of Tracing Analysis. Valid values: [1,100].	false
XtraceRatio	string	No	Specifies whether to activate Log Service.	10
EnableSls	boolean	No	The tag of the gateway.	false
Tag	array<object>	No	The tag object.
	object	No	The key of the tag.
Key	string	No	The value of the tag.	key
Value	string	No	The ID of the resource group.	value
ResourceGroupId	string	No	The language of the response. Valid values: zh: Chinese en: English	rg-acfm34x43l*****
RequestPars	string	No	The extended field.	{}
ZoneInfo	array<object>	Yes	The details of the zone.
	object	Yes
ZoneId	string	No	The zone ID.	cn-shenzhen-e
VSwitchId	string	No	The vSwitch ID.	vsw-bp*****
ChargeType	string	No	The billing method you specify when you purchase an ordinary instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go	POSTPAY
MserVersion	string	No	The MSE instance type. Valid values: mse_pro: ordinary instance mse_serverless: serverless instance	mse_pro
NlbNetworkType	string	No	The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance. pubnet: Internet privatenet: private network privatepubnet: Internet and private network	pubnet
ClbNetworkType	string	No	The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs. pubnet: Internet privatenet: private network privatepubnet: Internet and private network	pubnet
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The ID of the request.
RequestId	string	The HTTP status code returned.	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
HttpStatusCode	integer	The message returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.	200
Message	string	The request is successfully processed.	The return value.
Code	integer	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	200
Success	boolean	The returned data.	true
Data	object	The unique ID of the gateway.
GatewayUniqueId	string	code	gw-5017305290e14cebbrvec4a5****

Examples

Sample success responses

JSONformat

{
  "RequestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "HttpStatusCode": 200,
  "Message": "The return value.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "GatewayUniqueId": "gw-5017305290e14cebbrvec4a5****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2024-06-21	The request parameters of the API has changed	View Change Details
2023-10-11	The request parameters of the API has changed	View Change Details
2023-05-09	The request parameters of the API has changed	View Change Details
2023-05-09	The request parameters of the API has changed	View Change Details
2023-04-17	The request parameters of the API has changed	View Change Details
2021-12-29	The request parameters of the API has changed	View Change Details
2021-12-29	The request parameters of the API has changed	View Change Details