Queries the instance types to which a gateway can be upgraded.
Try it now
Test
RAM authorization
Action | Access level | Resource type | Condition key | Dependent action |
hcs-sgw:DescribeGatewayModificationClasses | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
GatewayId | string | Yes | The ID of the gateway. | gw-0001xv7je3580031*** |
Response elements
Element | Type | Description | Example |
object | |||
Message | string | The message returned for the request. | successful |
RequestId | string | The ID of the request. | FA8951CC-A534-425D-8705-F9A5CF9FD555 |
Code | string | The status code. A status code of 200 indicates that the request was successful. | 200 |
Success | boolean | Indicates whether the request was successful. | true |
| TargetGatewayClasses | object | ||
| TargetGatewayClass | array<object> | The instance types to which you can upgrade the gateway. | |
object | |||
GatewayClass | string | The gateway instance type to which you can upgrade. Valid values:
| Enhanced |
IsAvailable | boolean | Indicates whether the instance type is available. | true |
Examples
Success response
JSON format
{
"Message": "successful",
"RequestId": "FA8951CC-A534-425D-8705-F9A5CF9FD555",
"Code": "200",
"Success": true,
"TargetGatewayClasses": {
"TargetGatewayClass": [
{
"GatewayClass": "Enhanced",
"IsAvailable": true
}
]
}
}Error codes
HTTP status code | Error code | Error message | Description |
400 | EmptyGatewayId | You must enter a valid ID for the gateway. | You must enter a valid ID for the gateway. |
400 | LocationCloudRequired | You must specify a cloud gateway. Try again later. | You must specify a cloud gateway. Try again later. |
400 | GatewayNotExist | The specified gateway does not exist. You must specify a valid parameter. | The specified gateway does not exist. You must specify a valid parameter. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.