All Products
Search
Document Center

:GenerateGatewayToken

Last Updated:Sep 19, 2024

Generates an activation token for a gateway that is deployed on your data center.

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 GenerateGatewayToken

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

GatewayId String Yes gw-000do8l6anyk2iklv***

The ID of the gateway. The gateway must be deployed on your data center.

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 8E9C6D43-4603-4F05-BE76-677A05EDFB7A

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Token String xxxxx

The activation token of the gateway.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GenerateGatewayToken
&GatewayId=gw-000do8l6anyk2iklv***
&<Common request parameters>

Sample success responses

XML format

<GenerateGatewayTokenResponse>
      <Message>successful</Message>
      <Token>xxxxx</Token>
      <RequestId>8E9C6D43-4603-4F05-BE76-677A05EDFB7A</RequestId>
      <Code>200</Code>
      <Success>true</Success>
</GenerateGatewayTokenResponse>

JSON format

{
    "Message":"successful",
    "Token":"xxxxx",
    "RequestId":"8E9C6D43-4603-4F05-BE76-677A05EDFB7A",
    "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 InvalidGatewayLocation The specified location of the gateway is invalid. The error message returned because the location of the gateway is invalid.

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