All Products
Search
Document Center

Platform For AI:CreateGateway

Last Updated:Nov 22, 2024

Creates 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eas:CreateGatewaycreate
*All Resources
*
    none
none

Request syntax

POST /api/v2/gateways HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceNamestringNo

The resource group ID. To obtain a resource group ID, see the ResourceId field in the response of the ListResources operation.

eas-r-4gt8twzwllfo******
bodyobjectNo

The request body.

InstanceTypestringYes

The instance type used by the private gateway. Valid values:

  • 2c4g
  • 4c8g
  • 8c16g
  • 16c32g
ecs.c6.4xlarge
EnableIntranetbooleanNo

Specifies whether to enable private access. Default value: true.

Valid values:

  • true
  • false
true
EnableInternetbooleanNo

Specifies whether to enable Internet access. Default value: false.

Valid values:

  • true
  • false
false
NamestringNo

The alias of the private gateway.

mygateway1
ReplicasintegerNo

The number of nodes in the private gateway.

2
ChargeTypestringNo

The billing method. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go.
PostPaid
AutoRenewalbooleanNo

Specifies whether to enable auto-renewal. Valid values:

  • false (default)
  • true

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

40325405-579C-4D82****
GatewayIdstring

The private gateway ID.

gw-1uhcqmsc7x22******
ClusterIdstring

The region ID of the private gateway.

cn-hangzhou
Messagestring

The returned message.

Successfully create gateway.

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-10-11The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-07-31The internal configuration of the API is changed, but the call is not affectedView Change Details