Deploys a pay-as-you-go gateway.

When you call the operation, take note of the following information:

  • You can deploy only a pay-as-you-go gateway.
  • You can deploy only a gateway that is only in the Initialized state.
  • After you deploy the gateway, you can call the DescribeGateway operation to query the gateway status. If the gateway is in the Running state, the gateway is deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeployGateway

The operation that you want to perform. Set the value to DeployGateway.

GatewayClass String Yes Basic

The specification of the gateway. Valid values:

  • Basic
  • Standard
  • Enhanced
  • Advanced
GatewayId String Yes gw-0001xv7je3580031y***

The ID of the gateway.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code. If the request is successful, 200 is returned.

Message String successful

The description of the status code.

RequestId String 8FEAFE9D-66C2-46AB-833B-35269EC7524C

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

TaskId String t-0001xv7je35800307***

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeployGateway
&GatewayClass=Basic
&GatewayId=gw-0001xv7je3580031y***
&<Common request parameters>

Sample success responses

XML format 

<DeployGatewayResponse>
      <TaskId>t-0001xv7je35800307***</TaskId>
      <Message>successful</Message>
      <RequestId>8FEAFE9D-66C2-46AB-833B-35269EC7524C</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</DeployGatewayResponse>

JSON format 

{
    "TaskId":"t-0001xv7je35800307***",
    "Message":"successful",
    "RequestId":"8FEAFE9D-66C2-46AB-833B-35269EC7524C",
    "Code":"200",
    "Success":true
}

Error codes

HttpCode Error code Error message Description
400 EmptyGatewayId You must enter a valid ID for the gateway. The error message returned because the gateway ID is not specified.
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. The error message returned because the specified gateway does not exist. Check whether the parameters are valid.
400 BadRequest Invalid request. You must specify valid parameters in the request.　 The error message returned because the request is invalid. Check the request parameters and try again.
400 InvalidGatewayLocation The specified location of the gateway is invalid. The error message returned because the location of the gateway is invalid.
400 InvalidGatewayClass The specified specification of the gateway is invalid. The error message returned because the specified gateway specification is invalid.

For a list of error codes, visit the API Error Center.