CreateGateway - Platform For AI - Alibaba Cloud Documentation Center

Creates a gateway.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eas:CreateGateway

create

*Gateway

acs:eas:{#regionId}:{#accountId}:gateway/*

None

Request syntax

POST /api/v2/gateways HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ResourceName	string	No	The name of the resource group. For more information, see the ResourceName field that is returned by the ListResources operation when ResourceType is SelfManaged.	eas-r-4gt8twzwllfo******
body	object	No	The request body.
InstanceType	string	No	The instance type of the private gateway. Valid values: 2c4g 4c8g 8c16g 16c32g	ecs.c6.4xlarge
EnableIntranet	boolean	No	Specifies whether to enable internal network access. The default value is true. Valid values: true : Enable false : Disable	true
EnableInternet	boolean	No	Specifies whether to enable public network access. The default value is false. Valid values: true : Enable false : Disable	false
Name	string	No	The alias of the private gateway.	mygateway1
Replicas	integer	No	The number of nodes for the private gateway.	2
ChargeType	string	No	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
AutoRenewal	boolean	No	Specifies whether to enable auto-renewal. Valid values: false (default): Auto-renewal is disabled. true: Auto-renewal is enabled.
GatewayType	string	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	40325405-579C-4D82****
GatewayId	string	The ID of the private gateway.	gw-1uhcqmsc7x22******
ClusterId	string	The region where the private gateway resides.	cn-hangzhou
Message	string	The message returned for the request.	Successfully create gateway.

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "GatewayId": "gw-1uhcqmsc7x22******",
  "ClusterId": "cn-hangzhou",
  "Message": "Successfully create gateway."
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.