NSX-T Data Center REST API

Return a list of all AWS accounts

Method:

GET

URI Path(s):

/api/v1/csm/aws/accounts

Request Headers:

n/a

Query Parameters:

AwsAccountsListRequestParameters+

Name	Description	Type	Notes
cloud_type	AWS Cloud Type	string	Enum: AWS, AWS_GOV_US_EAST, AWS_GOV_US_WEST
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
region_id	Identifier for region based on which accounts statistics will be aggregated. Using this request parameter will return only all_accounts_vpc_stats and all_accounts_instance_stats properties.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

GET https://<nsx-csm>/api/v1/csm/aws/accounts?region_id=us-west-2

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AwsAccountsListResult+

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
all_accounts_instance_stats	Instance statistics This field is DEPRECATED. To obtain statistics about instances, use the GET /csm/accounts/statistics API.	InstanceStats	Deprecated Readonly
all_accounts_vpc_stats	VPC statistics This field is DEPRECATED. To obtain statistics about VPCs, use the GET /csm/accounts/statistics API.	VpcStats	Deprecated Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	AWS accounts list result	array of AwsAccount	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

{ "all_accounts_vpc_stats": { "managed": 2, "unmanaged": 4 }, "all_accounts_instance_stats": { "managed": 12, "unmanaged": 22, "error": 1 } }