NSX-T Data Center REST API

Return status of the account like credentials validity, inventory synchronization status and inventory synchronization state

Request:

Method:

GET

URI Path(s):

/api/v1/csm/aws/accounts/<account-id>/status

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/aws/accounts/ d02af61a-e212-486e-b6c8-10462ccfbad6/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AwsAccountStatus+

AwsAccountStatus (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
credentials_status	Credentials Status Status of the cloud account credentials synced at the auto interval.	string	Readonly Enum: VALID, INVALID
error_message	Error encountered while syncing AWS inventory Error encountered while syncing AWS inventory such as read timeout.	string	Readonly
inventory_sync_status	Inventory Synchronization Status Status of inventory synchronization process.	string	Readonly Enum: SYNCED, IN_PROGRESS
inventory_sync_step	Inventory sync step Step of the inventory synchronization process	string	Readonly Enum: SYNCING_AWS_REGIONS, SYNCING_AWS_VPCS, SYNCING_AWS_AZS, SYNCING_VMS, SYNCING_NSX_DATA, SYNCING_AWS_GATEWAYS, SYNCING_MANAGED_INSTANCES, NOT_APPLICABLE

Example Response:

{ "inventory_sync_status": "IN_PROGRESS", "inventory_sync_state": "SYNCING_AWS_VPCS", "credentials_status": "VALID" }

Required Permissions:

read

Feature:

cloud_accounts

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable