List Aws Regions | NSX-T Data Center REST API

List Aws Regions

Returns a list of Aws regions

Request

URI

GET

https://nsxmanager.your.domain/api/v1/csm/aws-regions

COPY

Query Parameters

string

account_id

Optional

Identifier for account based on which regions are to be filtered

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

region_id

Optional

Identifier for region based on which the list can be filtered or can be used to validate that hierarchy is correct

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns AwsRegionsListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineAwsRegionsListResult1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_create_time": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_last_modified_time": 0,
            "_create_user": "string",
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "vpc_stats": {
                "unmanaged": 0,
                "managed": 0
            },
            "has_managed_vpc": false,
            "instance_stats": {
                "unmanaged": 0,
                "vcpus": 0,
                "managed": 0,
                "error": 0
            },
            "availability_zones": [
                {
                    "display_name": "string",
                    "id": "string"
                }
            ],
            "gateway_stats": {
                "down": 0,
                "up": 0,
                "deploying": 0
            }
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure