Cloud Service Manager >
AWS Gateways
Returns status information for primary gateway and secondary gateway for the vpc, if exists.
Request:
Method:
GET
URI Path(s):
/api/v1/csm/aws/gateways/<vpc-id>/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-csm>/api/v1/csm/aws/gateways/vpc-1234/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
AwsGatewayStatus
+
AwsGatewayStatus
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
gateway_cluster_id
NSX gateway cluster ID
Cluster ID of NSX gateway
string
gateway_instances_status
Gateway Instances Status
Array of gateway instances statuses
array of
AwsGatewayInstanceStatus
Readonly
Example Response:
{ "gateway_instances_status": [ { "gateway_status": "DEPLOYING", "gateway_instance_id": "i-176", "gateway_ha_index": 0, "deployment_status": 80, "deployment_state": "CONFIGURING_GATEWAY", "gateway_name": "nsxc-gw-vpc-c35dbaa4-preferred-active" } ] }
Required Permissions:
read
Feature:
gateway_deployment
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable