NSX-T Data Center REST API

Add a AWS account to cloud serivce manager

Request:

Method:

POST

URI Path(s):

/api/v1/csm/aws/accounts

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

AwsAccount+

AwsAccount (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auth_method	AWS account authorization method This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.	string	Readonly Enum: CREDENTIALS
auth_users	Authrized Users List of authorized users.	array of CloudUserInfo	Readonly
cloud_type	Cloud Type	string	Required Enum: AWS, AZURE, GOOGLE, AZURE_GOV_US, AWS_GOV_US_EAST, AWS_GOV_US_WEST
credentials	AWS Credentials Credentials of AWS Account.	AwsCredentials	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
instance_stats	Instance statistics Stores statistics of the number of managed, unmanaged and error virtual machines.	InstanceStats	Readonly
last_inventory_sync_date	Last inventory sync date Time when last inventory syncing completed.	integer	Readonly
regions_config	List of regions configuration for the cloud account Configured list of regions to be used for the cloud account.	RegionListConfig
regions_count	AWS Regions Count Count of the AWS regions which have atleast one VPC created.	integer	Readonly
resource_type	Must be set to the value AwsAccount	string
status	Status of the account	AwsAccountStatus	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tenant_id	Tenant ID Tenant ID of the cloud account.	string	Readonly
vpc_stats	VPC statistics	VpcStats	Readonly

Example Request:

POST https://<nsx-csm>/api/v1/csm/aws/accounts { "display_name": "Account ABC", "cloud_type": "AWS", "cloud_tags_enabled" : true, "tenant_id": "123", "auth_method": "CREDENTIALS", "credentials": { "access_key": "A1B1C1", "secret_key": "a2b2c2", "gateway_role": "test-role" } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AwsAccount+

AwsAccount (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auth_method	AWS account authorization method This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.	string	Readonly Enum: CREDENTIALS
auth_users	Authrized Users List of authorized users.	array of CloudUserInfo	Readonly
cloud_type	Cloud Type	string	Required Enum: AWS, AZURE, GOOGLE, AZURE_GOV_US, AWS_GOV_US_EAST, AWS_GOV_US_WEST
credentials	AWS Credentials Credentials of AWS Account.	AwsCredentials	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
instance_stats	Instance statistics Stores statistics of the number of managed, unmanaged and error virtual machines.	InstanceStats	Readonly
last_inventory_sync_date	Last inventory sync date Time when last inventory syncing completed.	integer	Readonly
regions_config	List of regions configuration for the cloud account Configured list of regions to be used for the cloud account.	RegionListConfig
regions_count	AWS Regions Count Count of the AWS regions which have atleast one VPC created.	integer	Readonly
resource_type	Must be set to the value AwsAccount	string
status	Status of the account	AwsAccountStatus	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tenant_id	Tenant ID Tenant ID of the cloud account.	string	Readonly
vpc_stats	VPC statistics	VpcStats	Readonly

Example Response:

{ "id": "d02af61a-e212-486e-b6c8-10462ccfbad6", "display_name": "Account ABC", "tenant_id": "123", "cloud_type": "AWS", "cloud_tags_enabled" : true, "auth_method": "CREDENTIALS", "credentials": { "gateway_role": "test-role" } "instance_stats": { "managed": 0, "unmanaged": 0, "error": 0 }, "vpc_stats": { "managed": 0, "unmanged": 0 }, "regions_count": 0, "status": { "inventory_sync_status": "IN_PROGRESS", "inventory_sync_state": "SYNCING_AWS_REGIONS" } }

Required Permissions:

crud

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