Checks whether a gateway name already exists in a gateway cluster.

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 ValidateGatewayName

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

Name String Yes alex***

The name of the gateway. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

StorageBundleId String Yes sb-0001b2otnkdxrigeq***

The ID of the gateway cluster.

Response parameters

Parameter Type Example Description
Code String 200

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

IsValid Boolean true

Indicates whether the name of the gateway already exists. Valid values:

  • true: The name of the gateway does not exist in the gateway cluster.
  • false: The name of the gateway already exists in the gateway cluster.
Message String successful

The description of the status code.

RequestId String CB300009-3850-4107-B291-59BDB4EDA183

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ValidateGatewayName
&Name=alex***
&StorageBundleId=sb-0001b2otnkdxrigeq***
&<Common request parameters>

Sample success responses

XML format 

<ValidateGatewayNameResponse>
  <IsValid>true</IsValid>
  <Message>successful</Message>
  <RequestId>CB300009-3850-4107-B291-59BDB4EDA183</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</ValidateGatewayNameResponse>

JSON format 

{
    "IsValid":"true",
    "Message":"successful",
    "RequestId":"CB300009-3850-4107-B291-59BDB4EDA183",
    "Code":"200",
    "Success":true
}

Error codes

HttpCode Error code Error message Description
400 EmptyStorageBundleId You must enter a valid ID for the gateway cluster. The error message returned because the gateway cluster ID is not specified.
400 EmptyGatewayName You must enter a valid name for the gateway. The error message returned because the gateway name is not specified.
400 InvalidGatewayName The specified name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. The error message returned because the name of the gateway is invalid. The name must be 1 to 60 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). In addition, it must start with a letter.
404 StorageBundleNotExist The name you specified for the gateway cluster does not exist. You must specify a valid parameter. The error message returned because the specified gateway cluster does not exist. Check whether the parameters are valid.

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